Steinberg::Vst::IComponent Class Reference

#include <ivstcomponent.h>

Inheritance diagram for Steinberg::Vst::IComponent:

Steinberg::IPluginBase Steinberg::FUnknown Steinberg::Vst::Component Steinberg::Vst::AudioEffect AGain List of all members.

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

Static Public Attributes

static const FUID iid

Detailed Description

Component Base Interface [plug imp] IComponent describes a basic plug-in and must always be supported.

Definition at line 139 of file ivstcomponent.h.


Member Function Documentation

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.

Implemented in Steinberg::Vst::Component.

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

Called after the plug-in is initialized.

Implemented in Steinberg::Vst::Component.

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.

Implemented in Steinberg::Vst::Component.

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.

virtual tresult PLUGIN_API Steinberg::Vst::IComponent::getRoutingInfo ( RoutingInfo inInfo,
RoutingInfo outInfo 
) [pure virtual]

Retrieve routing information (optional).

Implemented in Steinberg::Vst::Component.

virtual tresult PLUGIN_API Steinberg::Vst::IComponent::getState ( IBStream state  )  [pure virtual]

Retrieve complete state of component.

Implemented in Steinberg::Vst::Component.

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

Activate / deactivate the component.

Implemented in Steinberg::Vst::Component, and AGain.

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

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

Implemented in Steinberg::Vst::Component.

virtual tresult PLUGIN_API Steinberg::Vst::IComponent::setState ( IBStream state  )  [pure virtual]

Set complete state of component.

Implemented in Steinberg::Vst::Component.


Member Data Documentation

const FUID Steinberg::Vst::IComponent::iid [static]

Reimplemented from Steinberg::IPluginBase.

Definition at line 171 of file ivstcomponent.h.


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

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.