Controller Parameter Info. More...

#include "ivsteditcontroller.h"

Public Types
enum	ParameterFlags { kNoFlags , kCanAutomate , kIsReadOnly , kIsWrapAround , kIsList , kIsHidden , kIsProgramChange , kIsBypass }

Public Attributes
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 vst3ParameterIntro)

ParamValue	defaultNormalizedValue
	default normalized value [0,1] (in case of discrete value: defaultNormalizedValue = defDiscreteValue / stepCount)

UnitID	unitId
	id of unit this parameter belongs to (see vst3Units)

int32	flags
	ParameterFlags (see below)

Detailed Description

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.

Definition at line 46 of file ivsteditcontroller.h.

Member Enumeration Documentation

◆ ParameterFlags

enum Steinberg::Vst::ParameterInfo::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 see vst3ProgramLists)
kIsBypass	special bypass parameter (only one allowed): plug-in can handle bypass (highly recommended to export a bypass parameter for effect plug-in)

Definition at line 59 of file ivsteditcontroller.h.

Member Data Documentation

◆ defaultNormalizedValue

ParamValue Steinberg::Vst::ParameterInfo::defaultNormalizedValue

default normalized value [0,1] (in case of discrete value: defaultNormalizedValue = defDiscreteValue / stepCount)

Definition at line 55 of file ivsteditcontroller.h.

◆ flags

int32 Steinberg::Vst::ParameterInfo::flags

ParameterFlags (see below)

Definition at line 58 of file ivsteditcontroller.h.

◆ id

ParamID Steinberg::Vst::ParameterInfo::id

unique identifier of this parameter (named tag too)

Definition at line 49 of file ivsteditcontroller.h.

◆ shortTitle

String128 Steinberg::Vst::ParameterInfo::shortTitle

parameter shortTitle (e.g. "Vol")

Definition at line 51 of file ivsteditcontroller.h.

◆ stepCount

int32 Steinberg::Vst::ParameterInfo::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 vst3ParameterIntro)

Definition at line 53 of file ivsteditcontroller.h.

◆ title

String128 Steinberg::Vst::ParameterInfo::title

parameter title (e.g. "Volume")

Definition at line 50 of file ivsteditcontroller.h.

◆ unitId

UnitID Steinberg::Vst::ParameterInfo::unitId

id of unit this parameter belongs to (see vst3Units)

Definition at line 56 of file ivsteditcontroller.h.

◆ units

String128 Steinberg::Vst::ParameterInfo::units

parameter unit (e.g. "dB")

Definition at line 52 of file ivsteditcontroller.h.

The documentation for this struct was generated from the following file:

juce_audio_processors/format_types/VST3_SDK/pluginterfaces/vst/ivsteditcontroller.h

Public Types

Public Attributes