NoteExpressionTypeInfo is the structure describing a note expression supported by the plug-in. More...

#include "ivstnoteexpression.h"

Public Types
enum	NoteExpressionTypeFlags { kIsBipolar , kIsOneShot , kIsAbsolute , kAssociatedParameterIDValid }

Public Attributes
NoteExpressionTypeID	typeId
	unique identifier of this note Expression type

String128	title
	note Expression type title (e.g. "Volume")

String128	shortTitle
	note Expression type short title (e.g. "Vol")

String128	units
	note Expression type unit (e.g. "dB")

int32	unitId
	id of unit this NoteExpression belongs to (see vst3Units), in order to sort the note expression, it is possible to use unitId like for parameters. -1 means no unit used.

NoteExpressionValueDescription	valueDesc
	value description see NoteExpressionValueDescription

ParamID	associatedParameterId
	optional associated parameter ID (for mapping from note expression to global (using the parameter automation for example) and back). Only used when kAssociatedParameterIDValid is set in flags.

int32	flags
	NoteExpressionTypeFlags (see below)

Detailed Description

NoteExpressionTypeInfo is the structure describing a note expression supported by the plug-in.

This structure is used by the method INoteExpressionController::getNoteExpressionInfo.

See also: INoteExpressionController

Definition at line 126 of file ivstnoteexpression.h.

Member Enumeration Documentation

◆ NoteExpressionTypeFlags

enum Steinberg::Vst::NoteExpressionTypeInfo::NoteExpressionTypeFlags

Enumerator
kIsBipolar	event is bipolar (centered), otherwise unipolar
kIsOneShot	event occurs only one time for its associated note (at begin of the noteOn)
kIsAbsolute	This note expression will apply an absolute change to the sound (not relative (offset))
kAssociatedParameterIDValid	indicates that the associatedParameterID is valid and could be used

Definition at line 137 of file ivstnoteexpression.h.

Member Data Documentation

◆ associatedParameterId

ParamID Steinberg::Vst::NoteExpressionTypeInfo::associatedParameterId

optional associated parameter ID (for mapping from note expression to global (using the parameter automation for example) and back). Only used when kAssociatedParameterIDValid is set in flags.

Definition at line 134 of file ivstnoteexpression.h.

◆ flags

int32 Steinberg::Vst::NoteExpressionTypeInfo::flags

NoteExpressionTypeFlags (see below)

Definition at line 136 of file ivstnoteexpression.h.

◆ shortTitle

String128 Steinberg::Vst::NoteExpressionTypeInfo::shortTitle

note Expression type short title (e.g. "Vol")

Definition at line 130 of file ivstnoteexpression.h.

◆ title

String128 Steinberg::Vst::NoteExpressionTypeInfo::title

note Expression type title (e.g. "Volume")

Definition at line 129 of file ivstnoteexpression.h.

◆ typeId

NoteExpressionTypeID Steinberg::Vst::NoteExpressionTypeInfo::typeId

unique identifier of this note Expression type

Definition at line 128 of file ivstnoteexpression.h.

◆ unitId

int32 Steinberg::Vst::NoteExpressionTypeInfo::unitId

id of unit this NoteExpression belongs to (see vst3Units), in order to sort the note expression, it is possible to use unitId like for parameters. -1 means no unit used.

Definition at line 132 of file ivstnoteexpression.h.

◆ units

String128 Steinberg::Vst::NoteExpressionTypeInfo::units

note Expression type unit (e.g. "dB")

Definition at line 131 of file ivstnoteexpression.h.

◆ valueDesc

NoteExpressionValueDescription Steinberg::Vst::NoteExpressionTypeInfo::valueDesc

value description see NoteExpressionValueDescription

Definition at line 133 of file ivstnoteexpression.h.

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

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

Public Types

Public Attributes