om::sound::plugins Namespace Reference

A namespace containing classes that manage different types of audio processing plugins (filters, AU, VST, etc). More...

Classes
class	FilterManager
	An interface for a class that manages a generic interface to a collection of SoundFilter plugins. More...
class	PluginDelegate
	A class that handles events related to a particular sound plugin, such as instance creation. More...
class	PluginID
	A class that represents that unique identifier for an external sound filter plugin. More...
class	PluginManager
	A class that manages generic access to of any kind of audio plugin. More...
class	PluginType
	A class that represents of a particular type of plugin, such as AU, VST, or filter. More...
class	PluginTypeManager
	An interface for a class that manages a collection of plugins of a particular type. More...
class	SoundPlugin
	A class that opaquely wraps an arbitrary sound effect that has a SoundFilter interface. More...

Typedefs
typedef Function< SoundFilter *(const PluginID &pluginID, void *userData)>	PluginFactory
	The function prototype to use as a factory method for creating new plugin objects. More...
typedef Function< SoundFilterView *(const PluginID &pluginID, SoundFilter *filter, void *userData)>	PluginViewFactory
	The function prototype to use as a factory method for creating new plugin view objects. More...

Detailed Description

A namespace containing classes that manage different types of audio processing plugins (filters, AU, VST, etc).

Typedef Documentation

typedef Function<SoundFilter* ( const PluginID& pluginID, void* userData )> om::sound::plugins::PluginFactory

The function prototype to use as a factory method for creating new plugin objects.

The factory method should create a SoundFilter object that encapsulates a plugin with the given plugin type, manufacturer name, and plugin name. The function is given an opaque pointer to user-defined data which was passed into the plugin registration function.

If the plugin is unable to be created, the function should return a NULL pointer.

typedef Function<SoundFilterView* ( const PluginID& pluginID, SoundFilter* filter, void* userData )> om::sound::plugins::PluginViewFactory

The function prototype to use as a factory method for creating new plugin view objects.

The factory method should create a SoundFilterView object that encapsulates a plugin view with the given plugin type, manufacturer name, and plugin name. The returned filter view should wrap the given filter. The function is given an opaque pointer to user-defined data which was passed into the plugin registration function.

If the plugin is unable to be created, the function should return a NULL pointer.