-
Chris@1:
Chris@1:
Chris@1:
Chris@1:
Chris@1:
- Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by
Chris@1:
Chris@1:
1.7.5.1
Chris@1:
|
Chris@1: VampPluginSDK
Chris@1: 2.1
Chris@1:
Chris@1:
Chris@1: |
Chris@1:
Chris@1:
Chris@1:
Chris@1:
#include <PluginBase.h>
Chris@1: Public Member Functions | |
| ParameterDescriptor () | |
Chris@1: 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. | |
Definition at line 130 of file vamp-sdk/PluginBase.h.
Chris@1:| Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor | Chris@1:( | Chris@1:) | Chris@1: [inline] |
Chris@1:
Definition at line 199 of file vamp-sdk/PluginBase.h.
Chris@1: Chris@1:| std::string Vamp::PluginBase::ParameterDescriptor::identifier | Chris@1:
The name of the parameter, in computer-usable form.
Chris@1:Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-].
Chris@1: Chris@1:Definition at line 137 of file vamp-sdk/PluginBase.h.
Chris@1: Chris@1:Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
Chris@1: Chris@1:| std::string Vamp::PluginBase::ParameterDescriptor::name | Chris@1:
The human-readable name of the parameter.
Chris@1: Chris@1:Definition at line 142 of file vamp-sdk/PluginBase.h.
Chris@1: Chris@1:Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
Chris@1: Chris@1:| std::string Vamp::PluginBase::ParameterDescriptor::description | Chris@1:
A human-readable short text describing the parameter.
Chris@1:May be empty if the name has said it all already.
Chris@1: Chris@1:Definition at line 148 of file vamp-sdk/PluginBase.h.
Chris@1: Chris@1:Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
Chris@1: Chris@1:| std::string Vamp::PluginBase::ParameterDescriptor::unit | Chris@1:
The unit of the parameter, in human-readable form.
Chris@1: Chris@1:Definition at line 153 of file vamp-sdk/PluginBase.h.
Chris@1: Chris@1:Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
Chris@1: Chris@1:| float Vamp::PluginBase::ParameterDescriptor::minValue | Chris@1:
The minimum value of the parameter.
Chris@1: Chris@1:Definition at line 158 of file vamp-sdk/PluginBase.h.
Chris@1: Chris@1:Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
Chris@1: Chris@1:| float Vamp::PluginBase::ParameterDescriptor::maxValue | Chris@1:
The maximum value of the parameter.
Chris@1: Chris@1:Definition at line 163 of file vamp-sdk/PluginBase.h.
Chris@1: Chris@1:Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
Chris@1: Chris@1:| float Vamp::PluginBase::ParameterDescriptor::defaultValue | Chris@1:
The default value of the parameter.
Chris@1: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).
Chris@1: Chris@1:Definition at line 171 of file vamp-sdk/PluginBase.h.
Chris@1: Chris@1:Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
Chris@1: Chris@1:| bool Vamp::PluginBase::ParameterDescriptor::isQuantized | Chris@1:
True if the parameter values are quantized to a particular resolution.
Chris@1: Chris@1:Definition at line 177 of file vamp-sdk/PluginBase.h.
Chris@1: Chris@1:Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().
Chris@1: Chris@1:| float Vamp::PluginBase::ParameterDescriptor::quantizeStep | Chris@1:
Quantization resolution of the parameter values (e.g.
Chris@1:1.0 if they are all integers). Undefined if isQuantized is false.
Chris@1: Chris@1:Definition at line 184 of file vamp-sdk/PluginBase.h.
Chris@1: Chris@1:| std::vector<std::string> Vamp::PluginBase::ParameterDescriptor::valueNames | Chris@1:
Names for the quantized values.
Chris@1: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.
Chris@1: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.
Chris@1: Chris@1:Definition at line 197 of file vamp-sdk/PluginBase.h.
Chris@1: Chris@1: 1.7.5.1