VST 3 Interfaces  VST 3.7
SDK for developing VST plug-in
BusInfo Struct Reference

BusInfo: This is the structure used with getBusInfo, informing the host about what is a specific given bus. More...

#include <ivstcomponent.h>

Public Types

enum  BusFlags { kDefaultActive = 1 << 0, kIsControlVoltage = 1 << 1 }
 

Public Attributes

MediaType mediaType
 Media type - has to be a value of MediaTypes. More...
 
BusDirection direction
 input or output BusDirections More...
 
int32 channelCount
 number of channels (if used then need to be recheck after IAudioProcessor::setBusArrangements is called). More...
 
String128 name
 name of the bus More...
 
BusType busType
 main or aux - has to be a value of BusTypes More...
 
uint32 flags
 flags - a combination of BusFlags More...
 

Detailed Description

BusInfo: This is the structure used with getBusInfo, informing the host about what is a specific given bus.


See also: Steinberg::Vst::IComponent::getBusInfo

Member Enumeration Documentation

◆ BusFlags

enum BusFlags
Enumerator
kDefaultActive 

The bus should be activated by the host per default on instantiation (activateBus call is requested).

By default a bus is inactive.

kIsControlVoltage 

The bus does not contain ordinary audio data, but data used for control changes at sample rate.

The data is in the same format as the audio data [-1..1]. A host has to prevent unintended routing to speakers to prevent damage. Only valid for audio media type busses. [released: 3.7.0]

Member Data Documentation

◆ mediaType

MediaType mediaType

Media type - has to be a value of MediaTypes.

◆ direction

BusDirection direction

input or output BusDirections

◆ channelCount

int32 channelCount

number of channels (if used then need to be recheck after IAudioProcessor::setBusArrangements is called).

For a bus of type MediaTypes::kEvent the channelCount corresponds to the number of supported MIDI channels by this bus

◆ name

String128 name

name of the bus

◆ busType

BusType busType

main or aux - has to be a value of BusTypes

◆ flags

uint32 flags

flags - a combination of BusFlags

Empty

Copyright ©2021 Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.