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

#include <mdaBaseController.h>

+ Inheritance diagram for BaseController:

Public Types

enum  {
  kMagicNumber = 9999999 , kBypassParam = 'bpas' , kPresetParam = 'prst' , kModWheelParam = 'modw' ,
  kBreathParam = 'brth' , kCtrler3Param = 'ct03' , kExpressionParam = 'expr' , kPitchBendParam = 'pitb' ,
  kSustainParam = 'sust' , kAftertouchParam = 'aftt'
}
 
- 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

 BaseController ()
 
tresult initialize (FUnknown *context) SMTG_OVERRIDE
 
tresult setComponentState (IBStream *state) SMTG_OVERRIDE
 
tresult notify (IMessage *message) 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 getMidiControllerAssignment (int32 busIndex, int16 channel, CtrlNumber midiControllerNumber, ParamID &tag) SMTG_OVERRIDE
 
ParameterContainergetParameters ()
 
 DELEGATE_REFCOUNT (EditControllerEx1) tresult queryInterface(const char *iid
 
- 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 getMidiControllerAssignment (int32 busIndex, int16 channel, CtrlNumber midiControllerNumber, ParamID &id)=0
 

Public Attributes

void **obj SMTG_OVERRIDE
 
- 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

static const TChar kMicroSecondsString [] = {0x00b5, 0x0073, 0x0}
 
- 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 IMidiMapping
static const FUID iid
 

Protected Member Functions

double getSampleRate () const
 

Protected Attributes

int32 midiCCParamID [kCountCtrlNumber]
 
double sampleRate
 
bool addBypassParameter
 

Additional Inherited Members

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kMagicNumber 
kBypassParam 
kPresetParam 
kModWheelParam 
kBreathParam 
kCtrler3Param 
kExpressionParam 
kPitchBendParam 
kSustainParam 
kAftertouchParam 

Constructor & Destructor Documentation

◆ BaseController()

Member Function Documentation

◆ initialize()

◆ setComponentState()

tresult setComponentState ( IBStream state)
virtual

Reimplemented from EditController.

◆ notify()

tresult notify ( IMessage message)
virtual

Reimplemented from ComponentBase.

◆ getProgramListCount()

int32 getProgramListCount ( )
virtual

Reimplemented from EditControllerEx1.

◆ getProgramListInfo()

tresult getProgramListInfo ( int32  listIndex,
ProgramListInfo info 
)
virtual

Reimplemented from EditControllerEx1.

◆ getProgramName()

tresult getProgramName ( ProgramListID  listId,
int32  programIndex,
String128  name 
)
virtual

Reimplemented from EditControllerEx1.

◆ getMidiControllerAssignment()

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

Implements IMidiMapping.

◆ getParameters()

ParameterContainer & getParameters ( )
inline

◆ DELEGATE_REFCOUNT()

DELEGATE_REFCOUNT ( EditControllerEx1  ) const

◆ getSampleRate()

double getSampleRate ( ) const
inlineprotected

Member Data Documentation

◆ SMTG_OVERRIDE

void** obj SMTG_OVERRIDE

◆ kMicroSecondsString

const TChar kMicroSecondsString = {0x00b5, 0x0073, 0x0}
static

◆ midiCCParamID

int32 midiCCParamID[kCountCtrlNumber]
protected

◆ sampleRate

double sampleRate
protected

◆ addBypassParameter

bool addBypassParameter
protected
Empty

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