cannam@50: cannam@50: cannam@50: cannam@50: cannam@0: VampPluginSDK: _VampParameterDescriptor 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@0:
cannam@50:
cannam@50: cannam@50:
cannam@50:
cannam@50:
cannam@50: cannam@50:
cannam@50:
cannam@50:
cannam@50: Public Attributes
cannam@50:
cannam@50:
_VampParameterDescriptor Struct Reference
cannam@50:
cannam@0:
cannam@50: cannam@50:

C language API for Vamp plugins. cannam@50: More...

cannam@0: cannam@50:

#include <vamp.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: Public Attributes

const char * identifier
 Computer-usable name of the parameter.
const char * name
 Human-readable name of the parameter.
const char * description
 Human-readable short text about the parameter.
const char * unit
 Human-readable unit of the parameter.
float minValue
 Minimum value.
float maxValue
 Maximum value.
float defaultValue
 Default value.
int isQuantized
 1 if parameter values are quantized to a particular resolution.
float quantizeStep
 Quantization resolution, if isQuantized.
const char ** valueNames
 Human-readable names of the values, if isQuantized.
cannam@50:

Detailed Description

cannam@50:

C language API for Vamp plugins.

cannam@50:

This is the formal plugin API for Vamp. Plugin authors may prefer to use the C++ classes provided in the Vamp plugin SDK, instead of using this API directly. There is an adapter class provided that makes C++ plugins available using this C API with relatively little work, and the C++ headers are more thoroughly documented.

cannam@50:

IMPORTANT: The comments in this file summarise the purpose of each of the declared fields and functions, but do not provide a complete guide to their permitted values and expected usage. Please refer to the C++ headers in the Vamp plugin SDK for further details and plugin lifecycle documentation.

cannam@0: cannam@50:

Definition at line 71 of file vamp.h.

cannam@50:

Member Data Documentation

cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
const char* _VampParameterDescriptor::identifier
cannam@0:
cannam@0:
cannam@0: cannam@50:

Computer-usable name of the parameter.

cannam@50:

Must not change. [a-zA-Z0-9_]

cannam@50: cannam@50:

Definition at line 74 of file vamp.h.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
const char* _VampParameterDescriptor::name
cannam@0:
cannam@0:
cannam@0: cannam@50:

Human-readable name of the parameter.

cannam@50:

May be translatable.

cannam@50: cannam@50:

Definition at line 77 of file vamp.h.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
const char* _VampParameterDescriptor::description
cannam@0:
cannam@0:
cannam@0: cannam@50:

Human-readable short text about the parameter.

cannam@50:

May be translatable.

cannam@50: cannam@50:

Definition at line 80 of file vamp.h.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
const char* _VampParameterDescriptor::unit
cannam@0:
cannam@0:
cannam@0: cannam@50:

Human-readable unit of the parameter.

cannam@0: cannam@50:

Definition at line 83 of file vamp.h.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
float _VampParameterDescriptor::minValue
cannam@0:
cannam@0:
cannam@0: cannam@50:

Minimum value.

cannam@0: cannam@50:

Definition at line 86 of file vamp.h.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
float _VampParameterDescriptor::maxValue
cannam@0:
cannam@0:
cannam@0: cannam@50:

Maximum value.

cannam@0: cannam@50:

Definition at line 89 of file vamp.h.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
float _VampParameterDescriptor::defaultValue
cannam@0:
cannam@0:
cannam@0: cannam@50:

Default value.

cannam@50:

Plugin is responsible for setting this on initialise.

cannam@50: cannam@50:

Definition at line 92 of file vamp.h.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
int _VampParameterDescriptor::isQuantized
cannam@0:
cannam@0:
cannam@0: cannam@50:

1 if parameter values are quantized to a particular resolution.

cannam@0: cannam@50:

Definition at line 95 of file vamp.h.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
float _VampParameterDescriptor::quantizeStep
cannam@0:
cannam@0:
cannam@0: cannam@50:

Quantization resolution, if isQuantized.

cannam@0: cannam@50:

Definition at line 98 of file vamp.h.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
const char** _VampParameterDescriptor::valueNames
cannam@0:
cannam@0:
cannam@0: cannam@50:

Human-readable names of the values, if isQuantized.

cannam@50:

May be NULL.

cannam@50: cannam@50:

Definition at line 101 of file vamp.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: