Chris@1: Chris@1: Chris@1: Chris@1: Chris@3: Chris@1: VampPluginSDK: Vamp::PluginAdapterBase Class Reference Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:
VampPluginSDK Chris@3:  2.4 Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1: Chris@3: Chris@1: Chris@1: Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Public Member Functions | Chris@1: Protected Member Functions | Chris@1: Protected Attributes
Chris@1:
Chris@1:
Vamp::PluginAdapterBase Class Reference
Chris@3:
Chris@1:
Chris@3: Chris@1:

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. Chris@1: More...

Chris@1: Chris@1:

#include <vamp-sdk/PluginAdapter.h>

Chris@1:
Chris@1: Inheritance diagram for Vamp::PluginAdapterBase:
Chris@1:
Chris@1:
Inheritance graph
Chris@1: Chris@1: Chris@1:
[legend]
Chris@1: Chris@1:

List of all members.

Chris@1: Chris@1: Chris@3: Chris@3: Chris@3: Chris@1: Chris@3: Chris@3: Chris@1: Chris@3: Chris@1:

Chris@1: Public Member Functions

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

Chris@1: Protected Member Functions

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

Chris@1: Protected Attributes

Impl * m_impl
Chris@1:

Detailed Description

Chris@1:

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.

Chris@1:

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.

Chris@3:
See also:
vampGetPluginDescriptor
Chris@1: Chris@1:

Definition at line 65 of file PluginAdapter.h.

Chris@1:

Constructor & Destructor Documentation

Chris@3: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@3: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
virtual Vamp::PluginAdapterBase::~PluginAdapterBase () [virtual]
Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@3: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@3: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Vamp::PluginAdapterBase::PluginAdapterBase () [protected]
Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:

Member Function Documentation

Chris@3: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@3: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
const VampPluginDescriptor* Vamp::PluginAdapterBase::getDescriptor ()
Chris@1:
Chris@1:
Chris@1: Chris@1:

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

Chris@1: Chris@1:

Referenced by vampGetPluginDescriptor().

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

Implemented in Vamp::PluginAdapter< P >.

Chris@1: Chris@1:
Chris@1:
Chris@1:

Member Data Documentation

Chris@3: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Impl* Vamp::PluginAdapterBase::m_impl [protected]
Chris@1:
Chris@1:
Chris@1: Chris@1:

Definition at line 81 of file PluginAdapter.h.

Chris@1: Chris@1:
Chris@1:
Chris@1:
The documentation for this class was generated from the following file: Chris@3:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: