cAudio
2.3.0
3d Audio Engine
|
Interface for all plugins in cAudio. More...
#include <IAudioPlugin.h>
Public Member Functions | |
virtual bool | installPlugin (ILogger *logger)=0 |
Called to initialize the plugin. Use this for any initial setup that needs to be done. More... | |
virtual const char * | getPluginName ()=0 |
Called to retrieve a name to register this plugin under if the user didn't specify one (or the plugin was auto-loaded). More... | |
virtual void | uninstallPlugin ()=0 |
Called to shutdown the plugin and do any final cleanup. This is the last function call cAudio will give you before your plugin is completely removed. | |
virtual void | onCreateAudioManager (IAudioManager *manager) |
Called on creation of an Audio Playback Manager. More... | |
virtual void | onCreateAudioCapture (IAudioCapture *capture) |
Called on creation of an Audio Capture Manager. More... | |
virtual void | onDestroyAudioManager (IAudioManager *manager) |
Called on destruction of an Audio Playback Manager. More... | |
virtual void | onDestoryAudioCapture (IAudioCapture *capture) |
Called on destruction of an Audio Capture Manager. More... | |
![]() | |
virtual void | grab () |
Increments the reference count by one. | |
virtual bool | drop () |
Decrements the reference count by one. If it hits zero, this object is deleted. | |
int | getReferenceCount () const |
Returns the current reference count of this object. | |
Additional Inherited Members | |
![]() | |
int | RefCount |
Interface for all plugins in cAudio.
Definition at line 15 of file IAudioPlugin.h.
|
pure virtual |
Called to retrieve a name to register this plugin under if the user didn't specify one (or the plugin was auto-loaded).
|
pure virtual |
Called to initialize the plugin. Use this for any initial setup that needs to be done.
logger | Pointer to the logger singleton. |
|
inlinevirtual |
Called on creation of an Audio Capture Manager.
Use this to register any event handlers that you'd like to add to the engine.
capture | Pointer to the newly created capture interface. |
Definition at line 43 of file IAudioPlugin.h.
|
inlinevirtual |
Called on creation of an Audio Playback Manager.
Use this to register any decoders or event handlers that you'd like to add to the engine.
manager | Pointer to the newly created manager. |
Definition at line 38 of file IAudioPlugin.h.
|
inlinevirtual |
Called on destruction of an Audio Capture Manager.
Use this to remove anything you added to a capture manger earlier.
capture | Pointer to the soon to be destroyed capture interface. |
Definition at line 53 of file IAudioPlugin.h.
|
inlinevirtual |
Called on destruction of an Audio Playback Manager.
Use this to remove anything you added to the playback manger earlier.
manager | Pointer to the soon to be destroyed playback interface. |
Definition at line 48 of file IAudioPlugin.h.