VST 3 Examples VST 3.7
SDK for developing VST plug-in
PlugController Class Reference

#include <plugcontroller.h>

+ Inheritance diagram for PlugController:

Public Types

using CView = VSTGUI::CView
 
using CTextEdit = VSTGUI::CTextEdit
 
using UTF8StringPtr = VSTGUI::UTF8StringPtr
 
using UIAttributes = VSTGUI::UIAttributes
 
using IUIDescription = VSTGUI::IUIDescription
 
using VST3Editor = VSTGUI::VST3Editor
 
using CTextLabel = VSTGUI::CTextLabel
 
- Public Types inherited from EditControllerEx1
typedef (EditControllerEx1, EditController) DEFINE_INTERFACES DEF_INTERFACE(IUnitInfo) END_DEFINE_INTERFACES(EditController) REFCOUNT_METHODS(EditController) protected std::map< ProgramListID, ProgramListVector::size_type > ProgramIndexMap
 
typedef std::vector< IPtr< Unit > > UnitVector
 

Public Member Functions

tresult initialize (FUnknown *context) SMTG_OVERRIDE
 
tresult setComponentState (IBStream *state) SMTG_OVERRIDE
 
tresult setChannelContextInfos (IAttributeList *list) SMTG_OVERRIDE
 
tresult initialize (FUnknown *context) SMTG_OVERRIDE
 
tresult setComponentState (IBStream *state) SMTG_OVERRIDE
 
IPlugViewcreateView (const char *name) SMTG_OVERRIDE
 
CViewcreateCustomView (UTF8StringPtr name, const UIAttributes &attributes, const IUIDescription *description, VST3Editor *editor) SMTG_OVERRIDE
 
void willClose (VST3Editor *editor) SMTG_OVERRIDE
 
tresult notify (IMessage *message) SMTG_OVERRIDE
 
tresult receiveText (const char8 *text) 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 initialize (FUnknown *context) SMTG_OVERRIDE
 
tresult setComponentState (IBStream *state) SMTG_OVERRIDE
 
tresult setParamNormalized (ParamID tag, ParamValue value) SMTG_OVERRIDE
 
tresult initialize (FUnknown *context) SMTG_OVERRIDE
 
tresult setParamNormalized (ParamID tag, ParamValue value) SMTG_OVERRIDE
 
tresult setComponentState (IBStream *state) SMTG_OVERRIDE
 
tresult getUnitByBus (MediaType, BusDirection, int32, int32, UnitID &) SMTG_OVERRIDE
 
- Public Member Functions inherited from EditControllerEx1
 EditControllerEx1 ()
 
 ~EditControllerEx1 () override
 
tresult terminate () SMTG_OVERRIDE
 
bool addUnit (Unit *unit)
 
bool addProgramList (ProgramList *list)
 
ProgramListgetProgramList (ProgramListID listId) const
 
tresult notifyProgramListChange (ProgramListID listId, int32 programIndex=kAllProgramInvalid)
 
int32 getUnitCount () SMTG_OVERRIDE
 
tresult getUnitInfo (int32 unitIndex, UnitInfo &info) SMTG_OVERRIDE
 
int32 getProgramListCount () SMTG_OVERRIDE
 
tresult getProgramListInfo (int32 listIndex, ProgramListInfo &info) SMTG_OVERRIDE
 
tresult getProgramName (ProgramListID listId, int32 programIndex, String128 name) SMTG_OVERRIDE
 
tresult getProgramInfo (ProgramListID listId, int32 programIndex, CString attributeId, String128 attributeValue) SMTG_OVERRIDE
 
tresult hasProgramPitchNames (ProgramListID listId, int32 programIndex) SMTG_OVERRIDE
 
tresult getProgramPitchName (ProgramListID listId, int32 programIndex, int16 midiPitch, String128 name) SMTG_OVERRIDE
 
virtual tresult setProgramName (ProgramListID listId, int32 programIndex, const String128 name)
 
UnitID getSelectedUnit () SMTG_OVERRIDE
 
tresult selectUnit (UnitID unitId) SMTG_OVERRIDE
 
tresult getUnitByBus (MediaType, BusDirection, int32, int32, UnitID &) SMTG_OVERRIDE
 
tresult setUnitProgramData (int32, int32, IBStream *) SMTG_OVERRIDE
 
virtual tresult notifyUnitSelection ()
 
void update (FUnknown *changedUnknown, int32 message) SMTG_OVERRIDE
 
