AudioEffect Class Reference
[VST Implementation Helper Classes]

Default implementation for a VST 3 audio effect. More...

#include <vstaudioeffect.h>

Inheritance diagram for AudioEffect:
Inheritance graph
[legend]

Public Member Functions

 AudioEffect ()
 Constructor.
AudioBusaddAudioInput (const TChar *name, SpeakerArrangement arr, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
 Creates and adds a new Audio input bus with a given speaker arrangement, busType (kMain or kAux).
AudioBusaddAudioOutput (const TChar *name, SpeakerArrangement arr, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
 Creates and adds a new Audio output bus with a given speaker arrangement, busType (kMain or kAux).
AudioBusgetAudioInput (int32 index)
 Retrieves an Audio Input Bus by index.
AudioBusgetAudioOutput (int32 index)
 Retrieves an Audio Output Bus by index.
EventBusaddEventInput (const TChar *name, int32 channels=16, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
 Creates and adds a new Event input bus with a given speaker arrangement, busType (kMain or kAux).
EventBusaddEventOutput (const TChar *name, int32 channels=16, BusType busType=kMain, int32 flags=BusInfo::kDefaultActive)
 Creates and adds a new Event output bus with a given speaker arrangement, busType (kMain or kAux).
EventBusgetEventInput (int32 index)
 Retrieves an Event Input Bus by index.
EventBusgetEventOutput (int32 index)
 Retrieves an Event Output Bus by index.
tresult setBusArrangements (SpeakerArrangement *inputs, int32 numIns, SpeakerArrangement *outputs, int32 numOuts)
tresult getBusArrangement (BusDirection dir, int32 busIndex, SpeakerArrangement &arr)
tresult canProcessSampleSize (int32 symbolicSampleSize)
uint32 getLatencySamples ()
tresult setupProcessing (ProcessSetup &setup)
tresult setProcessing (TBool state)
tresult process (ProcessData &data)
uint32 getTailSamples ()

Detailed Description

Default implementation for a VST 3 audio effect.

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


Constructor & Destructor Documentation

AudioEffect (  ) 

Constructor.


Member Function Documentation

AudioBus * addAudioInput ( const TChar name,
SpeakerArrangement  arr,
BusType  busType = kMain,
int32  flags = BusInfo::kDefaultActive 
)

Creates and adds a new Audio input bus with a given speaker arrangement, busType (kMain or kAux).

AudioBus * addAudioOutput ( const TChar name,
SpeakerArrangement  arr,
BusType  busType = kMain,
int32  flags = BusInfo::kDefaultActive 
)

Creates and adds a new Audio output bus with a given speaker arrangement, busType (kMain or kAux).

AudioBus * getAudioInput ( int32  index  ) 

Retrieves an Audio Input Bus by index.

AudioBus * getAudioOutput ( int32  index  ) 

Retrieves an Audio Output Bus by index.

EventBus * addEventInput ( const TChar name,
int32  channels = 16,
BusType  busType = kMain,
int32  flags = BusInfo::kDefaultActive 
)

Creates and adds a new Event input bus with a given speaker arrangement, busType (kMain or kAux).

EventBus * addEventOutput ( const TChar name,
int32  channels = 16,
BusType  busType = kMain,
int32  flags = BusInfo::kDefaultActive 
)

Creates and adds a new Event output bus with a given speaker arrangement, busType (kMain or kAux).

EventBus * getEventInput ( int32  index  ) 

Retrieves an Event Input Bus by index.

EventBus * getEventOutput ( int32  index  ) 

Retrieves an Event Output Bus by index.

tresult setBusArrangements ( SpeakerArrangement inputs,
int32  numIns,
SpeakerArrangement outputs,
int32  numOuts 
) [virtual]

Implements IAudioProcessor.

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

Implements IAudioProcessor.

tresult canProcessSampleSize ( int32  symbolicSampleSize  )  [virtual]

Implements IAudioProcessor.

uint32 getLatencySamples (  )  [inline, virtual]

Implements IAudioProcessor.

tresult setupProcessing ( ProcessSetup setup  )  [virtual]

Implements IAudioProcessor.

tresult setProcessing ( TBool  state  )  [virtual]

Implements IAudioProcessor.

tresult process ( ProcessData data  )  [virtual]

Implements IAudioProcessor.

uint32 getTailSamples (  )  [inline, virtual]

Implements IAudioProcessor.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

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