Description of an Audio Bus. More...

#include "vstbus.h"

Inheritance diagram for Steinberg::Vst::AudioBus:

Public Member Functions
	AudioBus (const TChar *name, BusType busType, int32 flags, SpeakerArrangement arr)

SpeakerArrangement	getArrangement () const
	Gets the speaker arrangement defining this Audio bus.

void	setArrangement (const SpeakerArrangement &arr)
	Sets the speaker arrangement defining this Audio bus.

bool	getInfo (BusInfo &info) SMTG_OVERRIDE
	Gets the BusInfo associated to this Audio bus.

Public Member Functions inherited from Steinberg::Vst::Bus
	Bus (const TChar *name, BusType busType, int32 flags)
	Constructor.

TBool	isActive () const
	Returns true if the bus is active.

void	setActive (TBool state)
	Activates the bus.

void	setName (const std::u16string &newName)
	Sets a new name for this bus.

void	setBusType (BusType newBusType)
	Sets a new busType for this bus.

void	setFlags (uint32 newFlags)
	Sets a new flags for this bus.

Public Member Functions inherited from Steinberg::FObject
	FObject ()=default
	default constructor...

	FObject (const FObject &)

FObject &	operator= (const FObject &)
	overloads operator "=" as the reference assignment

virtual	~FObject ()
	destructor...

virtual FClassID	isA () const
	a local alternative to getFClassID ()

virtual bool	isA (FClassID s) const
	evaluates if the passed ID is of the FObject type

virtual bool	isTypeOf (FClassID s, bool=true) const
	evaluates if the passed ID is of the FObject type

int32	getRefCount ()
	returns the current interface reference count

FUnknown *	unknownCast ()
	get FUnknown interface from object

tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj) SMTG_OVERRIDE
	please refer to FUnknown::queryInterface ()

uint32 PLUGIN_API	addRef () SMTG_OVERRIDE
	please refer to FUnknown::addref ()

uint32 PLUGIN_API	release () SMTG_OVERRIDE
	please refer to FUnknown::release ()

void PLUGIN_API	update (FUnknown *, int32) SMTG_OVERRIDE
	empty virtual method that should be overridden by derived classes for data updates upon changes

virtual void	addDependent (IDependent *dep)
	adds dependency to the object

virtual void	removeDependent (IDependent *dep)
	removes dependency from the object

virtual void	changed (int32 msg=kChanged)
	Inform all dependents, that the object has changed.

virtual void	deferUpdate (int32 msg=kChanged)
	Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates).

virtual void	updateDone (int32)
	empty virtual method that should be overridden by derived classes

virtual bool	isEqualInstance (FUnknown *d)

Protected Attributes
SpeakerArrangement	speakerArr

Protected Attributes inherited from Steinberg::Vst::Bus
std::u16string	name
	name

BusType	busType
	kMain or kAux, see BusTypes

int32	flags
	flags, see BusInfo::BusFlags

TBool	active
	activation state

Protected Attributes inherited from Steinberg::FObject
int32	refCount
	COM-model local reference count.

Additional Inherited Members
Public Types inherited from Steinberg::IDependent
enum	ChangeMessage { kWillChange , kChanged , kDestroyed , kWillDestroy , kStdChangeMessageLast }

Static Public Member Functions inherited from Steinberg::FObject
static FClassID	getFClassID ()
	return Class ID as an ASCII string (statically)

static void	setUpdateHandler (IUpdateHandler *handler)
	set method for the local attribute

static IUpdateHandler *	getUpdateHandler ()
	get method for the local attribute

static bool	classIDsEqual (FClassID ci1, FClassID ci2)
	compares (evaluates) 2 class IDs

static FObject *	unknownToObject (FUnknown *unknown)
	pointer conversion from FUnknown to FObject

Static Public Attributes inherited from Steinberg::FObject
static const FUID	iid
	Special UID that is used to cast an FUnknown pointer to a FObject.

Static Public Attributes inherited from Steinberg::IDependent
static const FUID	iid

Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid

Static Protected Attributes inherited from Steinberg::FObject
static IUpdateHandler *	gUpdateHandler

Detailed Description

Description of an Audio Bus.

Definition at line 122 of file vstbus.h.

Constructor & Destructor Documentation

◆ AudioBus()

Steinberg::Vst::AudioBus::AudioBus	(	const TChar *	name,
		BusType	busType,
		int32	flags,
		SpeakerArrangement	arr
	)

Definition at line 78 of file vstbus.cpp.

Member Function Documentation

◆ getArrangement()

SpeakerArrangement Steinberg::Vst::AudioBus::getArrangement ( ) const

Gets the speaker arrangement defining this Audio bus.

Definition at line 129 of file vstbus.h.

◆ getInfo()

bool Steinberg::Vst::AudioBus::getInfo ( BusInfo & info )

virtual

Gets the BusInfo associated to this Audio bus.

Reimplemented from Steinberg::Vst::Bus.

Definition at line 84 of file vstbus.cpp.

◆ setArrangement()

void Steinberg::Vst::AudioBus::setArrangement ( const SpeakerArrangement & arr )

Sets the speaker arrangement defining this Audio bus.

Definition at line 132 of file vstbus.h.

Member Data Documentation

◆ speakerArr

SpeakerArrangement Steinberg::Vst::AudioBus::speakerArr

protected

Definition at line 142 of file vstbus.h.

The documentation for this class was generated from the following files:

juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vstbus.h
juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vstbus.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members