VST 3 Interfaces  VST 3.6.7
SDK for developing VST Plug-in
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Public Types | Data Fields
BusInfo Struct Reference

Bus Description. More...

#include <ivstcomponent.h>

Public Types

enum  BusFlags { kDefaultActive = 1 << 0 }
 

Data Fields

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

Bus Description.

A bus can be understood as a 'collection of data channels' belonging together. It describes a data input or a data output of the Plug-in. A VST component can define any desired number of buses, but this number must never change. Dynamic usage of buses is handled in the host by activating and deactivating buses. The component has to define the maximum number of supported buses and it has to define which of them are active by default. A host that can handle multiple buses, allows the user to activate buses that were initially inactive.

See also: IComponent::getBusInfo , IComponent::activateBus

Member Enumeration Documentation

enum BusFlags
Enumerator
kDefaultActive 

bus active per default

Field Documentation

MediaType mediaType

Media type - has to be a value of MediaTypes.

BusDirection direction

input or output BusDirections

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

String128 name

name of the bus

BusType busType

main or aux - has to be a value of BusTypes

uint32 flags

flags - a combination of BusFlags

Empty

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