cAudio  2.3.0
3d Audio Engine
Public Member Functions | List of all members
cAudio::IPluginManager Class Referenceabstract

Interface for the plugin capabilities of cAudio. More...

#include <IPluginManager.h>

Public Member Functions

virtual bool installPlugin (IAudioPlugin *plugin, const char *name=NULL)=0
 Installs a plugin using a statically linked plugin implementation. More...
 
virtual bool installPlugin (const char *filename, const char *name=NULL)=0
 Installs a plugin from a dynamically linked library on your hard drive. More...
 
virtual bool checkForPlugin (const char *name)=0
 Checks for the existance of a plugin with the supplied name. More...
 
virtual IAudioPlugingetPlugin (const char *name)=0
 Returns a plugin interface for a plugin with the supplied name. More...
 
virtual unsigned int getPluginCount ()=0
 Returns the total number of installed plugins.
 
virtual void uninstallPlugin (IAudioPlugin *plugin)=0
 Removes a plugin installed via statically linked reference. More...
 
virtual void uninstallPlugin (const char *name)=0
 Removes a plugin with the specified name. More...
 

Detailed Description

Interface for the plugin capabilities of cAudio.

Definition at line 14 of file IPluginManager.h.

Member Function Documentation

◆ checkForPlugin()

virtual bool cAudio::IPluginManager::checkForPlugin ( const char *  name)
pure virtual

Checks for the existance of a plugin with the supplied name.

Parameters
nameName of the plugin to check for.

◆ getPlugin()

virtual IAudioPlugin* cAudio::IPluginManager::getPlugin ( const char *  name)
pure virtual

Returns a plugin interface for a plugin with the supplied name.

Parameters
nameName of the plugin to check return.
Returns
A pointer to the plugin interface or NULL if it could not be found.

◆ installPlugin() [1/2]

virtual bool cAudio::IPluginManager::installPlugin ( IAudioPlugin plugin,
const char *  name = NULL 
)
pure virtual

Installs a plugin using a statically linked plugin implementation.

Parameters
pluginPointer to a plugin implementation to install.
nameOptional name for the plugin. Pass NULL to have the plugin use its default name.
Returns
True if plugin was installed successfully.

◆ installPlugin() [2/2]

virtual bool cAudio::IPluginManager::installPlugin ( const char *  filename,
const char *  name = NULL 
)
pure virtual

Installs a plugin from a dynamically linked library on your hard drive.

Parameters
filenamePath to the dll/so/dynlib on your hard drive.
nameOptional name for the plugin. Pass NULL to have the plugin use its default name.
Returns
True if plugin was installed successfully.

◆ uninstallPlugin() [1/2]

virtual void cAudio::IPluginManager::uninstallPlugin ( IAudioPlugin plugin)
pure virtual

Removes a plugin installed via statically linked reference.

Parameters
pluginPointer to the plugin implementation to uninstall.

◆ uninstallPlugin() [2/2]

virtual void cAudio::IPluginManager::uninstallPlugin ( const char *  name)
pure virtual

Removes a plugin with the specified name.

Parameters
nameName of the plugin to uninstall.

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