cannam@0: cannam@0: cannam@0: VampPluginSDK: Vamp::PluginAdapterBase Class Reference cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
cannam@0:

Vamp::PluginAdapterBase Class Reference

#include <vamp-sdk/PluginAdapter.h> cannam@0:

cannam@0:

cannam@0: Inheritance diagram for Vamp::PluginAdapterBase:
cannam@0:
cannam@0:

Inheritance graph
cannam@0: cannam@0: cannam@0:
[legend]
cannam@0: cannam@0:

cannam@0: List of all members.

Detailed Description

cannam@0: 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. cannam@0:

cannam@0: 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
cannam@0: cannam@0:

Definition at line 63 of file PluginAdapter.h.

cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:

Public Member Functions

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

Protected Member Functions

 PluginAdapterBase ()
virtual Plugin * createPlugin (float inputSampleRate)=0

Protected Attributes

Impl * m_impl

Classes

class  Impl
cannam@0:

Constructor & Destructor Documentation

cannam@0: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
Vamp::PluginAdapterBase::~PluginAdapterBase (  )  [virtual]
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: cannam@0:

Definition at line 132 of file PluginAdapter.cpp.

cannam@0: cannam@0:

References m_impl.

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
Vamp::PluginAdapterBase::PluginAdapterBase (  )  [protected]
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: cannam@0:

Definition at line 127 of file PluginAdapter.cpp.

cannam@0: cannam@0:

References m_impl.

cannam@0: cannam@0:
cannam@0:

cannam@0:

Member Function Documentation

cannam@0: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
const VampPluginDescriptor * Vamp::PluginAdapterBase::getDescriptor (  ) 
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. cannam@0:

cannam@0: cannam@0:

Definition at line 138 of file PluginAdapter.cpp.

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Referenced by vampGetPluginDescriptor().

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Implemented in Vamp::PluginAdapter< P >.

cannam@0: cannam@0:

Referenced by Vamp::PluginAdapterBase::Impl::getDescriptor(), and Vamp::PluginAdapterBase::Impl::vampInstantiate().

cannam@0: cannam@0:
cannam@0:

cannam@0:

Member Data Documentation

cannam@0: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
Impl* Vamp::PluginAdapterBase::m_impl [protected]
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: cannam@0:

Definition at line 79 of file PluginAdapter.h.

cannam@0: cannam@0:

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

cannam@0: cannam@0:
cannam@0:

cannam@0:

The documentation for this class was generated from the following files: cannam@0:
cannam@0:
Generated on Wed Jul 9 11:36:09 2008 for VampPluginSDK by  cannam@0: cannam@0: doxygen 1.5.5
cannam@0: cannam@0: