JUCE  v5.1.1-3-g1a0b28c73
JUCE API
AudioProcessor::BusesLayout Struct Reference

Represents the bus layout state of a plug-in. More...

#include <juce_AudioProcessor.h>

Collaboration diagram for AudioProcessor::BusesLayout:

Public Member Functions

AudioChannelSetgetChannelSet (bool isInput, int busIndex)
 Get the channel set of a particular bus. More...
 
AudioChannelSet getChannelSet (bool isInput, int busIndex) const noexcept
 Get the channel set of a particular bus. More...
 
int getMainInputChannels () const noexcept
 Get the number of input channels on the main bus. More...
 
AudioChannelSet getMainInputChannelSet () const noexcept
 Get the input channel layout on the main bus. More...
 
int getMainOutputChannels () const noexcept
 Get the number of output channels on the main bus. More...
 
AudioChannelSet getMainOutputChannelSet () const noexcept
 Get the output channel layout on the main bus. More...
 
int getNumChannels (bool isInput, int busIndex) const noexcept
 Get the number of channels of a particular bus. More...
 
bool operator!= (const BusesLayout &other) const noexcept
 
bool operator== (const BusesLayout &other) const noexcept
 

Public Attributes

Array< AudioChannelSetinputBuses
 An array containing the list of input buses that this processor supports. More...
 
Array< AudioChannelSetoutputBuses
 An array containing the list of output buses that this processor supports. More...
 

Detailed Description

Represents the bus layout state of a plug-in.

Member Function Documentation

◆ getChannelSet() [1/2]

AudioChannelSet& AudioProcessor::BusesLayout::getChannelSet ( bool  isInput,
int  busIndex 
)
inline

Get the channel set of a particular bus.

◆ getChannelSet() [2/2]

AudioChannelSet AudioProcessor::BusesLayout::getChannelSet ( bool  isInput,
int  busIndex 
) const
inlinenoexcept

Get the channel set of a particular bus.

◆ getMainInputChannels()

int AudioProcessor::BusesLayout::getMainInputChannels ( ) const
inlinenoexcept

Get the number of input channels on the main bus.

◆ getMainInputChannelSet()

AudioChannelSet AudioProcessor::BusesLayout::getMainInputChannelSet ( ) const
inlinenoexcept

Get the input channel layout on the main bus.

◆ getMainOutputChannels()

int AudioProcessor::BusesLayout::getMainOutputChannels ( ) const
inlinenoexcept

Get the number of output channels on the main bus.

◆ getMainOutputChannelSet()

AudioChannelSet AudioProcessor::BusesLayout::getMainOutputChannelSet ( ) const
inlinenoexcept

Get the output channel layout on the main bus.

◆ getNumChannels()

int AudioProcessor::BusesLayout::getNumChannels ( bool  isInput,
int  busIndex 
) const
inlinenoexcept

◆ operator!=()

bool AudioProcessor::BusesLayout::operator!= ( const BusesLayout other) const
inlinenoexcept

◆ operator==()

bool AudioProcessor::BusesLayout::operator== ( const BusesLayout other) const
inlinenoexcept

Member Data Documentation

◆ inputBuses

Array<AudioChannelSet> AudioProcessor::BusesLayout::inputBuses

An array containing the list of input buses that this processor supports.

Referenced by AudioUnitHelpers::getBusesLayout(), and AudioUnitHelpers::setBusesLayout().

◆ outputBuses

Array<AudioChannelSet> AudioProcessor::BusesLayout::outputBuses

An array containing the list of output buses that this processor supports.

Referenced by AudioUnitHelpers::getBusesLayout(), and AudioUnitHelpers::setBusesLayout().


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