|
VST 3 Interfaces
VST 3.7
SDK for developing VST plug-in
|
Controller Parameter Info. More...
#include <ivsteditcontroller.h>
Public Types | |
| enum | ParameterFlags { kNoFlags = 0, kCanAutomate = 1 << 0, kIsReadOnly = 1 << 1, kIsWrapAround = 1 << 2, kIsList = 1 << 3, kIsHidden = 1 << 4, kIsProgramChange = 1 << 15, kIsBypass = 1 << 16 } |
Public Attributes | |
| ParamID | id |
| unique identifier of this parameter (named tag too) More... | |
| String128 | title |
| parameter title (e.g. "Volume") More... | |
| String128 | shortTitle |
| parameter shortTitle (e.g. "Vol") More... | |
| String128 | units |
| parameter unit (e.g. "dB") More... | |
| int32 | stepCount |
| number of discrete steps (0: continuous, 1: toggle, discrete value otherwise (corresponding to max - min, for example: 127 for a min = 0 and a max = 127) - see Parameters) More... | |
| ParamValue | defaultNormalizedValue |
| default normalized value 0,1 More... | |
| UnitID | unitId |
| id of unit this parameter belongs to (see VST 3 Units) More... | |
| int32 | flags |
| ParameterFlags (see below) More... | |
Controller Parameter Info.
A parameter info describes a parameter of the controller. The id must always be the same for a parameter as this uniquely identifies the parameter.
| enum ParameterFlags |
| Enumerator | |
|---|---|
| kNoFlags | no flags wanted |
| kCanAutomate | parameter can be automated |
| kIsReadOnly | parameter cannot be changed from outside the plug-in (implies that kCanAutomate is NOT set) |
| kIsWrapAround | attempts to set the parameter value out of the limits will result in a wrap around [SDK 3.0.2] |
| kIsList | parameter should be displayed as list in generic editor or automation editing [SDK 3.1.0] |
| kIsHidden | parameter should be NOT displayed and cannot be changed from outside the plug-in (implies that kCanAutomate is NOT set and kIsReadOnly is set) [SDK 3.7.0] |
| kIsProgramChange | parameter is a program change (unitId gives info about associated unit
|
| kIsBypass | special bypass parameter (only one allowed): plug-in can handle bypass (highly recommended to export a bypass parameter for effect plug-in) |
| ParamID id |
unique identifier of this parameter (named tag too)
| String128 title |
parameter title (e.g. "Volume")
| String128 shortTitle |
parameter shortTitle (e.g. "Vol")
| String128 units |
parameter unit (e.g. "dB")
| int32 stepCount |
number of discrete steps (0: continuous, 1: toggle, discrete value otherwise (corresponding to max - min, for example: 127 for a min = 0 and a max = 127) - see Parameters)
| ParamValue defaultNormalizedValue |
default normalized value 0,1
| UnitID unitId |
id of unit this parameter belongs to (see VST 3 Units)
| int32 flags |
ParameterFlags (see below)