IComponentHandlerBusActivation Class Reference

Extended host callback interface for an edit controller: Vst::IComponentHandlerBusActivation. More...

#include <ivsteditcontroller.h>

Inheritance diagram for IComponentHandlerBusActivation:

Public Member Functions
virtual tresult	requestBusActivation (MediaType type, BusDirection dir, int32 index, TBool state)=0
	request the host to activate or deactivate a specific bus. More...
Public Member Functions inherited from FUnknown
virtual tresult	queryInterface (const TUID _iid, void **obj)=0
virtual uint32	addRef ()=0
virtual uint32	release ()=0

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

Detailed Description

Extended host callback interface for an edit controller: Vst::IComponentHandlerBusActivation.

• [host imp]
• [extends IComponentHandler]
• [released: 3.6.8]
• [optional]

Allows the plug-in to request the host to activate or deactivate a specific bus. If the host accepts this request, it will call later on IComponent::activateBus. This is particularly useful for instruments with more than 1 outputs, where the user could request from the plug-in UI a given output bus activation.

// somewhere in your code when you need to inform the host to enable a specific Bus.
FUnknownPtr<IComponentHandlerBusActivation> busActivation (componentHandler);
if (busActivation)
{
    // here we want to activate our audio input sidechain (the 2cd input bus: index 1)
    busActivation->requestBusActivation (kAudio, kInput, 1, true);
}

See also

IComponentHandler

Member Function Documentation

requestBusActivation()

virtual tresult requestBusActivation ( MediaType  type, BusDirection  dir, int32  index, TBool  state  )

pure virtual

request the host to activate or deactivate a specific bus.

Member Data Documentation

iid

const FUID iid

static