 |
Om
1.0.0
A universal framework for multimedia simulation
|
An interface for a class that manages a generic interface to a collection of SoundFilter plugins. More...
#include <omSoundFilterManager.h>
Public Member Functions | |
| FilterManager () | |
| Create a new filter plugin manager which by default has access to all standard SoundFilter subclasses. More... | |
| virtual const PluginType & | getType () const |
| Return the type of plugin that this manager handles, PluginType::FILTER. More... | |
| virtual void | rescan () |
| Rescan the system for available plugins of this manager's type. More... | |
 Public Member Functions inherited from om::sound::plugins::PluginTypeManager | |
| PluginTypeManager () | |
| Create a new plugin type manager, initially empty without any plugins. More... | |
| PluginTypeManager (const PluginTypeManager &other) | |
| Create a new plugin type manager, copying all plugin information from the another manager. More... | |
| virtual | ~PluginTypeManager () |
| Destroy this plugin type manager and release all of its internal resources. More... | |
| PluginTypeManager & | operator= (const PluginTypeManager &other) |
| Copy the entire state of one plugin type manager to this one, replacing all previous plugins. More... | |
| Size | getPluginCount () const |
| Return the total number of plugins that are available to this plugin type manager. More... | |
| const PluginID & | getPluginID (Index pluginIndex) const |
| Return the plugin ID for the plugin at the specified index. More... | |
| const UTF8String & | getPluginName (Index pluginIndex) const |
| Return a string representing the name for the plugin at the specified index. More... | |
| Bool | getPluginIndex (const PluginID &pluginID, Index &pluginIndex) const |
| Get the index of the plugin in this manager with the specified ID. More... | |
| Bool | hasPlugin (const PluginID &pluginID) const |
| Return whether or not there exists a plugin in this plugin manager with the specified manufacturer and name. More... | |
| Bool | addPlugin (const PluginID &pluginID, const PluginDelegate &delegate, void *userData=((void *) 0)) |
| Add a new kind of plugin to this plugin manager. More... | |
| Bool | removePlugin (Index pluginIndex) |
| Remove the plugin at the specified index from this plugin manager. More... | |
| void | clearPlugins () |
| Remove all registered plugins from this plugin type manager. More... | |
| SoundFilter * | createPlugin (Index pluginIndex) const |
| Create a new plugin of this manager's type for the specified plugin kind index. More... | |
| SoundFilter * | createPlugin (const PluginID &pluginID) const |
| Create a new plugin of this manager's type with the given manufacturer and plugin names. More... | |
| SoundFilterView * | createPluginView (Index pluginIndex, SoundFilter *filter) const |
| Create a new plugin view of this manager's type for the specified plugin kind index. More... | |
| SoundFilterView * | createPluginView (const PluginID &pluginID, SoundFilter *filter) const |
| Create a new plugin view of this manager's type with the given manufacturer and plugin names. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from om::sound::plugins::PluginTypeManager | |
| Bool | addPluginInternal (const PluginID &id, const PluginDelegate &delegate, void *userData=((void *) 0)) |
| Add a new kind of plugin to this plugin manager. More... | |
| Bool | removePluginInternal (Index pluginIndex) |
| Remove the plugin at the specified index from this plugin manager. More... | |
| void | clearPluginsInternal () |
| Remove all registered plugins from this plugin type manager. More... | |
An interface for a class that manages a generic interface to a collection of SoundFilter plugins.
| om::sound::plugins::FilterManager::FilterManager | ( | ) |
Create a new filter plugin manager which by default has access to all standard SoundFilter subclasses.
|
virtual |
Return the type of plugin that this manager handles, PluginType::FILTER.
Implements om::sound::plugins::PluginTypeManager.
|
virtual |
Rescan the system for available plugins of this manager's type.
This method has the effect of updating the internal list of plugins with any newly detected plugins while retaining all previously existing plugins, as long as their presence on the system is retained. If a plugin no longer exists, it is removed from the internal list of plugins.
This method is called the first time that the user accesses the plugins for this plugin type manager, and can be called afterward by the user if necessary. Subclasses should implement this method to function properly for those situations.
This method invalidates all plugin indices for this manager.
Implements om::sound::plugins::PluginTypeManager.
1.8.11
