switchboard::AudioBusList Struct Reference

Holds a list of AudioBus instances. More...

#include <AudioBusList.hpp>

Public Member Functions
WASM	AudioBusList (const uint numberOfBuses)
	Creates an AudioBusList instance.
	AudioBusList (AudioBus &audioBus)
	Creates an AudioBusList instance with a single audio bus.
	AudioBusList (AudioBuffer< float > &buffer)
	Creates an AudioBusList instance with a single audio bus from an audio buffer.
AudioBusFormatList &	getFormat ()
	Gets the formats of the audio buses.
WASM uint	getNumberOfBuses () const
	Gets the number of audio buses.
WASM AudioBus &	getBus (const uint busIndex) const
	Gets an audio bus by its index.
void	copyFrom (const AudioBusList &srcAudioBusList)
	Copies another AudioBusList instance.
	AudioBusList (const AudioBusList &)=delete
AudioBusList &	operator= (const AudioBusList &)=delete

Detailed Description

Holds a list of AudioBus instances.

AudioBusList class.

Constructor & Destructor Documentation

AudioBusList() [1/3]

switchboard::AudioBusList::AudioBusList

(

const uint

numberOfBuses

)

Creates an AudioBusList instance.

Allocates enough memory to hold the AudioBus instances.

Parameters

numberOfBuses

The number of audio buses.

AudioBusList() [2/3]

switchboard::AudioBusList::AudioBusList

(

AudioBus &

audioBus

)

Creates an AudioBusList instance with a single audio bus.

Parameters

audioBus

The audio bus.

AudioBusList() [3/3]

switchboard::AudioBusList::AudioBusList

(

AudioBuffer< float > &

buffer

)

Creates an AudioBusList instance with a single audio bus from an audio buffer.

Parameters

buffer

The audio buffer for the single audio bus.

Member Function Documentation

copyFrom()

void switchboard::AudioBusList::copyFrom

(

const AudioBusList &

srcAudioBusList

)

Copies another AudioBusList instance.

The number of buses has to match in both instances.

Parameters

srcAudioBusList

The other AudioBusList instance where data is copied from.

getBus()

AudioBus & switchboard::AudioBusList::getBus

(

const uint

busIndex

)

const

Gets an audio bus by its index.

Parameters

busIndex

The index of the audio bus.

Returns

The AudioBus instance.

getFormat()

AudioBusFormatList & switchboard::AudioBusList::getFormat

(

)

Gets the formats of the audio buses.

Returns

An AudioBusFormatList instance that describes the formats of the audio buses.

getNumberOfBuses()

uint switchboard::AudioBusList::getNumberOfBuses

(

)

const

Gets the number of audio buses.

Returns

The number of audio buses.

---

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

• /Users/jenkins/.jenkins/workspace/Switchboard Developer Site - Production/SwitchboardSDK/src/all/AudioGraph/AudioBus/AudioBusList.hpp
• /Users/jenkins/.jenkins/workspace/Switchboard Developer Site - Production/SwitchboardSDK/src/all/AudioGraph/AudioBus/AudioBusList.cpp