- Public Member Functions inherited from EditController
 EditController ()
 
tresult setComponentState (IBStream *state) SMTG_OVERRIDE
 
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 setParamNormalized (ParamID tag, ParamValue value) 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
 
tresult initialize (FUnknown *context) SMTG_OVERRIDE
 
tresult terminate () 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 ComponentBase
 ComponentBase ()
 
 ~ComponentBase () override
 
FUnknowngetHostContext () const
 
IConnectionPointgetPeer () const
 
IMessageallocateMessage () const
 
tresult sendMessage (IMessage *message) const
 
tresult sendTextMessage (const char8 *text) const
 
tresult sendMessageID (const char8 *messageID) const
 
virtual tresult receiveText (const char8 *text)
 
tresult initialize (FUnknown *context) SMTG_OVERRIDE
 
tresult terminate () SMTG_OVERRIDE
 
tresult connect (IConnectionPoint *other) SMTG_OVERRIDE
 
tresult disconnect (IConnectionPoint *other) SMTG_OVERRIDE
 
tresult notify (IMessage *message) SMTG_OVERRIDE
 
virtual tresult initialize (FUnknown *context)=0
 
virtual tresult terminate ()=0
 
- Public Member Functions inherited from FUnknown
virtual tresult queryInterface (const TUID _iid, void **obj)=0
 
virtual uint32 addRef ()=0
 
virtual uint32 release ()=0
 
virtual tresult connect (IConnectionPoint *other)=0
 
virtual tresult disconnect (IConnectionPoint *other)=0
 
virtual tresult notify (IMessage *message)=0
 
virtual tresult setComponentState (IBStream *state)=0
 
virtual tresult setState (IBStream *state)=0
 
virtual tresult getState (IBStream *state)=0
 
virtual int32 getParameterCount ()=0
 
virtual tresult getParameterInfo (int32 paramIndex, ParameterInfo &info)=0
 
virtual tresult getParamStringByValue (ParamID id, ParamValue valueNormalized, String128 string)=0
 
virtual tresult getParamValueByString (ParamID id, TChar *string, ParamValue &valueNormalized)=0
 
virtual ParamValue normalizedParamToPlain (ParamID id, ParamValue valueNormalized)=0
 
virtual ParamValue plainParamToNormalized (ParamID id, ParamValue plainValue)=0
 
virtual ParamValue getParamNormalized (ParamID id)=0
 
virtual tresult setParamNormalized (ParamID id, ParamValue value)=0
 
virtual tresult setComponentHandler (IComponentHandler *handler)=0
 
virtual IPlugViewcreateView (FIDString name)=0
 
virtual tresult setKnobMode (KnobMode mode)=0
 
virtual tresult openHelp (TBool onlyCheck)=0
 
virtual tresult openAboutBox (TBool onlyCheck)=0
 
virtual int32 getUnitCount ()=0
 
virtual tresult getUnitInfo (int32 unitIndex, UnitInfo &info)=0
 
virtual int32 getProgramListCount ()=0
 
virtual tresult getProgramListInfo (int32 listIndex, ProgramListInfo &info)=0
 
virtual tresult getProgramName (ProgramListID listId, int32 programIndex, String128 name)=0
 
virtual tresult getProgramInfo (ProgramListID listId, int32 programIndex, CString attributeId, String128 attributeValue)=0
 
virtual tresult hasProgramPitchNames (ProgramListID listId, int32 programIndex)=0
 
virtual tresult getProgramPitchName (ProgramListID listId, int32 programIndex, int16 midiPitch, String128 name)=0
 
virtual UnitID getSelectedUnit ()=0
 
virtual tresult selectUnit (UnitID unitId)=0
 
virtual tresult getUnitByBus (MediaType type, BusDirection dir, int32 busIndex, int32 channel, UnitID &unitId)=0
 
virtual tresult setUnitProgramData (int32 listOrUnitId, int32 programIndex, IBStream *data)=0
 
virtual tresult setChannelContextInfos (IAttributeList *list)=0
 
virtual int32 getNoteExpressionCount (int32 busIndex, int16 channel)=0
 
virtual tresult getNoteExpressionInfo (int32 busIndex, int16 channel, int32 noteExpressionIndex, NoteExpressionTypeInfo &info)=0
 
virtual tresult getNoteExpressionStringByValue (int32 busIndex, int16 channel, NoteExpressionTypeID id, NoteExpressionValue valueNormalized, String128 string)=0
 
