Steinberg::Vst::Bus Class Reference

#include <vstbus.h>

Inheritance diagram for Steinberg::Vst::Bus:

Public Member Functions
	Bus (const TChar *name, BusType busType, int32 flags)
TBool	isActive () const
void	setActive (TBool state)
void	setName (String newName)
void	setBusType (BusType newBusType)
void	setFlags (uint32 newFlags)
virtual bool	getInfo (BusInfo &)
Public Member Functions inherited from Steinberg::FObject
	FObject ()
	default constructor...
	FObject (const FObject &)
	overloaded constructor...
virtual	~FObject ()
	destructor...
FObject &	operator= (const FObject &)
	overloads operator "=" as the reference assignment
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
String	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 = kWillDestroy }
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
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 = nullptr

Detailed Description

Basic Bus object.

Constructor & Destructor Documentation

Bus()

Steinberg::Vst::Bus::Bus	(	const TChar *	name,
		BusType	busType,
		int32	flags )

Constructor.

Member Function Documentation

getInfo()

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

virtual

Gets the BusInfo of this bus.

Reimplemented in Steinberg::Vst::AudioBus, and Steinberg::Vst::EventBus.

isActive()

TBool Steinberg::Vst::Bus::isActive ( ) const

inline

Returns true if the bus is active.

setActive()

void Steinberg::Vst::Bus::setActive ( TBool state )

inline

Activates the bus.

setBusType()

void Steinberg::Vst::Bus::setBusType ( BusType newBusType )

inline

Sets a new busType for this bus.

setFlags()

void Steinberg::Vst::Bus::setFlags ( uint32 newFlags )

inline

Sets a new flags for this bus.

setName()

void Steinberg::Vst::Bus::setName ( String newName )

inline

Sets a new name for this bus.

Member Data Documentation

active

TBool Steinberg::Vst::Bus::active

protected

activation state

busType

BusType Steinberg::Vst::Bus::busType

protected

kMain or kAux, see BusTypes

flags

int32 Steinberg::Vst::Bus::flags

protected

flags, see BusInfo::BusFlags

name

String Steinberg::Vst::Bus::name

protected

name

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/public.sdk/source/vst/vstbus.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/public.sdk/source/vst/vstbus.cpp