Go to the documentation of this file.
37 #ifndef _VAMP_SDK_PLUGIN_BASE_H_
38 #define _VAMP_SDK_PLUGIN_BASE_H_
83 virtual std::string getIdentifier()
const = 0;
93 virtual std::string getName()
const = 0;
103 virtual std::string getDescription()
const = 0;
111 virtual std::string getMaker()
const = 0;
118 virtual std::string getCopyright()
const = 0;
123 virtual int getPluginVersion()
const = 0;
255 virtual std::string getType()
const = 0;
virtual ParameterList getParameterDescriptors() const
Get the controllable parameters of this plugin.
std::string description
A human-readable short text describing the parameter.
virtual ProgramList getPrograms() const
Get the program settings available in this plugin.
std::string unit
The unit of the parameter, in human-readable form.
float quantizeStep
Quantization resolution of the parameter values (e.g.
virtual float getParameter(std::string) const
Get the value of a named parameter.
bool isQuantized
True if the parameter values are quantized to a particular resolution.
#define _VAMP_SDK_PLUGSPACE_BEGIN(h)
virtual void setParameter(std::string, float)
Set a named parameter.
A base class for plugins with optional configurable parameters, programs, etc.
float defaultValue
The default value of the parameter.
virtual unsigned int getVampApiVersion() const
Get the Vamp API compatibility level of the plugin.
std::vector< std::string > ProgramList
std::vector< std::string > valueNames
Names for the quantized values.
std::string identifier
The name of the parameter, in computer-usable form.
float minValue
The minimum value of the parameter.
std::vector< ParameterDescriptor > ParameterList
virtual void selectProgram(std::string)
Select a program.
float maxValue
The maximum value of the parameter.
virtual std::string getCurrentProgram() const
Get the current program.
#define _VAMP_SDK_PLUGSPACE_END(h)
std::string name
The human-readable name of the parameter.