Parameter Hints

Various parameter hints. More...

Variables
static const uint32_t	kParameterIsAutomable = 0x01
static const uint32_t	kParameterIsBoolean = 0x02
static const uint32_t	kParameterIsInteger = 0x04
static const uint32_t	kParameterIsLogarithmic = 0x08
static const uint32_t	kParameterIsOutput = 0x10
static const uint32_t	kParameterIsTrigger = 0x20 | kParameterIsBoolean

Detailed Description

Various parameter hints.

See also

Parameter::hints

Variable Documentation

kParameterIsAutomable

const uint32_t kParameterIsAutomable = 0x01

static

Parameter is automable (real-time safe).

See also

Plugin::setParameterValue(uint32_t, float)

kParameterIsBoolean

const uint32_t kParameterIsBoolean = 0x02

static

Parameter value is boolean.
It's always at either minimum or maximum value.

kParameterIsInteger

const uint32_t kParameterIsInteger = 0x04

static

Parameter value is integer.

kParameterIsLogarithmic

const uint32_t kParameterIsLogarithmic = 0x08

static

Parameter value is logarithmic.

kParameterIsOutput

const uint32_t kParameterIsOutput = 0x10

static

Parameter is of output type.
When unset, parameter is assumed to be of input type.

Parameter inputs are changed by the host and typically should not be changed by the plugin.
One exception is when changing programs, see Plugin::loadProgram().
The other exception is with parameter change requests, see Plugin::requestParameterValueChange().
Outputs are changed by the plugin and never modified by the host.

If you are targetting VST2, make sure to order your parameters so that all inputs are before any outputs.

kParameterIsTrigger

const uint32_t kParameterIsTrigger = 0x20 | kParameterIsBoolean

static

Parameter value is a trigger.
This means the value resets back to its default after each process/run call.
Cannot be used for output parameters.

Note

Only officially supported under LV2. For other formats DPF simulates the behaviour.