ivstnoteexpression.h File Reference

#include "pluginterfaces/base/funknown.h"
#include "pluginterfaces/vst/vsttypes.h"
#include "pluginterfaces/base/falignpush.h"
#include "pluginterfaces/base/falignpop.h"

Go to the source code of this file.

Classes
struct	Steinberg::Vst::NoteExpressionValueDescription
	Description of a Note Expression Type This structure is part of the NoteExpressionTypeInfo structure, it describes for given NoteExpressionTypeID its default value (for example 0.5 for a kTuningTypeID (kIsBipolar: centered)), its minimum and maximum (for predefined NoteExpressionTypeID the full range is predefined too) and a stepCount when the given NoteExpressionTypeID is limited to discrete values (like on/off state). More...
struct	Steinberg::Vst::NoteExpressionValueEvent
	Note Expression Value event. More...
struct	Steinberg::Vst::NoteExpressionTextEvent
	Note Expression Text event. More...
struct	Steinberg::Vst::NoteExpressionTypeInfo
	NoteExpressionTypeInfo is the structure describing a note expression supported by the plug-in. More...
class	Steinberg::Vst::INoteExpressionController
	Extended plug-in interface IEditController for note expression event support: Vst::INoteExpressionController. More...
struct	Steinberg::Vst::KeyswitchInfo
	KeyswitchInfo is the structure describing a key switch This structure is used by the method IKeyswitchController::getKeyswitchInfo. More...
class	Steinberg::Vst::IKeyswitchController
	Extended plug-in interface IEditController for key switches support: Vst::IKeyswitchController. More...

Namespaces
namespace	Steinberg::Vst
	All VST specific interfaces are located in Vst namespace.

Typedefs
typedef uint32	Steinberg::Vst::NoteExpressionTypeID
	Note Expression Types.
typedef double	Steinberg::Vst::NoteExpressionValue
	Note Expression Value.
typedef uint32	Steinberg::Vst::KeyswitchTypeID

Enumerations
enum	Steinberg::Vst::NoteExpressionTypeIDs : uint32 {   Steinberg::Vst::kVolumeTypeID , Steinberg::Vst::kPanTypeID , Steinberg::Vst::kTuningTypeID , Steinberg::Vst::kVibratoTypeID ,   Steinberg::Vst::kExpressionTypeID , Steinberg::Vst::kBrightnessTypeID , Steinberg::Vst::kTextTypeID , Steinberg::Vst::kPhonemeTypeID ,   Steinberg::Vst::kCustomStart , Steinberg::Vst::kCustomEnd , Steinberg::Vst::kInvalidTypeID }
	NoteExpressionTypeIDs describes the type of the note expression. More...
enum	Steinberg::Vst::KeyswitchTypeIDs : uint32 { Steinberg::Vst::kNoteOnKeyswitchTypeID , Steinberg::Vst::kOnTheFlyKeyswitchTypeID , Steinberg::Vst::kOnReleaseKeyswitchTypeID , Steinberg::Vst::kKeyRangeTypeID }
	KeyswitchTypeIDs describes the type of a key switch. More...

---

Class Documentation

Steinberg::Vst::NoteExpressionValueDescription

struct Steinberg::Vst::NoteExpressionValueDescription

Description of a Note Expression Type This structure is part of the NoteExpressionTypeInfo structure, it describes for given NoteExpressionTypeID its default value (for example 0.5 for a kTuningTypeID (kIsBipolar: centered)), its minimum and maximum (for predefined NoteExpressionTypeID the full range is predefined too) and a stepCount when the given NoteExpressionTypeID is limited to discrete values (like on/off state).

See also

NoteExpressionTypeInfo

Definition at line 72 of file ivstnoteexpression.h.

Class Members
NoteExpressionValue	defaultValue	default normalized value [0,1]
NoteExpressionValue	maximum	maximum normalized value [0,1]
NoteExpressionValue	minimum	minimum normalized value [0,1]
int32	stepCount	number of discrete steps (0: continuous, 1: toggle, discrete value otherwise - see vst3ParameterIntro)

Steinberg::Vst::NoteExpressionValueEvent

struct Steinberg::Vst::NoteExpressionValueEvent

Note Expression Value event.

Used in Event (union) A note expression event affects one single playing note (referring its noteId). This kind of event is send from host to the plug-in like other events (NoteOnEvent, NoteOffEvent,...) in ProcessData during the process call. Note expression events for a specific noteId can only occur after a NoteOnEvent. The host must take care that the event list (IEventList) is properly sorted. Expression events are always absolute normalized values [0.0, 1.0]. The predefined types have a predefined mapping of the normalized values (see NoteExpressionTypeIDs)

See also

INoteExpressionController

Definition at line 92 of file ivstnoteexpression.h.

Class Members
int32	noteId	associated note identifier to apply the change
NoteExpressionTypeID	typeId	see NoteExpressionTypeID
NoteExpressionValue	value	normalized value [0.0, 1.0].

Steinberg::Vst::NoteExpressionTextEvent

struct Steinberg::Vst::NoteExpressionTextEvent

Note Expression Text event.

Used in Event (union) A Expression event affects one single playing note.

See also

INoteExpressionController

NoteExpressionTypeInfo

Definition at line 106 of file ivstnoteexpression.h.

Class Members
int32	noteId	associated note identifier to apply the change
const TChar *	text	UTF-16, null terminated.
uint32	textLen	the number of characters (TChar) between the beginning of text and the terminating null character (without including the terminating null character itself)
NoteExpressionTypeID	typeId	see NoteExpressionTypeID (kTextTypeID or kPhoneticTypeID)

Steinberg::Vst::KeyswitchInfo

struct Steinberg::Vst::KeyswitchInfo

KeyswitchInfo is the structure describing a key switch This structure is used by the method IKeyswitchController::getKeyswitchInfo.

See also

IKeyswitchController

Definition at line 206 of file ivstnoteexpression.h.

Class Members
int32	flags	not yet used (set to 0)
int32	keyRemapped
int32	keyswitchMax	associated main key switch max (value between [0, 127])
int32	keyswitchMin	associated main key switch min (value between [0, 127])
String128	shortTitle	short title (e.g. "Acc")
String128	title	name of key switch (e.g. "Accentuation")
KeyswitchTypeID	typeId	see KeyswitchTypeID
int32	unitId	optional remapped key switch (default -1), the plug-in could provide one remapped key for a key switch (allowing better location on the keyboard of the key switches) id of unit this key switch belongs to (see vst3Units), -1 means no unit used.