VST 3 Examples  VST 3.7
SDK for developing VST plug-in
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
ControllerWithUI Class Reference

Example Note Expression Audio Controller + User Interface. More...

#include <note_expression_synth_ui.h>

+ Inheritance diagram for ControllerWithUI:

Public Types

using UTF8StringPtr = VSTGUI::UTF8StringPtr
 
using IController = VSTGUI::IController
 
using IUIDescription = VSTGUI::IUIDescription
 
using VST3Editor = VSTGUI::VST3Editor
 
- Public Types inherited from Controller
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
 
IPlugViewcreateView (FIDString name) SMTG_OVERRIDE
 
tresult setState (IBStream *state) SMTG_OVERRIDE
 
tresult getState (IBStream *state) SMTG_OVERRIDE
 
tresult beginEdit (ParamID tag) SMTG_OVERRIDE
 
tresult performEdit (ParamID tag, ParamValue valueNormalized) SMTG_OVERRIDE
 
tresult endEdit (ParamID tag) SMTG_OVERRIDE
 
tresult onLiveMIDIControllerInput (int32 busIndex, int16 channel, CtrlNumber midiCC) SMTG_OVERRIDE
 
IControllercreateSubController (UTF8StringPtr name, const IUIDescription *description, VST3Editor *editor) SMTG_OVERRIDE
 
bool isPrivateParameter (const ParamID paramID) SMTG_OVERRIDE
 
- Public Member Functions inherited from Controller
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 ()
 
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
 
tresult setKnobMode (KnobMode mode) SMTG_OVERRIDE
 
tresult openHelp (TBool) SMTG_OVERRIDE
 
tresult openAboutBox (TBool) SMTG_OVERRIDE
 
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
 

Static Public Member Functions

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

Public Attributes

DEFINE_INTERFACES
DEF_INTERFACE(IMidiLearn)
END_DEFINE_INTERFACES(Controller)
REFCOUNT_METHODS(Controller)
private
VSTGUI::KeyboardViewRangeSelector::Range 
keyboardRange {}
 
ParamID midiLearnParamID {InvalidParamID}
 
bool doMIDILearn {false}
 
- Public Attributes inherited from Controller
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 IPtr
< IComponentHandler2
componentHandler2
 
ParameterContainer parameters
 

Static Public Attributes

static FUID cid
 
- Static Public Attributes inherited from Controller
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 IEditController
static const FUID iid
 
- 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 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
 
- Static Public Attributes inherited from IMidiLearn
static const FUID iid
 

Detailed Description

Example Note Expression Audio Controller + User Interface.

Member Typedef Documentation

using UTF8StringPtr = VSTGUI::UTF8StringPtr
using IController = VSTGUI::IController
using IUIDescription = VSTGUI::IUIDescription
using VST3Editor = VSTGUI::VST3Editor

Member Function Documentation

tresult initialize ( FUnknown context)
virtual

Reimplemented from Controller.

tresult terminate ( )
virtual

Reimplemented from Controller.

IPlugView * createView ( FIDString  name)
virtual

Reimplemented from EditController.

tresult setState ( IBStream state)
virtual

Reimplemented from EditController.

tresult getState ( IBStream state)
virtual

Reimplemented from EditController.

tresult beginEdit ( ParamID  tag)
virtual

Reimplemented from EditController.

tresult performEdit ( ParamID  tag,
ParamValue  valueNormalized 
)
virtual

Reimplemented from EditController.

tresult endEdit ( ParamID  tag)
virtual

Reimplemented from EditController.

tresult onLiveMIDIControllerInput ( int32  busIndex,
int16  channel,
CtrlNumber  midiCC 
)
virtual

Implements IMidiLearn.

IController * createSubController ( UTF8StringPtr  name,
const IUIDescription description,
VST3Editor editor 
)
bool isPrivateParameter ( const ParamID  paramID)
static FUnknown* createInstance ( void *  )
inlinestatic

Member Data Documentation

FUID cid
static
DEFINE_INTERFACES DEF_INTERFACE (IMidiLearn) END_DEFINE_INTERFACES (Controller) REFCOUNT_METHODS (Controller) private VSTGUI::KeyboardViewRangeSelector::Range keyboardRange {}
ParamID midiLearnParamID {InvalidParamID}
bool doMIDILearn {false}
Empty

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