Vamp::PluginAdapterBase Class Reference

#include <vamp-sdk/PluginAdapter.h>

Inheritance diagram for Vamp::PluginAdapterBase:

Inheritance graph
[legend]

List of all members.


Detailed Description

PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its C++ Vamp::Plugin objects available through the Vamp C API.

Almost all Vamp plugin libraries will want to make use of this. To do so, all they need to do is declare a PluginAdapter<T> for each plugin class T in their library. It's very simple, and you need to know absolutely nothing about how it works in order to use it. Just cut and paste from an existing plugin's discovery function.

See also:
vampGetPluginDescriptor

Definition at line 63 of file PluginAdapter.h.


Public Member Functions

virtual ~PluginAdapterBase ()
const VampPluginDescriptorgetDescriptor ()
 Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter.

Protected Member Functions

 PluginAdapterBase ()
virtual PlugincreatePlugin (float inputSampleRate)=0

Protected Attributes

Implm_impl

Classes

class  Impl

Constructor & Destructor Documentation

Vamp::PluginAdapterBase::~PluginAdapterBase (  )  [virtual]

Definition at line 132 of file PluginAdapter.cpp.

References m_impl.

Vamp::PluginAdapterBase::PluginAdapterBase (  )  [protected]

Definition at line 127 of file PluginAdapter.cpp.

References m_impl.


Member Function Documentation

const VampPluginDescriptor * Vamp::PluginAdapterBase::getDescriptor (  ) 

Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter.

Definition at line 138 of file PluginAdapter.cpp.

References Vamp::PluginAdapterBase::Impl::getDescriptor(), and m_impl.

Referenced by vampGetPluginDescriptor().

virtual Plugin* Vamp::PluginAdapterBase::createPlugin ( float  inputSampleRate  )  [protected, pure virtual]


Member Data Documentation

Definition at line 79 of file PluginAdapter.h.

Referenced by getDescriptor(), PluginAdapterBase(), and ~PluginAdapterBase().


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

Generated on Wed Jun 18 17:44:07 2008 for VampPluginSDK by  doxygen 1.5.6