cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: VampPluginSDK: Vamp::PluginBase::ParameterDescriptor Struct Reference cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50: cannam@50: cannam@50:
cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50:
VampPluginSDK cannam@50:  2.1 cannam@50:
cannam@50: cannam@50:
cannam@50:
cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50:
cannam@50: cannam@50:
cannam@0:
cannam@0:
cannam@50: cannam@50:
cannam@50:
cannam@50:
cannam@50: Public Member Functions | cannam@50: Public Attributes
cannam@50:
cannam@50:
Vamp::PluginBase::ParameterDescriptor Struct Reference
cannam@50:
cannam@0:
cannam@50: cannam@50:

#include <PluginBase.h>

cannam@0: cannam@50:

List of all members.

cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@35:

cannam@50: Public Member Functions

 ParameterDescriptor ()

cannam@50: 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.
cannam@50:

Detailed Description

cannam@50:
cannam@50:

Definition at line 130 of file vamp-sdk/PluginBase.h.

cannam@50:

Constructor & Destructor Documentation

cannam@50: cannam@21:
cannam@21:
cannam@21: cannam@21: cannam@50: cannam@21: cannam@50: cannam@21: cannam@21: cannam@21:
Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor () [inline]
cannam@21:
cannam@21:
cannam@21: cannam@50:

Definition at line 199 of file vamp-sdk/PluginBase.h.

cannam@21: cannam@21:
cannam@50:
cannam@50:

Member Data Documentation

cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
std::string Vamp::PluginBase::ParameterDescriptor::identifier
cannam@0:
cannam@0:
cannam@0: cannam@50:

The name of the parameter, in computer-usable form.

cannam@50:

Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-].

cannam@0: cannam@50:

Definition at line 137 of file vamp-sdk/PluginBase.h.

cannam@50: cannam@50:

Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
std::string Vamp::PluginBase::ParameterDescriptor::name
cannam@0:
cannam@0:
cannam@0: cannam@50:

The human-readable name of the parameter.

cannam@0: cannam@50:

Definition at line 142 of file vamp-sdk/PluginBase.h.

cannam@0: cannam@50:

Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
std::string Vamp::PluginBase::ParameterDescriptor::description
cannam@0:
cannam@0:
cannam@0: cannam@50:

A human-readable short text describing the parameter.

cannam@50:

May be empty if the name has said it all already.

cannam@0: cannam@50:

Definition at line 148 of file vamp-sdk/PluginBase.h.

cannam@50: cannam@50:

Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
std::string Vamp::PluginBase::ParameterDescriptor::unit
cannam@0:
cannam@0:
cannam@0: cannam@50:

The unit of the parameter, in human-readable form.

cannam@0: cannam@50:

Definition at line 153 of file vamp-sdk/PluginBase.h.

cannam@0: cannam@50:

Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
float Vamp::PluginBase::ParameterDescriptor::minValue
cannam@0:
cannam@0:
cannam@0: cannam@50:

The minimum value of the parameter.

cannam@0: cannam@50:

Definition at line 158 of file vamp-sdk/PluginBase.h.

cannam@0: cannam@50:

Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
float Vamp::PluginBase::ParameterDescriptor::maxValue
cannam@0:
cannam@0:
cannam@0: cannam@50:

The maximum value of the parameter.

cannam@0: cannam@50:

Definition at line 163 of file vamp-sdk/PluginBase.h.

cannam@0: cannam@50:

Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
float Vamp::PluginBase::ParameterDescriptor::defaultValue
cannam@0:
cannam@0:
cannam@0: cannam@50:

The default value of the parameter.

cannam@50:

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: cannam@50:

Definition at line 171 of file vamp-sdk/PluginBase.h.

cannam@50: cannam@50:

Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
bool Vamp::PluginBase::ParameterDescriptor::isQuantized
cannam@0:
cannam@0:
cannam@0: cannam@50:

True if the parameter values are quantized to a particular resolution.

cannam@0: cannam@50:

Definition at line 177 of file vamp-sdk/PluginBase.h.

cannam@0: cannam@50:

Referenced by FixedTempoEstimator::D::getParameterDescriptors(), PercussionOnsetDetector::getParameterDescriptors(), and AmplitudeFollower::getParameterDescriptors().

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
float Vamp::PluginBase::ParameterDescriptor::quantizeStep
cannam@0:
cannam@0:
cannam@0: cannam@50:

Quantization resolution of the parameter values (e.g.

cannam@50:

1.0 if they are all integers). Undefined if isQuantized is false.

cannam@50: cannam@50:

Definition at line 184 of file vamp-sdk/PluginBase.h.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
std::vector<std::string> Vamp::PluginBase::ParameterDescriptor::valueNames
cannam@0:
cannam@0:
cannam@0: cannam@50:

Names for the quantized values.

cannam@50:

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@50:

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@50: cannam@50:

Definition at line 197 of file vamp-sdk/PluginBase.h.

cannam@0: cannam@0:
cannam@0:
cannam@50:
The documentation for this struct was generated from the following file: cannam@50:
cannam@50:
cannam@50: cannam@50: cannam@50: cannam@0: cannam@0: