Steinberg::Vst::AudioEffect Class Reference

#include <vstaudioeffect.h>

Inheritance diagram for Steinberg::Vst::AudioEffect:


Public Member Functions
	AudioEffect ()
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 PLUGIN_API	setBusArrangements (SpeakerArrangement inputs, int32 numIns, SpeakerArrangement outputs, int32 numOuts)
tresult PLUGIN_API	getBusArrangement (BusDirection dir, int32 busIndex, SpeakerArrangement &arr)
tresult PLUGIN_API	canProcessSampleSize (int32 symbolicSampleSize)
uint32 PLUGIN_API	getLatencySamples ()
tresult PLUGIN_API	setupProcessing (ProcessSetup &setup)
tresult PLUGIN_API	setProcessing (TBool state)
tresult PLUGIN_API	process (ProcessData &data)
uint32 PLUGIN_API	getTailSamples ()
tresult PLUGIN_API	queryInterface (const char iid, void *obj)
Protected Attributes
ProcessSetup	processSetup

Detailed Description

Definition at line 72 of file vstaudioeffect.h.

Constructor & Destructor Documentation

Steinberg::Vst::AudioEffect::AudioEffect ( )

Constructor

Definition at line 59 of file vstaudioeffect.cpp.

Member Function Documentation

AudioBus * Steinberg::Vst::AudioEffect::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).

Definition at line 75 of file vstaudioeffect.cpp.

AudioBus * Steinberg::Vst::AudioEffect::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).

Definition at line 84 of file vstaudioeffect.cpp.

EventBus * Steinberg::Vst::AudioEffect::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).

Definition at line 93 of file vstaudioeffect.cpp.

EventBus * Steinberg::Vst::AudioEffect::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).

Definition at line 102 of file vstaudioeffect.cpp.

tresult PLUGIN_API Steinberg::Vst::AudioEffect::canProcessSampleSize ( int32 symbolicSampleSize ) [virtual]

Implements Steinberg::Vst::IAudioProcessor.

Definition at line 161 of file vstaudioeffect.cpp.

tresult PLUGIN_API Steinberg::Vst::AudioEffect::getBusArrangement	(	BusDirection	dir,
		int32	busIndex,
		SpeakerArrangement &	arr
	)			`[virtual]`

Implements Steinberg::Vst::IAudioProcessor.

Definition at line 132 of file vstaudioeffect.cpp.

uint32 PLUGIN_API Steinberg::Vst::AudioEffect::getLatencySamples ( ) [inline, virtual]

Implements Steinberg::Vst::IAudioProcessor.

Definition at line 101 of file vstaudioeffect.h.

uint32 PLUGIN_API Steinberg::Vst::AudioEffect::getTailSamples ( ) [inline, virtual]

Implements Steinberg::Vst::IAudioProcessor.

Definition at line 105 of file vstaudioeffect.h.

tresult PLUGIN_API Steinberg::Vst::AudioEffect::process ( ProcessData & data ) [virtual]

Implements Steinberg::Vst::IAudioProcessor.

Reimplemented in AGain.

Definition at line 167 of file vstaudioeffect.cpp.

tresult PLUGIN_API Steinberg::Vst::AudioEffect::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

Reimplemented from Steinberg::Vst::Component.

Definition at line 68 of file vstaudioeffect.cpp.

tresult PLUGIN_API Steinberg::Vst::AudioEffect::setBusArrangements	(	SpeakerArrangement *	inputs,
		int32	numIns,
		SpeakerArrangement *	outputs,
		int32	numOuts
	)			`[virtual]`