VST 3 Interfaces  VST 3.6.14
SDK for developing VST Plug-in
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
NoteExpressionTypeInfo Struct Reference

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

#include <ivstnoteexpression.h>

Public Types

enum  NoteExpressionTypeFlags { kIsBipolar = 1 << 0, kIsOneShot = 1 << 1, kIsAbsolute = 1 << 2, kAssociatedParameterIDValid = 1 << 3 }
 

Public Attributes

NoteExpressionTypeID typeId
 unique identifier of this note Expression type More...
 
String128 title
 note Expression type title (e.g. "Volume") More...
 
String128 shortTitle
 note Expression type short title (e.g. "Vol") More...
 
String128 units
 note Expression type unit (e.g. "dB") More...
 
int32 unitId
 id of unit this NoteExpression belongs to (see VST 3 Units), in order to sort the note expression, it is possible to use unitId like for parameters. -1 means no unit used. More...
 
NoteExpressionValueDescription valueDesc
 value description see NoteExpressionValueDescription More...
 
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. More...
 
int32 flags
 NoteExpressionTypeFlags (see below) More...
 

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

Member Enumeration Documentation

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

Member Data Documentation

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 VST 3 Units), in order to sort the note expression, it is possible to use unitId like for parameters. -1 means no unit used.

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)

Empty

Copyright ©2019 Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.