INoteExpressionController Class Reference
[VST 3 Interfaces to be implemented by Plug-inVST 3 Interfaces defined in version 3.5.0]

Extended IEditController interface for note expression event support. More...

#include <ivstnoteexpression.h>

Inheritance diagram for INoteExpressionController:
Inheritance graph
[legend]

Public Member Functions

virtual int32 getNoteExpressionCount (int32 busIndex, int16 channel)=0
 Returns number of supported note change types for event bus index and channel.
virtual tresult getNoteExpressionInfo (int32 busIndex, int16 channel, int32 noteExpressionIndex, NoteExpressionTypeInfo &info)=0
 Returns note change type info.
virtual tresult getNoteExpressionStringByValue (int32 busIndex, int16 channel, NoteExpressionTypeID id, NoteExpressionValue valueNormalized, String128 string)=0
 Gets a user readable representation of the normalized note change value.
virtual tresult getNoteExpressionValueByString (int32 busIndex, int16 channel, NoteExpressionTypeID id, const TChar *string, NoteExpressionValue &valueNormalized)=0
 Converts the user readable representation to the normalized note change value.

Static Public Attributes

static const FUID iid

Detailed Description

Extended IEditController interface for note expression event support.

With this Plug-in interface, the host can retrieve all necessary note expression information supported by the Plug-in. Note expression information (NoteExpressionTypeInfo) are specific for given channel and event bus.

Note that there is only one NoteExpressionTypeID per given channel of an event bus.

The method getNoteExpressionStringByValue allows conversion from a normalized value to a string representation and the getNoteExpressionValueByString method from a string to a normalized value.

When the note expression state changes (per example when switching presets) the Plug-in needs to inform the host about it via IComponentHandler::restartComponent (kNoteExpressionChanged).


Member Function Documentation

virtual int32 getNoteExpressionCount ( int32  busIndex,
int16  channel 
) [pure virtual]

Returns number of supported note change types for event bus index and channel.

virtual tresult getNoteExpressionInfo ( int32  busIndex,
int16  channel,
int32  noteExpressionIndex,
NoteExpressionTypeInfo info 
) [pure virtual]

Returns note change type info.

virtual tresult getNoteExpressionStringByValue ( int32  busIndex,
int16  channel,
NoteExpressionTypeID  id,
NoteExpressionValue  valueNormalized,
String128  string 
) [pure virtual]

Gets a user readable representation of the normalized note change value.

virtual tresult getNoteExpressionValueByString ( int32  busIndex,
int16  channel,
NoteExpressionTypeID  id,
const TChar string,
NoteExpressionValue valueNormalized 
) [pure virtual]

Converts the user readable representation to the normalized note change value.


Field Documentation

const FUID iid [static]

Reimplemented from FUnknown.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.