Logo Search packages:      
Sourcecode: vamp-plugin-sdk version File versions  Download package

Vamp::PluginBase Class Reference

#include <PluginBase.h>

Inheritance diagram for Vamp::PluginBase:

Vamp::Plugin AmplitudeFollower PercussionOnsetDetector SpectralCentroid Vamp::HostExt::PluginWrapper Vamp::PluginHostAdapter ZeroCrossing Vamp::HostExt::PluginBufferingAdapter Vamp::HostExt::PluginChannelAdapter Vamp::HostExt::PluginInputDomainAdapter

List of all members.


Detailed Description

A base class for plugins with optional configurable parameters, programs, etc. The Vamp::Plugin is derived from this, and individual Vamp plugins should derive from that.

This class does not provide the necessary interfaces to instantiate or run a plugin. It only specifies an interface for retrieving those controls that the host may wish to show to the user for editing. It could meaningfully be subclassed by real-time plugins or other sorts of plugin as well as Vamp plugins.

Definition at line 59 of file PluginBase.h.


Public Types

typedef std::vector
< ParameterDescriptor > 
ParameterList
typedef std::vector< std::string > ProgramList

Public Member Functions

virtual std::string getCopyright () const =0
virtual std::string getCurrentProgram () const
virtual std::string getDescription () const =0
virtual std::string getIdentifier () const =0
virtual std::string getMaker () const =0
virtual std::string getName () const =0
virtual float getParameter (std::string) const
virtual ParameterList getParameterDescriptors () const
virtual int getPluginVersion () const =0
virtual ProgramList getPrograms () const
virtual std::string getType () const =0
virtual unsigned int getVampApiVersion () const
virtual void selectProgram (std::string)
virtual void setParameter (std::string, float)

Classes

struct  ParameterDescriptor

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

Generated by  Doxygen 1.6.0   Back to index