cAudio::IAudioPlugin Class Reference

Interface for all plugins in cAudio. More...

#include <IAudioPlugin.h>

Inheritance diagram for cAudio::IAudioPlugin:

[legend]

Collaboration diagram for cAudio::IAudioPlugin:

[legend]

List of all members.

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.
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).
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.
virtual void	onCreateAudioCapture (IAudioCapture *capture)
	Called on creation of an Audio Capture Manager.
virtual void	onDestroyAudioManager (IAudioManager *manager)
	Called on destruction of an Audio Playback Manager.
virtual void	onDestoryAudioCapture (IAudioCapture *capture)
	Called on destruction of an Audio Capture Manager.

---

Detailed Description

Interface for all plugins in cAudio.

Definition at line 12 of file IAudioPlugin.h.

---

Member Function Documentation

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

)

[inline, virtual]

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 40 of file IAudioPlugin.h.

virtual void cAudio::IAudioPlugin::onCreateAudioManager

(

IAudioManager *

manager

)

[inline, virtual]

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 35 of file IAudioPlugin.h.

virtual void cAudio::IAudioPlugin::onDestoryAudioCapture

(

IAudioCapture *

capture

)

[inline, virtual]

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 50 of file IAudioPlugin.h.

virtual void cAudio::IAudioPlugin::onDestroyAudioManager

(

IAudioManager *

manager

)

[inline, virtual]

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 45 of file IAudioPlugin.h.

---

The documentation for this class was generated from the following file:

• C:/Users/Wildicv/Desktop/cAudio/cAudio/Trunk/include/IAudioPlugin.h