Chris@1: Chris@1: Chris@1: Chris@1: Chris@3: Chris@6: Chris@6: Chris@1: VampPluginSDK: _VampParameterDescriptor Struct Reference Chris@1: Chris@6: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1:
Chris@1:
VampPluginSDK Chris@6:  2.7 Chris@1:
Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@6: Public Attributes | Chris@6: List of all members
Chris@1:
Chris@1:
_VampParameterDescriptor Struct Reference
Chris@3:
Chris@1:
Chris@3: Chris@1:

C language API for Vamp plugins. Chris@1: More...

Chris@1: Chris@1:

#include <vamp.h>

Chris@1: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@1:

Chris@1: Public Attributes

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

Detailed Description

Chris@1:

C language API for Vamp plugins.

Chris@1:

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.

Chris@1:

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.

Chris@1: Chris@6:

Definition at line 71 of file vamp.h.

Chris@6:

Member Data Documentation

Chris@6: Chris@6:

◆ identifier

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
const char* _VampParameterDescriptor::identifier
Chris@6:
Chris@1: Chris@1:

Computer-usable name of the parameter.

Chris@6:

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

Chris@1: Chris@6:

Definition at line 74 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ name

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
const char* _VampParameterDescriptor::name
Chris@6:
Chris@1: Chris@1:

Human-readable name of the parameter.

Chris@1:

May be translatable.

Chris@1: Chris@6:

Definition at line 77 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ description

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
const char* _VampParameterDescriptor::description
Chris@6:
Chris@1: Chris@1:

Human-readable short text about the parameter.

Chris@1:

May be translatable.

Chris@1: Chris@6:

Definition at line 80 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ unit

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
const char* _VampParameterDescriptor::unit
Chris@6:
Chris@1: Chris@1:

Human-readable unit of the parameter.

Chris@1: Chris@6:

Definition at line 83 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ minValue

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float _VampParameterDescriptor::minValue
Chris@6:
Chris@1: Chris@1:

Minimum value.

Chris@1: Chris@6:

Definition at line 86 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ maxValue

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float _VampParameterDescriptor::maxValue
Chris@6:
Chris@1: Chris@1:

Maximum value.

Chris@1: Chris@6:

Definition at line 89 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ defaultValue

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float _VampParameterDescriptor::defaultValue
Chris@6:
Chris@1: Chris@1:

Default value.

Chris@1:

Plugin is responsible for setting this on initialise.

Chris@1: Chris@6:

Definition at line 92 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ isQuantized

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
int _VampParameterDescriptor::isQuantized
Chris@6:
Chris@1: Chris@1:

1 if parameter values are quantized to a particular resolution.

Chris@1: Chris@6:

Definition at line 95 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ quantizeStep

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
float _VampParameterDescriptor::quantizeStep
Chris@6:
Chris@1: Chris@1:

Quantization resolution, if isQuantized.

Chris@1: Chris@6:

Definition at line 98 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ valueNames

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
const char** _VampParameterDescriptor::valueNames
Chris@6:
Chris@1: Chris@1:

Human-readable names of the values, if isQuantized.

Chris@1:

May be NULL.

Chris@1: Chris@6:

Definition at line 101 of file vamp.h.

Chris@1: Chris@1:
Chris@1:
Chris@1:
The documentation for this struct was generated from the following file: Chris@3:
Chris@6:
Chris@6: Chris@6: Chris@1: Chris@1: