cAudio::IPluginManager Class Reference

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

#include <IPluginManager.h>

Inheritance diagram for cAudio::IPluginManager:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool installPlugin (IAudioPlugin *plugin, const char *name=NULL)=0
 Installs a plugin using a statically linked plugin implementation.
virtual bool installPlugin (const char *filename, const char *name=NULL)=0
 Installs a plugin from a dynamically linked library on your hard drive.
virtual bool checkForPlugin (const char *name)=0
 Checks for the existance of a plugin with the supplied name.
virtual IAudioPlugingetPlugin (const char *name)=0
 Returns a plugin interface for a plugin with the supplied name.
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.
virtual void uninstallPlugin (const char *name)=0
 Removes a plugin with the specified name.

Detailed Description

Interface for the plugin capabilities of cAudio.

Definition at line 9 of file IPluginManager.h.


Member Function Documentation

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

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

Parameters:
name,: Name of the plugin to check for.

Implemented in cAudio::cPluginManager.

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

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

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

Implemented in cAudio::cPluginManager.

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:
filename,: Path to the dll/so/dynlib on your hard drive.
name,: Optional name for the plugin. Pass NULL to have the plugin use its default name.
Returns:
True if plugin was installed successfully.

Implemented in cAudio::cPluginManager.

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

Installs a plugin using a statically linked plugin implementation.

Parameters:
plugin,: Pointer to a plugin implementation to install.
name,: Optional name for the plugin. Pass NULL to have the plugin use its default name.
Returns:
True if plugin was installed successfully.

Implemented in cAudio::cPluginManager.

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

Removes a plugin with the specified name.

Parameters:
name,: Name of the plugin to uninstall.

Implemented in cAudio::cPluginManager.

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

Removes a plugin installed via statically linked reference.

Parameters:
plugin,: Pointer to the plugin implementation to uninstall.

Implemented in cAudio::cPluginManager.


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations

Generated on Sat Feb 20 22:55:25 2010 for cAudio by  doxygen 1.6.2