Steinberg::Vst::IComponentHandlerBusActivation Class Reference

#include <ivsteditcontroller.h>

Inheritance diagram for Steinberg::Vst::IComponentHandlerBusActivation:

Public Member Functions
virtual tresult PLUGIN_API	requestBusActivation (MediaType type, BusDirection dir, int32 index, TBool state)=0
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
virtual uint32 PLUGIN_API	addRef ()=0
virtual uint32 PLUGIN_API	release ()=0

Static Public Attributes
static const FUID	iid
Static Public Attributes inherited from Steinberg::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 PLUGIN_API Steinberg::Vst::IComponentHandlerBusActivation::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 Steinberg::Vst::IComponentHandlerBusActivation::iid

static

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/pluginterfaces/vst/ivsteditcontroller.h