#include <PluginBase.h>
cannam@0: cannam@0: cannam@0:
cannam@0: List of all members.
Definition at line 125 of file PluginBase.h.
cannam@0:Public Attributes | |
| std::string | identifier |
| The name of the parameter, in computer-usable form. | |
| std::string | name |
| The human-readable name of the parameter. | |
| std::string | description |
| A human-readable short text describing the parameter. | |
| std::string | unit |
| The unit of the parameter, in human-readable form. | |
| float | minValue |
| The minimum value of the parameter. | |
| float | maxValue |
| The maximum value of the parameter. | |
| float | defaultValue |
| The default value of the parameter. | |
| bool | isQuantized |
| True if the parameter values are quantized to a particular resolution. | |
| float | quantizeStep |
| Quantization resolution of the parameter values (e.g. | |
| std::vector< std::string > | valueNames |
| Names for the quantized values. | |
| std::string Vamp::PluginBase::ParameterDescriptor::identifier | cannam@0:
cannam@0: The name of the parameter, in computer-usable form. cannam@0:
cannam@0: Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-]. cannam@0:
Definition at line 132 of file PluginBase.h.
cannam@0: cannam@0:Referenced by Vamp::PluginHostAdapter::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
cannam@0: cannam@0:| std::string Vamp::PluginBase::ParameterDescriptor::name | cannam@0:
cannam@0: The human-readable name of the parameter. cannam@0:
cannam@0: cannam@0:
Definition at line 137 of file PluginBase.h.
cannam@0: cannam@0:Referenced by Vamp::PluginHostAdapter::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
cannam@0: cannam@0:| std::string Vamp::PluginBase::ParameterDescriptor::description | cannam@0:
cannam@0: A human-readable short text describing the parameter. cannam@0:
cannam@0: May be empty if the name has said it all already. cannam@0:
Definition at line 143 of file PluginBase.h.
cannam@0: cannam@0:Referenced by Vamp::PluginHostAdapter::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
cannam@0: cannam@0:| std::string Vamp::PluginBase::ParameterDescriptor::unit | cannam@0:
cannam@0: The unit of the parameter, in human-readable form. cannam@0:
cannam@0: cannam@0:
Definition at line 148 of file PluginBase.h.
cannam@0: cannam@0:Referenced by Vamp::PluginHostAdapter::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
cannam@0: cannam@0:| float Vamp::PluginBase::ParameterDescriptor::minValue | cannam@0:
cannam@0: The minimum value of the parameter. cannam@0:
cannam@0: cannam@0:
Definition at line 153 of file PluginBase.h.
cannam@0: cannam@0:Referenced by Vamp::PluginHostAdapter::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
cannam@0: cannam@0:| float Vamp::PluginBase::ParameterDescriptor::maxValue | cannam@0:
cannam@0: The maximum value of the parameter. cannam@0:
cannam@0: cannam@0:
Definition at line 158 of file PluginBase.h.
cannam@0: cannam@0:Referenced by Vamp::PluginHostAdapter::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
cannam@0: cannam@0:| float Vamp::PluginBase::ParameterDescriptor::defaultValue | cannam@0:
cannam@0: The default value of the parameter. cannam@0:
cannam@0: The plugin should ensure that parameters have this value on initialisation (i.e. the host is not required to explicitly set parameters if it wants to use their default values). cannam@0:
Definition at line 166 of file PluginBase.h.
cannam@0: cannam@0:Referenced by Vamp::PluginHostAdapter::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
cannam@0: cannam@0:| bool Vamp::PluginBase::ParameterDescriptor::isQuantized | cannam@0:
cannam@0: True if the parameter values are quantized to a particular resolution. cannam@0:
cannam@0: cannam@0:
Definition at line 172 of file PluginBase.h.
cannam@0: cannam@0:Referenced by Vamp::PluginHostAdapter::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
cannam@0: cannam@0:| float Vamp::PluginBase::ParameterDescriptor::quantizeStep | cannam@0:
cannam@0: Quantization resolution of the parameter values (e.g. cannam@0:
cannam@0: 1.0 if they are all integers). Undefined if isQuantized is false. cannam@0:
Definition at line 179 of file PluginBase.h.
cannam@0: cannam@0:Referenced by Vamp::PluginHostAdapter::getParameterDescriptors().
cannam@0: cannam@0:| std::vector<std::string> Vamp::PluginBase::ParameterDescriptor::valueNames | cannam@0:
cannam@0: Names for the quantized values. cannam@0:
cannam@0: If isQuantized is true, this may either be empty or contain one string for each of the quantize steps from minValue up to maxValue inclusive. Undefined if isQuantized is false.
cannam@0: If these names are provided, they should be shown to the user in preference to the values themselves. The user may never see the actual numeric values unless they are also encoded in the names. cannam@0:
Definition at line 192 of file PluginBase.h.
cannam@0: cannam@0:Referenced by Vamp::PluginHostAdapter::getParameterDescriptors().
cannam@0: cannam@0:cannam@0:
1.5.5
cannam@0:
cannam@0: