SingleComponentEffect Class Reference
[VST Implementation Helper Classes]

Default implementation for a non-distributable Plug-in that combines processor and edit controller in one component. More...

#include <vstsinglecomponenteffect.h>

Inheritance diagram for SingleComponentEffect:
Inheritance graph
[legend]

Public Member Functions

 SingleComponentEffect ()
virtual ~SingleComponentEffect ()
tresult initialize (FUnknown *context)
tresult terminate ()
virtual tresult getControllerClassId (TUID classId)
virtual tresult setIoMode (IoMode mode)
virtual int32 getBusCount (MediaType type, BusDirection dir)
virtual tresult getBusInfo (MediaType type, BusDirection dir, int32 index, BusInfo &bus)
virtual tresult getRoutingInfo (RoutingInfo &inInfo, RoutingInfo &outInfo)
virtual tresult activateBus (MediaType type, BusDirection dir, int32 index, TBool state)
virtual tresult setActive (TBool state)
virtual tresult setState (IBStream *state)
virtual tresult getState (IBStream *state)
AudioBusaddAudioInput (const TChar *name, SpeakerArrangement arr, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
AudioBusaddAudioOutput (const TChar *name, SpeakerArrangement arr, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
EventBusaddEventInput (const TChar *name, int32 channels=16, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
EventBusaddEventOutput (const TChar *name, int32 channels=16, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
tresult removeAudioBusses ()
tresult removeEventBusses ()
tresult removeAllBusses ()
virtual tresult setBusArrangements (SpeakerArrangement *inputs, int32 numIns, SpeakerArrangement *outputs, int32 numOuts)
virtual tresult getBusArrangement (BusDirection dir, int32 index, SpeakerArrangement &arr)
virtual tresult canProcessSampleSize (int32 symbolicSampleSize)
virtual uint32 getLatencySamples ()
virtual tresult setupProcessing (ProcessSetup &setup)
virtual tresult setProcessing (TBool state)
virtual tresult process (ProcessData &data)
virtual uint32 getTailSamples ()
 OBJ_METHODS (SingleComponentEffect, EditController) tresult queryInterface(const TUID iid

Data Fields

void ** obj
REFCOUNT_METHODS(EditController)
protected ProcessSetup 
processSetup
BusList audioInputs
BusList audioOutputs
BusList eventInputs
BusList eventOutputs

Detailed Description

Default implementation for a non-distributable Plug-in that combines processor and edit controller in one component.

This can be used as base class for a VST 3 effect implementation in case that the standard way of defining two separate components would cause too many implementation difficulties:


Constructor & Destructor Documentation

~SingleComponentEffect (  )  [virtual]

Member Function Documentation

tresult initialize ( FUnknown context  )  [virtual]

Reimplemented from EditController.

tresult terminate (  )  [virtual]

Reimplemented from EditController.

virtual tresult getControllerClassId ( TUID  classId  )  [inline, virtual]

Implements IComponent.

virtual tresult setIoMode ( IoMode  mode  )  [inline, virtual]

Implements IComponent.

int32 getBusCount ( MediaType  type,
BusDirection  dir 
) [virtual]

Implements IComponent.

tresult getBusInfo ( MediaType  type,
BusDirection  dir,
int32  index,
BusInfo bus 
) [virtual]

Implements IComponent.

virtual tresult getRoutingInfo ( RoutingInfo inInfo,
RoutingInfo outInfo 
) [inline, virtual]

Implements IComponent.

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

Implements IComponent.

virtual tresult setActive ( TBool  state  )  [inline, virtual]

Implements IComponent.

virtual tresult setState ( IBStream state  )  [inline, virtual]

Implements IComponent.

virtual tresult getState ( IBStream state  )  [inline, virtual]

Implements IComponent.

AudioBus * addAudioInput ( const TChar name,
SpeakerArrangement  arr,
BusType  busType = kMain,
int32  flags = BusInfo::kDefaultActive 
)
AudioBus * addAudioOutput ( const TChar name,
SpeakerArrangement  arr,
BusType  busType = kMain,
int32  flags = BusInfo::kDefaultActive 
)
EventBus * addEventInput ( const TChar name,
int32  channels = 16,
BusType  busType = kMain,
int32  flags = BusInfo::kDefaultActive 
)
EventBus * addEventOutput ( const TChar name,
int32  channels = 16,
BusType  busType = kMain,
int32  flags = BusInfo::kDefaultActive 
)
tresult removeAudioBusses (  ) 
tresult removeEventBusses (  ) 
tresult removeAllBusses (  ) 
tresult setBusArrangements ( SpeakerArrangement inputs,
int32  numIns,
SpeakerArrangement outputs,
int32  numOuts 
) [virtual]

Implements IAudioProcessor.

tresult getBusArrangement ( BusDirection  dir,
int32  index,
SpeakerArrangement arr 
) [virtual]

Implements IAudioProcessor.

tresult canProcessSampleSize ( int32  symbolicSampleSize  )  [virtual]

Implements IAudioProcessor.

virtual uint32 getLatencySamples (  )  [inline, virtual]

Implements IAudioProcessor.

tresult setupProcessing ( ProcessSetup setup  )  [virtual]

Implements IAudioProcessor.

virtual tresult setProcessing ( TBool  state  )  [inline, virtual]

Implements IAudioProcessor.

virtual tresult process ( ProcessData data  )  [inline, virtual]

Implements IAudioProcessor.

virtual uint32 getTailSamples (  )  [inline, virtual]

Implements IAudioProcessor.

OBJ_METHODS ( SingleComponentEffect  ,
EditController   
) const

Field Documentation

void** obj
REFCOUNT_METHODS (EditController) protected ProcessSetup processSetup
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

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