virtual tresult getNoteExpressionValueByString (int32 busIndex, int16 channel, NoteExpressionTypeID id, const TChar *string, NoteExpressionValue &valueNormalized)=0
 

Static Public Member Functions

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

Additional Inherited Members

- Public Attributes inherited from EditControllerEx1
UnitVector units
 
ProgramListVector programLists
 
ProgramIndexMap programIndexMap
 
UnitID selectedUnit
 
- 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< IComponentHandler2componentHandler2
 
ParameterContainer parameters
 
- Public Attributes inherited from ComponentBase
OBJ_METHODS(ComponentBase, FObject) DEFINE_INTERFACES DEF_INTERFACE(IPluginBase) DEF_INTERFACE(IConnectionPoint) END_DEFINE_INTERFACES(FObject) REFCOUNT_METHODS(FObject) protected IPtr< IConnectionPointpeerConnection
 
- 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 IUnitInfo
static const FUID iid
 
- Static Public Attributes inherited from IInfoListener
static const FUID iid
 
- Static Public Attributes inherited from INoteExpressionController
static const FUID iid
 

Member Typedef Documentation

◆ CView

using CView = VSTGUI::CView

◆ CTextEdit

using CTextEdit = VSTGUI::CTextEdit

◆ UTF8StringPtr

using UTF8StringPtr = VSTGUI::UTF8StringPtr

◆ UIAttributes

using UIAttributes = VSTGUI::UIAttributes

◆ IUIDescription

using IUIDescription = VSTGUI::IUIDescription

◆ VST3Editor

using VST3Editor = VSTGUI::VST3Editor

◆ CTextLabel

using CTextLabel = VSTGUI::CTextLabel

Member Function Documentation

◆ createInstance() [1/4]

static FUnknown * createInstance ( void *  )
inlinestatic

◆ initialize() [1/4]

tresult initialize ( FUnknown context)
virtual

Reimplemented from EditController.

◆ setComponentState() [1/4]

tresult setComponentState ( IBStream state)
virtual

Reimplemented from EditController.

◆ setChannelContextInfos()

tresult setChannelContextInfos ( IAttributeList list)
virtual

Implements IInfoListener.

◆ createInstance() [2/4]

static FUnknown * createInstance ( void *  )
inlinestatic

◆ initialize() [2/4]

tresult initialize ( FUnknown context)
virtual

Reimplemented from EditController.

◆ setComponentState() [2/4]

tresult setComponentState ( IBStream state)
virtual

Reimplemented from EditController.

◆ createView()

IPlugView * createView ( const char name)

◆ createCustomView()

CView * createCustomView ( UTF8StringPtr  name,
const UIAttributes attributes,
const IUIDescription description,
VST3Editor editor 
)

◆ willClose()

void willClose ( VST3Editor editor)

◆ notify()

tresult notify ( IMessage message)
virtual

Reimplemented from ComponentBase.

◆ receiveText()

tresult receiveText ( const char8 text)
virtual

Reimplemented from ComponentBase.

◆ getNoteExpressionCount()

int32 getNoteExpressionCount ( int32  busIndex,
int16  channel 
)
virtual

◆ getNoteExpressionInfo()

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

◆ getNoteExpressionStringByValue()

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

◆ getNoteExpressionValueByString()

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

◆ createInstance() [3/4]

static FUnknown * createInstance ( void *  )
inlinestatic

◆ initialize() [3/4]

tresult initialize ( FUnknown context)
virtual

Reimplemented from EditController.

◆ setComponentState() [3/4]

tresult setComponentState ( IBStream state)
virtual

Reimplemented from EditController.

◆ setParamNormalized() [1/2]

tresult setParamNormalized ( ParamID  tag,
ParamValue  value 
)
virtual

Reimplemented from EditController.

◆ createInstance() [4/4]

static FUnknown * createInstance ( void *  )
inlinestatic

◆ initialize() [4/4]

tresult initialize ( FUnknown context)
virtual

Reimplemented from EditController.

◆ setParamNormalized() [2/2]

tresult setParamNormalized ( ParamID  tag,
ParamValue  value 
)
virtual

Reimplemented from EditController.

◆ setComponentState() [4/4]

tresult setComponentState ( IBStream state)
virtual

Reimplemented from EditController.

◆ getUnitByBus()

tresult getUnitByBus ( MediaType  type,
BusDirection  dir,
int32  busIndex,
int32  channel,
UnitID unitId 
)
virtual

Reimplemented from EditControllerEx1.

Empty

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