Steinberg::Vst::INoteExpressionController Class Reference

#include <ivstnoteexpression.h>

Inheritance diagram for Steinberg::Vst::INoteExpressionController:

Public Member Functions
virtual int32 PLUGIN_API	getNoteExpressionCount (int32 busIndex, int16 channel)=0
virtual tresult PLUGIN_API	getNoteExpressionInfo (int32 busIndex, int16 channel, int32 noteExpressionIndex, NoteExpressionTypeInfo &info)=0
virtual tresult PLUGIN_API	getNoteExpressionStringByValue (int32 busIndex, int16 channel, NoteExpressionTypeID id, NoteExpressionValue valueNormalized, String128 string)=0
virtual tresult PLUGIN_API	getNoteExpressionValueByString (int32 busIndex, int16 channel, NoteExpressionTypeID id, const TChar *string, NoteExpressionValue &valueNormalized)=0
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
virtual uint32 PLUGIN_API	addRef ()=0
virtual uint32 PLUGIN_API	release ()=0

Static Public Attributes
static const FUID	iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid

Detailed Description

Extended plug-in interface IEditController for note expression event support: Vst::INoteExpressionController

• [plug imp]
• [extends IEditController]
• [released: 3.5.0]
• [optional]

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 (for example when switching presets) the plug-in needs to inform the host about it via IComponentHandler::restartComponent (kNoteExpressionChanged).

Member Function Documentation

getNoteExpressionCount()

virtual int32 PLUGIN_API Steinberg::Vst::INoteExpressionController::getNoteExpressionCount ( int32 busIndex, int16 channel )

pure virtual

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

getNoteExpressionInfo()

virtual tresult PLUGIN_API Steinberg::Vst::INoteExpressionController::getNoteExpressionInfo ( int32 busIndex, int16 channel, int32 noteExpressionIndex, NoteExpressionTypeInfo & info )

pure virtual

Returns note change type info.

getNoteExpressionStringByValue()

virtual tresult PLUGIN_API Steinberg::Vst::INoteExpressionController::getNoteExpressionStringByValue ( int32 busIndex, int16 channel, NoteExpressionTypeID id, NoteExpressionValue valueNormalized, String128 string )

pure virtual

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

getNoteExpressionValueByString()

virtual tresult PLUGIN_API Steinberg::Vst::INoteExpressionController::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.

Member Data Documentation

iid

const FUID Steinberg::Vst::INoteExpressionController::iid

static

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/pluginterfaces/vst/ivstnoteexpression.h