LMMS
Loading...
Searching...
No Matches
Steinberg::Vst::EventBus Class Reference

#include <vstbus.h>

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

Public Member Functions

 EventBus (const TChar *name, BusType busType, int32 flags, int32 channelCount)
bool getInfo (BusInfo &info) SMTG_OVERRIDE
 OBJ_METHODS (Vst::EventBus, Vst::Bus)
Public Member Functions inherited from Steinberg::Vst::Bus
 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)
Public Member Functions inherited from Steinberg::FObject
 FObject ()
 default constructor...
 FObject (const FObject &)
 overloaded constructor...
virtual ~FObject ()
 destructor...
FObjectoperator= (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
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

int32 channelCount
Protected Attributes inherited from Steinberg::Vst::Bus
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 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
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 = nullptr

Detailed Description

Description of an Event Bus.

Constructor & Destructor Documentation

◆ EventBus()

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

Constructor of an EventBus.

Member Function Documentation

◆ getInfo()

bool Steinberg::Vst::EventBus::getInfo ( BusInfo & info)
virtual

Gets the BusInfo associated to this Event bus.

Reimplemented from Steinberg::Vst::Bus.

◆ OBJ_METHODS()

Steinberg::Vst::EventBus::OBJ_METHODS ( Vst::EventBus ,
Vst::Bus  )

Member Data Documentation

◆ channelCount

int32 Steinberg::Vst::EventBus::channelCount
protected

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