Interface for all plugins in cAudio.
More...
#include <IAudioPlugin.h>
Interface for all plugins in cAudio.
Definition at line 15 of file IAudioPlugin.h.
virtual const char* cAudio::IAudioPlugin::getPluginName |
( |
| ) |
|
|
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).
- Returns
- Name of the plugin.
virtual bool cAudio::IAudioPlugin::installPlugin |
( |
ILogger * |
logger | ) |
|
|
pure virtual |
Called to initialize the plugin. Use this for any initial setup that needs to be done.
- Parameters
-
logger,: | Pointer to the logger singleton. |
- Returns
- True if plugin initialization was successful, false if there was an error.
virtual void cAudio::IAudioPlugin::onCreateAudioCapture |
( |
IAudioCapture * |
capture | ) |
|
|
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.
- Parameters
-
capture,: | Pointer to the newly created capture interface. |
Definition at line 43 of file IAudioPlugin.h.
virtual void cAudio::IAudioPlugin::onCreateAudioManager |
( |
IAudioManager * |
manager | ) |
|
|
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.
- Parameters
-
manager,: | Pointer to the newly created manager. |
Definition at line 38 of file IAudioPlugin.h.
virtual void cAudio::IAudioPlugin::onDestoryAudioCapture |
( |
IAudioCapture * |
capture | ) |
|
|
inlinevirtual |
Called on destruction of an Audio Capture Manager.
Use this to remove anything you added to a capture manger earlier.
- Parameters
-
capture,: | Pointer to the soon to be destroyed capture interface. |
Definition at line 53 of file IAudioPlugin.h.
virtual void cAudio::IAudioPlugin::onDestroyAudioManager |
( |
IAudioManager * |
manager | ) |
|
|
inlinevirtual |
Called on destruction of an Audio Playback Manager.
Use this to remove anything you added to the playback manger earlier.
- Parameters
-
manager,: | Pointer to the soon to be destroyed playback interface. |
Definition at line 48 of file IAudioPlugin.h.
The documentation for this class was generated from the following file: