VST 3 Examples  VST 3.6.14
SDK for developing VST Plug-in
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Controller Class Reference

Example Note Expression Edit Controller. More...

#include <note_expression_synth_controller.h>

+ Inheritance diagram for Controller:

Public Types

enum  NoteExpressionTypeIds {
  kNoiseVolumeTypeID = kCustomStart, kFilterFreqModTypeID, kFilterQModTypeID, kSinusVolumeTypeID,
  kTriangleVolumeTypeID, kFilterTypeTypeID, kTriangleSlopeTypeID, kSinusDetuneTypeID,
  kReleaseTimeModTypeID, kTextInputTypeID, kSquareVolumeTypeID
}
 

Public Member Functions

tresult initialize (FUnknown *context) SMTG_OVERRIDE
 
tresult terminate () SMTG_OVERRIDE
 
tresult setComponentState (IBStream *state) SMTG_OVERRIDE
 
tresult setParamNormalized (ParamID tag, ParamValue value) SMTG_OVERRIDE
 
tresult getMidiControllerAssignment (int32 busIndex, int16 channel, CtrlNumber midiControllerNumber, ParamID &id) SMTG_OVERRIDE
 
int32 getNoteExpressionCount (int32 busIndex, int16 channel) SMTG_OVERRIDE
 
tresult getNoteExpressionInfo (int32 busIndex, int16 channel, int32 noteExpressionIndex, NoteExpressionTypeInfo &info) SMTG_OVERRIDE
 
tresult getNoteExpressionStringByValue (int32 busIndex, int16 channel, NoteExpressionTypeID id, NoteExpressionValue valueNormalized, String128 string) SMTG_OVERRIDE
 
tresult getNoteExpressionValueByString (int32 busIndex, int16 channel, NoteExpressionTypeID id, const TChar *string, NoteExpressionValue &valueNormalized) SMTG_OVERRIDE
 
tresult getPhysicalUIMapping (int32 busIndex, int16 channel, PhysicalUIMapList &list) SMTG_OVERRIDE
 
- Public Member Functions inherited from EditController
 EditController ()
 
tresult setState (IBStream *state) SMTG_OVERRIDE
 
tresult getState (IBStream *state) SMTG_OVERRIDE
 
int32 getParameterCount () SMTG_OVERRIDE
 
tresult getParameterInfo (int32 paramIndex, ParameterInfo &info) SMTG_OVERRIDE
 
tresult getParamStringByValue (ParamID tag, ParamValue valueNormalized, String128 string) SMTG_OVERRIDE
 
tresult getParamValueByString (ParamID tag, TChar *string, ParamValue &valueNormalized) SMTG_OVERRIDE
 
ParamValue normalizedParamToPlain (ParamID tag, ParamValue valueNormalized) SMTG_OVERRIDE
 
ParamValue plainParamToNormalized (ParamID tag, ParamValue plainValue) SMTG_OVERRIDE
 
ParamValue getParamNormalized (ParamID tag) SMTG_OVERRIDE
 
tresult setComponentHandler (IComponentHandler *handler) SMTG_OVERRIDE
 
IPlugViewcreateView (FIDString) SMTG_OVERRIDE
 
tresult setKnobMode (KnobMode mode) SMTG_OVERRIDE
 
tresult openHelp (TBool) SMTG_OVERRIDE
 
tresult openAboutBox (TBool) SMTG_OVERRIDE
 
virtual tresult beginEdit (ParamID tag)
 
virtual tresult performEdit (ParamID tag, ParamValue valueNormalized)
 
virtual tresult endEdit (ParamID tag)
 
virtual tresult startGroupEdit ()
 
virtual tresult finishGroupEdit ()
 
virtual void editorDestroyed (EditorView *)
 
virtual void editorAttached (EditorView *)
 
virtual void editorRemoved (EditorView *)
 
virtual ParametergetParameterObject (ParamID tag)
 
virtual tresult getParameterInfoByTag (ParamID tag, ParameterInfo &info)
 
virtual tresult setDirty (TBool state)
 
virtual tresult requestOpenEditor (FIDString name=ViewType::kEditor)
 
IComponentHandlergetComponentHandler () const
 
- Public Member Functions inherited from FUnknown
virtual tresult queryInterface (const TUID _iid, void **obj)=0
 
virtual uint32 addRef ()=0
 
virtual uint32 release ()=0
 
- Public Member Functions inherited from IConnectionPoint
virtual tresult connect (IConnectionPoint *other)=0
 
virtual tresult disconnect (IConnectionPoint *other)=0
 
virtual tresult notify (IMessage *message)=0
 

Static Public Member Functions

static FUnknowncreateInstance (void *)
 
- Static Public Member Functions inherited from EditController
static KnobMode getHostKnobMode ()
 

Public Attributes

std::array< ParamID,
ControllerNumbers::kCountCtrlNumber
midiCCMapping
 
- Public Attributes inherited from EditController
OBJ_METHODS(EditController,
ComponentBase)
DEFINE_INTERFACES
DEF_INTERFACE(IEditController)
DEF_INTERFACE(IEditController2)
END_DEFINE_INTERFACES(ComponentBase)
REFCOUNT_METHODS(ComponentBase)
protected IComponentHandler2
componentHandler2
 
ParameterContainer parameters
 

Static Public Attributes

static FUID cid
 
static OBJ_METHODS(Controller,
EditController)
DEFINE_INTERFACES
DEF_INTERFACE(INoteExpressionController)
DEF_INTERFACE(IMidiMapping)
DEF_INTERFACE(INoteExpressionPhysicalUIMapping)
END_DEFINE_INTERFACES(EditController)
REFCOUNT_METHODS(EditController)
protected constexpr ParamID 
InvalidParamID = std::numeric_limits<ParamID>::max ()
 
- Static Public Attributes inherited from EditController
static KnobMode hostKnobMode
 
- Static Public Attributes inherited from IPluginBase
static const FUID iid
 
- Static Public Attributes inherited from FUnknown
static const FUID iid
 
- Static Public Attributes inherited from IConnectionPoint
static const FUID iid
 
- Static Public Attributes inherited from IEditController
static const FUID iid
 
- Static Public Attributes inherited from IEditController2
static const FUID iid
 
- Static Public Attributes inherited from INoteExpressionController
static const FUID iid
 
- Static Public Attributes inherited from IMidiMapping
static const FUID iid
 
- Static Public Attributes inherited from INoteExpressionPhysicalUIMapping
static const FUID iid
 

Detailed Description

Member Enumeration Documentation

Enumerator
kNoiseVolumeTypeID 
kFilterFreqModTypeID 
kFilterQModTypeID 
kSinusVolumeTypeID 
kTriangleVolumeTypeID 
kFilterTypeTypeID 
kTriangleSlopeTypeID 
kSinusDetuneTypeID 
kReleaseTimeModTypeID 
kTextInputTypeID 
kSquareVolumeTypeID 

Member Function Documentation

tresult initialize ( FUnknown context)
virtual

Reimplemented from EditController.

Reimplemented in ControllerWithUI.

tresult terminate ( )
virtual

Reimplemented from EditController.

Reimplemented in ControllerWithUI.

tresult setComponentState ( IBStream state)
virtual

Reimplemented from EditController.

tresult setParamNormalized ( ParamID  tag,
ParamValue  value 
)
virtual

Reimplemented from EditController.

tresult getMidiControllerAssignment ( int32  busIndex,
int16  channel,
CtrlNumber  midiControllerNumber,
ParamID id 
)
virtual

Implements IMidiMapping.

int32 getNoteExpressionCount ( int32  busIndex,
int16  channel 
)
virtual
tresult getNoteExpressionInfo ( int32  busIndex,
int16  channel,
int32  noteExpressionIndex,
NoteExpressionTypeInfo info 
)
virtual
tresult getNoteExpressionStringByValue ( int32  busIndex,
int16  channel,
NoteExpressionTypeID  id,
NoteExpressionValue  valueNormalized,
String128  string 
)
virtual
tresult getNoteExpressionValueByString ( int32  busIndex,
int16  channel,
NoteExpressionTypeID  id,
const TChar string,
NoteExpressionValue valueNormalized 
)
virtual
tresult getPhysicalUIMapping ( int32  busIndex,
int16  channel,
PhysicalUIMapList list 
)
virtual
static FUnknown* createInstance ( void *  )
inlinestatic

Member Data Documentation

FUID cid
static
OBJ_METHODS (Controller, EditController) DEFINE_INTERFACES DEF_INTERFACE (INoteExpressionController) DEF_INTERFACE (IMidiMapping) DEF_INTERFACE (INoteExpressionPhysicalUIMapping) END_DEFINE_INTERFACES (EditController) REFCOUNT_METHODS (EditController) protected constexpr ParamID InvalidParamID = std::numeric_limits<ParamID>::max ()
static
std::array<ParamID, ControllerNumbers::kCountCtrlNumber> midiCCMapping
Empty

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