Steinberg::Vst::Component Class Reference

#include <vstcomponent.h>

Inheritance diagram for Steinberg::Vst::Component:


Public Member Functions
	Component ()
void	setControllerClass (const FUID &cid)
tresult	removeAudioBusses ()
tresult	removeEventBusses ()
tresult PLUGIN_API	getControllerClassId (TUID classID)
tresult PLUGIN_API	setIoMode (IoMode mode)
int32 PLUGIN_API	getBusCount (MediaType type, BusDirection dir)
tresult PLUGIN_API	getBusInfo (MediaType type, BusDirection dir, int32 index, BusInfo &info)
tresult PLUGIN_API	getRoutingInfo (RoutingInfo &inInfo, RoutingInfo &outInfo)
tresult PLUGIN_API	activateBus (MediaType type, BusDirection dir, int32 index, TBool state)
tresult PLUGIN_API	setActive (TBool state)
tresult PLUGIN_API	setState (IBStream *state)
tresult PLUGIN_API	getState (IBStream *state)
tresult PLUGIN_API	queryInterface (const char iid, void *obj)
tresult PLUGIN_API	initialize (FUnknown *context)
tresult PLUGIN_API	terminate ()
Protected Member Functions
BusList *	getBusList (MediaType type, BusDirection dir)
tresult	removeAllBusses ()
Protected Attributes
FUID	controllerClass
BusList	audioInputs
BusList	audioOutputs
BusList	eventInputs
BusList	eventOutputs

Detailed Description

Basic Component Implementation.

Definition at line 122 of file vstcomponent.h.

Constructor & Destructor Documentation

Steinberg::Vst::Component::Component ( )

Constructor

Definition at line 88 of file vstcomponent.cpp.

Member Function Documentation

tresult PLUGIN_API Steinberg::Vst::Component::activateBus	(	MediaType	type,
		BusDirection	dir,
		int32	index,
		TBool	state
	)			`[virtual]`

Called upon (de-)activating a bus in the host application.

Implements Steinberg::Vst::IComponent.

Definition at line 200 of file vstcomponent.cpp.

int32 PLUGIN_API Steinberg::Vst::Component::getBusCount	(	MediaType	type,
		BusDirection	dir
	)			`[virtual]`

Called after the plug-in is initialized.

Implements Steinberg::Vst::IComponent.

Definition at line 172 of file vstcomponent.cpp.

tresult PLUGIN_API Steinberg::Vst::Component::getBusInfo	(	MediaType	type,
		BusDirection	dir,
		int32	index,
		BusInfo &	info
	)			`[virtual]`

Called after the plug-in is initialized.

Implements Steinberg::Vst::IComponent.

Definition at line 179 of file vstcomponent.cpp.

BusList * Steinberg::Vst::Component::getBusList	(	MediaType	type,
		BusDirection	dir
	)			`[protected]`

Definition at line 118 of file vstcomponent.cpp.

tresult PLUGIN_API Steinberg::Vst::Component::getControllerClassId ( TUID classID ) [virtual]

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

Implements Steinberg::Vst::IComponent.

Definition at line 155 of file vstcomponent.cpp.

tresult PLUGIN_API Steinberg::Vst::Component::getRoutingInfo	(	RoutingInfo &	inInfo,
		RoutingInfo &	outInfo
	)			`[virtual]`

Retrieve routing information (optional).

Implements Steinberg::Vst::IComponent.

Definition at line 194 of file vstcomponent.cpp.

tresult PLUGIN_API Steinberg::Vst::Component::getState ( IBStream * state ) [virtual]

Retrieve complete state of component.

Implements Steinberg::Vst::IComponent.

Definition at line 225 of file vstcomponent.cpp.

tresult PLUGIN_API Steinberg::Vst::Component::initialize ( FUnknown * context ) [virtual]

The host passes a number of interfaces as context to initialize the plugin class.

Note:: Extensive memory allocations etc. should be performed in this method rather than in the class constructor! If the method does NOT return kResultOk, the object is released immediately. In this case terminate is not called!

Reimplemented from Steinberg::Vst::ComponentBase.

Definition at line 103 of file vstcomponent.cpp.

tresult PLUGIN_API Steinberg::Vst::Component::queryInterface	(	const char *	iid,
		void **	obj
	)			`[virtual]`

Query for a pointer to the specified interface. Returns kResultOk on success or kNoInterface if the object does not implement the interface. The object has to call addRef when returning an interface.

Parameters:

	iid	: (in) 16 Byte interface identifier (-> FUID)
	obj	: (out) On return, *obj point to the requested interface

Implements Steinberg::FUnknown.

Reimplemented in Steinberg::Vst::AudioEffect.

Definition at line 96 of file vstcomponent.cpp.

tresult Steinberg::Vst::Component::removeAllBusses ( ) [protected]

Definition at line 146 of file vstcomponent.cpp.

tresult Steinberg::Vst::Component::removeAudioBusses ( )

Removes all Audio Busses

Definition at line 128 of file vstcomponent.cpp.

tresult Steinberg::Vst::Component::removeEventBusses ( )

Removes all Event Busses

Definition at line 137 of file vstcomponent.cpp.

tresult PLUGIN_API Steinberg::Vst::Component::setActive ( TBool state ) [virtual]

Activate / deactivate the component.

Implements Steinberg::Vst::IComponent.

Reimplemented in AGain.

Definition at line 213 of file vstcomponent.cpp.

void Steinberg::Vst::Component::setControllerClass ( const FUID & cid ) [inline]

Sets the controller Class ID associated to tis component.

Definition at line 132 of file vstcomponent.h.

tresult PLUGIN_API Steinberg::Vst::Component::setIoMode ( IoMode mode ) [virtual]

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

Implements Steinberg::Vst::IComponent.

Definition at line 166 of file vstcomponent.cpp.

tresult PLUGIN_API Steinberg::Vst::Component::setState ( IBStream * state ) [virtual]

Set complete state of component.

Implements Steinberg::Vst::IComponent.

Definition at line 219 of file vstcomponent.cpp.

tresult PLUGIN_API Steinberg::Vst::Component::terminate ( ) [virtual]

This function is called, before the plugin is unloaded and can be used for cleanups. You have to release all references to any host application interfaces.

Reimplemented from Steinberg::Vst::ComponentBase.

Reimplemented in AGain.

Definition at line 109 of file vstcomponent.cpp.