Steinberg::Vst::IComponent Class Reference

#include <ivstcomponent.h>

Inheritance diagram for Steinberg::Vst::IComponent:

Public Member Functions
virtual tresult PLUGIN_API	getControllerClassId (TUID classId)=0
virtual tresult PLUGIN_API	setIoMode (IoMode mode)=0
virtual int32 PLUGIN_API	getBusCount (MediaType type, BusDirection dir)=0
virtual tresult PLUGIN_API	getBusInfo (MediaType type, BusDirection dir, int32 index, BusInfo &bus)=0
virtual tresult PLUGIN_API	getRoutingInfo (RoutingInfo &inInfo, RoutingInfo &outInfo)=0
virtual tresult PLUGIN_API	activateBus (MediaType type, BusDirection dir, int32 index, TBool state)=0
virtual tresult PLUGIN_API	setActive (TBool state)=0
virtual tresult PLUGIN_API	setState (IBStream *state)=0
virtual tresult PLUGIN_API	getState (IBStream *state)=0
Public Member Functions inherited from Steinberg::IPluginBase
virtual tresult PLUGIN_API	initialize (FUnknown *context)=0
virtual tresult PLUGIN_API	terminate ()=0
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
virtual uint32 PLUGIN_API	addRef ()=0
virtual uint32 PLUGIN_API	release ()=0

Static Public Attributes
static const FUID	iid
Static Public Attributes inherited from Steinberg::IPluginBase
static const FUID	iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid

Detailed Description

Component base interface: Vst::IComponent

• [plug imp]
• [released: 3.0.0]
• [mandatory]

This is the basic interface for a VST component and must always be supported. It contains the common parts of any kind of processing class. The parts that are specific to a media type are defined in a separate interface. An implementation component must provide both the specific interface and IComponent.

See also

IPluginBase

Member Function Documentation

activateBus()

virtual tresult PLUGIN_API Steinberg::Vst::IComponent::activateBus ( MediaType type, BusDirection dir, int32 index, TBool state )

pure virtual

Called upon (de-)activating a bus in the host application. The plug-in should only processed an activated bus, the host could provide less see AudioBusBuffers in the process call (see IAudioProcessor::process) if last busses are not activated. An already activated bus does not need to be reactivated after a IAudioProcessor::setBusArrangements call.

Implemented in Steinberg::Vst::Component.

getBusCount()

virtual int32 PLUGIN_API Steinberg::Vst::IComponent::getBusCount ( MediaType type, BusDirection dir )

pure virtual

Called after the plug-in is initialized. See MediaTypes, BusDirections

Implemented in Steinberg::Vst::Component.

getBusInfo()

virtual tresult PLUGIN_API Steinberg::Vst::IComponent::getBusInfo ( MediaType type, BusDirection dir, int32 index, BusInfo & bus )

pure virtual

Called after the plug-in is initialized. See MediaTypes, BusDirections

Implemented in Steinberg::Vst::Component.

getControllerClassId()

virtual tresult PLUGIN_API Steinberg::Vst::IComponent::getControllerClassId ( TUID classId )

pure virtual

Called before initializing the component to get information about the controller class.

Implemented in Steinberg::Vst::Component.

getRoutingInfo()

virtual tresult PLUGIN_API Steinberg::Vst::IComponent::getRoutingInfo ( RoutingInfo & inInfo, RoutingInfo & outInfo )

pure virtual

Retrieves routing information (to be implemented when more than one regular input or output bus exists). The inInfo always refers to an input bus while the returned outInfo must refer to an output bus!

Implemented in Steinberg::Vst::Component.

getState()

virtual tresult PLUGIN_API Steinberg::Vst::IComponent::getState ( IBStream * state )

pure virtual

Retrieves complete state of component.

Implemented in Steinberg::Vst::Component.

setActive()

virtual tresult PLUGIN_API Steinberg::Vst::IComponent::setActive ( TBool state )

pure virtual

Activates / deactivates the component.

Implemented in Steinberg::Vst::Component.

setIoMode()

virtual tresult PLUGIN_API Steinberg::Vst::IComponent::setIoMode ( IoMode mode )

pure virtual

Called before 'initialize' to set the component usage (optional). See IoModes

Implemented in Steinberg::Vst::Component.

setState()

virtual tresult PLUGIN_API Steinberg::Vst::IComponent::setState ( IBStream * state )

pure virtual

Sets complete state of component.

Implemented in Steinberg::Vst::Component.

Member Data Documentation

iid

const FUID Steinberg::Vst::IComponent::iid

static

---

The documentation for this class was generated from the following file:

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/pluginterfaces/vst/ivstcomponent.h