Parameter Hints

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

Detailed Description

Various parameter hints.

See also

Parameter::hints

Variable Documentation

kParameterIsAutomatable

constexpr const uint32_t kParameterIsAutomatable = 0x01

staticconstexpr

Parameter is automatable (real-time safe).

See also

Plugin::setParameterValue(uint32_t, float)

kParameterIsAutomable

constexpr const uint32_t kParameterIsAutomable = kParameterIsAutomatable

staticconstexpr

It was a typo, sorry..

kParameterIsBoolean

constexpr const uint32_t kParameterIsBoolean = 0x02

staticconstexpr

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

kParameterIsInteger

constexpr const uint32_t kParameterIsInteger = 0x04

staticconstexpr

Parameter value is integer.

kParameterIsLogarithmic

constexpr const uint32_t kParameterIsLogarithmic = 0x08

staticconstexpr

Parameter value is logarithmic.

kParameterIsOutput

constexpr const uint32_t kParameterIsOutput = 0x10

staticconstexpr

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

constexpr const uint32_t kParameterIsTrigger = 0x20 | kParameterIsBoolean

staticconstexpr

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.

kParameterIsHidden

constexpr const uint32_t kParameterIsHidden = 0x40

staticconstexpr

Parameter should be hidden from the host and user-visible GUIs.
It is still saved and handled as any regular parameter, just not visible to the user (for example in a host generated GUI)