Parameter Hints

Variables
static constexpr const uint	PARAMETER_IS_BOOLEAN = 0x001
static constexpr const uint	PARAMETER_IS_INTEGER = 0x002
static constexpr const uint	PARAMETER_IS_LOGARITHMIC = 0x004
static constexpr const uint	PARAMETER_IS_ENABLED = 0x010
static constexpr const uint	PARAMETER_IS_AUTOMATABLE = 0x020
static constexpr const uint	PARAMETER_IS_AUTOMABLE = 0x020
static constexpr const uint	PARAMETER_IS_READ_ONLY = 0x040
static constexpr const uint	PARAMETER_USES_SAMPLERATE = 0x100
static constexpr const uint	PARAMETER_USES_SCALEPOINTS = 0x200
static constexpr const uint	PARAMETER_USES_CUSTOM_TEXT = 0x400
static constexpr const uint	PARAMETER_CAN_BE_CV_CONTROLLED = 0x800
static constexpr const uint	PARAMETER_IS_NOT_SAVED = 0x1000

Detailed Description

Various parameter hints.

See also

CarlaPlugin::getParameterData() and carla_get_parameter_data()

Variable Documentation

PARAMETER_CAN_BE_CV_CONTROLLED

const uint PARAMETER_CAN_BE_CV_CONTROLLED = 0x800

staticconstexpr

Parameter can be turned into a CV control.

PARAMETER_IS_AUTOMABLE

const uint PARAMETER_IS_AUTOMABLE = 0x020

staticconstexpr

PARAMETER_IS_AUTOMATABLE

const uint PARAMETER_IS_AUTOMATABLE = 0x020

staticconstexpr

Parameter is automatable (real-time safe).

PARAMETER_IS_BOOLEAN

const uint PARAMETER_IS_BOOLEAN = 0x001

staticconstexpr

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

PARAMETER_IS_ENABLED

const uint PARAMETER_IS_ENABLED = 0x010

staticconstexpr

Parameter is enabled. It can be viewed, changed and stored.

PARAMETER_IS_INTEGER

const uint PARAMETER_IS_INTEGER = 0x002

staticconstexpr

Parameter value is integer.

PARAMETER_IS_LOGARITHMIC

const uint PARAMETER_IS_LOGARITHMIC = 0x004

staticconstexpr

Parameter value is logarithmic.

PARAMETER_IS_NOT_SAVED

const uint PARAMETER_IS_NOT_SAVED = 0x1000

staticconstexpr

Parameter should not be saved as part of the project/session.

Note

only valid for parameter inputs.

PARAMETER_IS_READ_ONLY

const uint PARAMETER_IS_READ_ONLY = 0x040

staticconstexpr

Parameter is read-only. It cannot be changed.

PARAMETER_USES_CUSTOM_TEXT

const uint PARAMETER_USES_CUSTOM_TEXT = 0x400

staticconstexpr

Parameter uses custom text for displaying its value.

See also

CarlaPlugin::getParameterText() and carla_get_parameter_text()

PARAMETER_USES_SAMPLERATE

const uint PARAMETER_USES_SAMPLERATE = 0x100

staticconstexpr

Parameter needs sample rate to work. Value and ranges are multiplied by sample rate on usage and divided by sample rate on save.

PARAMETER_USES_SCALEPOINTS

const uint PARAMETER_USES_SCALEPOINTS = 0x200

staticconstexpr

Parameter uses scale points to define internal values in a meaningful way.