JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Steinberg::Vst::Bus Class Reference

Basic Bus object. More...

#include "vstbus.h"

Inheritance diagram for Steinberg::Vst::Bus:
Steinberg::FObject Steinberg::IDependent Steinberg::FUnknown Steinberg::Vst::AudioBus Steinberg::Vst::EventBus

Public Member Functions

 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.
 
virtual bool getInfo (BusInfo &)
 Gets the BusInfo of this bus.
 
- Public Member Functions inherited from Steinberg::FObject
 FObject ()=default
 default constructor...
 
 FObject (const FObject &)
 
FObjectoperator= (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
 
FUnknownunknownCast ()
 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

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 IUpdateHandlergetUpdateHandler ()
 get method for the local attribute
 
static bool classIDsEqual (FClassID ci1, FClassID ci2)
 compares (evaluates) 2 class IDs
 
static FObjectunknownToObject (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 IUpdateHandlergUpdateHandler
 

Detailed Description

Basic Bus object.

Definition at line 57 of file vstbus.h.

Constructor & Destructor Documentation

◆ Bus()

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

Constructor.

Definition at line 45 of file vstbus.cpp.

Member Function Documentation

◆ getInfo()

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

Gets the BusInfo of this bus.

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

Definition at line 51 of file vstbus.cpp.

◆ isActive()

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

Returns true if the bus is active.

Definition at line 65 of file vstbus.h.

◆ setActive()

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

Activates the bus.

Definition at line 68 of file vstbus.h.

◆ setBusType()

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

Sets a new busType for this bus.

Definition at line 79 of file vstbus.h.

◆ setFlags()

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

Sets a new flags for this bus.

Definition at line 82 of file vstbus.h.

◆ setName()

void Steinberg::Vst::Bus::setName ( const std::u16string newName)

Sets a new name for this bus.

Definition at line 75 of file vstbus.h.

Member Data Documentation

◆ active

TBool Steinberg::Vst::Bus::active
protected

activation state

Definition at line 93 of file vstbus.h.

◆ busType

BusType Steinberg::Vst::Bus::busType
protected

kMain or kAux, see BusTypes

Definition at line 91 of file vstbus.h.

◆ flags

int32 Steinberg::Vst::Bus::flags
protected

flags, see BusInfo::BusFlags

Definition at line 92 of file vstbus.h.

◆ name

std::u16string Steinberg::Vst::Bus::name
protected

name

Definition at line 90 of file vstbus.h.


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