VST 3 SDK  VST 3.6.5
SDK for developing VST Plug-in
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Public Member Functions | Data Fields
Component Class Reference

Default implementation for a VST 3 Component. More...

#include <vstcomponent.h>

+ Inheritance diagram for Component:

Public Member Functions

 Component ()
 Constructor. More...
 
void setControllerClass (const FUID &cid)
 Sets the controller Class ID associated to its component. More...
 
tresult removeAudioBusses ()
 Removes all Audio Buses. More...
 
tresult removeEventBusses ()
 Removes all Event Buses. More...
 
tresult renameBus (MediaType type, BusDirection dir, int32 index, const String128 newName)
 Renames a specific bus. More...
 
tresult getControllerClassId (TUID classID)
 
tresult setIoMode (IoMode mode)
 
int32 getBusCount (MediaType type, BusDirection dir)
 
tresult getBusInfo (MediaType type, BusDirection dir, int32 index, BusInfo &info)
 
tresult getRoutingInfo (RoutingInfo &inInfo, RoutingInfo &outInfo)
 
tresult activateBus (MediaType type, BusDirection dir, int32 index, TBool state)
 
tresult setActive (TBool state)
 
tresult setState (IBStream *state)
 
tresult getState (IBStream *state)
 
tresult initialize (FUnknown *context)
 
tresult terminate ()
 
BusListgetBusList (MediaType type, BusDirection dir)
 
tresult removeAllBusses ()
 
- Public Member Functions inherited from ComponentBase
 ComponentBase ()
 
virtual ~ComponentBase ()
 
FUnknowngetHostContext ()
 Returns the hostContext (set by the host during initialize call). More...
 
IConnectionPointgetPeer ()
 Returns the peer for the messaging communication (you can only use IConnectionPoint::notify for communicate between peers, do not try to cast peerConnection. More...
 
IMessageallocateMessage ()
 Allocates a message instance (don't forget to release it). More...
 
tresult sendMessage (IMessage *message)
 Sends the given message to the peer. More...
 
tresult sendTextMessage (const char8 *text)
 Sends a simple text message to the peer (max 255 characters). More...
 
virtual tresult receiveText (const char8 *text)
 Receives a simple text message from the peer (max 255 characters). More...
 
tresult connect (IConnectionPoint *other)
 
tresult disconnect (IConnectionPoint *other)
 
tresult notify (IMessage *message)
 
- Public Member Functions inherited from FUnknown
virtual tresult queryInterface (const TUID _iid, void **obj)=0
 
virtual uint32 addRef ()=0
 
virtual uint32 release ()=0
 

Data Fields

OBJ_METHODS(Component,
ComponentBase)
DEFINE_INTERFACES
DEF_INTERFACE(IComponent)
END_DEFINE_INTERFACES(ComponentBase)
REFCOUNT_METHODS(ComponentBase)
protected BusList 
audioInputs
 
BusList audioOutputs
 
BusList eventInputs
 
BusList eventOutputs
 
- Data Fields inherited from ComponentBase
OBJ_METHODS(ComponentBase,
FObject) DEFINE_INTERFACES
DEF_INTERFACE(IPluginBase)
DEF_INTERFACE(IConnectionPoint)
END_DEFINE_INTERFACES(FObject)
REFCOUNT_METHODS(FObject)
protected IConnectionPoint
peerConnection
 

Additional Inherited Members

- 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 IComponent
static const FUID iid
 

Detailed Description

Default implementation for a VST 3 Component.

Can be used as base class for a VST 3 component implementation.

Constructor & Destructor Documentation

Component ( )

Constructor.

Member Function Documentation

void setControllerClass ( const FUID cid)
inline

Sets the controller Class ID associated to its component.

tresult removeAudioBusses ( )

Removes all Audio Buses.

tresult removeEventBusses ( )

Removes all Event Buses.

tresult renameBus ( MediaType  type,
BusDirection  dir,
int32  index,
const String128  newName 
)

Renames a specific bus.

Do not forget to inform the host about this (see IComponentHandler::restartComponent (kIoTitlesChanged)).

tresult getControllerClassId ( TUID  classID)
virtual

Implements IComponent.

tresult setIoMode ( IoMode  mode)
virtual

Implements IComponent.

int32 getBusCount ( MediaType  type,
BusDirection  dir 
)
virtual

Implements IComponent.

tresult getBusInfo ( MediaType  type,
BusDirection  dir,
int32  index,
BusInfo info 
)
virtual

Implements IComponent.

tresult getRoutingInfo ( RoutingInfo inInfo,
RoutingInfo outInfo 
)
virtual

Implements IComponent.

tresult activateBus ( MediaType  type,
BusDirection  dir,
int32  index,
TBool  state 
)
virtual

Implements IComponent.

tresult setActive ( TBool  state)
virtual

Implements IComponent.

tresult setState ( IBStream state)
virtual

Implements IComponent.

tresult getState ( IBStream state)
virtual

Implements IComponent.

tresult initialize ( FUnknown context)
virtual

Reimplemented from ComponentBase.

tresult terminate ( )
virtual

Reimplemented from ComponentBase.

BusList * getBusList ( MediaType  type,
BusDirection  dir 
)
tresult removeAllBusses ( )

Field Documentation

OBJ_METHODS (Component, ComponentBase) DEFINE_INTERFACES DEF_INTERFACE (IComponent) END_DEFINE_INTERFACES (ComponentBase) REFCOUNT_METHODS(ComponentBase) protected BusList audioInputs
BusList audioOutputs
BusList eventInputs
BusList eventOutputs
Empty

Copyright ©2015 Steinberg Media Technologies GmbH. All Rights Reserved.