switchboard::AudioBusFormatList Struct Reference

Holds a list of AudioBusList instances. More...

#include <AudioBusFormatList.hpp>

Public Member Functions
WASM	AudioBusFormatList (const uint numberOfBuses)
	Creates an AudioBusFormatList instance.
WASM	AudioBusFormatList (const std::vector< AudioBusFormat > &busFormats)
	Creates an AudioBusFormatList instance from a vector of AudioBusFormat values.
WASM uint	getNumberOfBuses () const
	Returns the number of audio bus formats.
WASM AudioBusFormat &	getBusFormat (const uint busIndex) const
	Returns the audio bus format for the specified index.
WASM void	reset ()
	Resets all audio bus formats stored in the instance.
WASM bool	isSet () const
	Checks whether all audio bus formats are set.
WASM bool	isPartlySet () const
	Checks whether any of the audio bus formats are set.
bool	operator== (const AudioBusFormatList &other)
	Compares two audio bus format lists.
bool	operator!= (const AudioBusFormatList &other)
	Compares two audio bus format lists.
	AudioBusFormatList (const AudioBusFormatList &)=delete
AudioBusFormatList &	operator= (const AudioBusFormatList &other)

Static Public Member Functions
static WASM bool	matchBusFormats (AudioBusFormatList &busFormats)
	Matches all bus formats in an AudioBusFormatList instance.
static WASM bool	matchBusFormats (AudioBusFormatList &busFormatList1, AudioBusFormatList &busFormatList2)
	Matches all bus formats in two AudioBusFormatList instances.

Detailed Description

Holds a list of AudioBusList instances.

AudioBusFormatList class.

Represents formats of AudioBusList instances without the need for the audio data.

Constructor & Destructor Documentation

AudioBusFormatList() [1/2]

switchboard::AudioBusFormatList::AudioBusFormatList

(

const uint

numberOfBuses

)

Creates an AudioBusFormatList instance.

Allocates enough memory to hold the AudioBusFormat instances.

Parameters

numberOfBuses

The number of audio bus formats handled by this instance.

AudioBusFormatList() [2/2]

switchboard::AudioBusFormatList::AudioBusFormatList

(

const std::vector< AudioBusFormat > &

busFormats

)

Creates an AudioBusFormatList instance from a vector of AudioBusFormat values.

Allocates enough memory to hold the AudioBusFormat instances.

Parameters

busFormats

The vector holding the AudioBusFormat values.

Member Function Documentation

getBusFormat()

AudioBusFormat & switchboard::AudioBusFormatList::getBusFormat

(

const uint

busIndex

)

const

Returns the audio bus format for the specified index.

Parameters

busIndex

The index of the audio bus.

Returns

The AudioBusFormat for the bus index.

getNumberOfBuses()

uint switchboard::AudioBusFormatList::getNumberOfBuses

(

)

const

Returns the number of audio bus formats.

Returns

The number of audio buses.

isPartlySet()

bool switchboard::AudioBusFormatList::isPartlySet

(

)

const

Checks whether any of the audio bus formats are set.

Returns

True if any of the audio bus formats are defined, false otherwise.

isSet()

bool switchboard::AudioBusFormatList::isSet

(

)

const

Checks whether all audio bus formats are set.

Returns

True if all audio bus formats are defined, false otherwise.

matchBusFormats() [1/2]

bool switchboard::AudioBusFormatList::matchBusFormats ( AudioBusFormatList &  busFormatList1, AudioBusFormatList &  busFormatList2  )

static

Matches all bus formats in two AudioBusFormatList instances.

Finds the first defined bus format and requires the same bus format for all of the other buses. If none of the bus formats are defined, it returns with false.

Parameters

busFormatList1	The first bus format list in which the bus formats will be matched.
busFormatList2	The second bus format list in which the bus formats will be matched.

Returns

True if the bus formats could be matched successfully, false otherwise.

matchBusFormats() [2/2]

bool switchboard::AudioBusFormatList::matchBusFormats ( AudioBusFormatList &  busFormats )

static

Matches all bus formats in an AudioBusFormatList instance.

Finds the first defined bus format and requires the same bus format for all of the other buses. If none of the bus formats are defined, it returns with false.

Parameters

busFormats

The bus format list in which the bus formats will be matched.

Returns

True if the bus formats could be matched successfully, false otherwise.

operator!=()

bool switchboard::AudioBusFormatList::operator!=

(

const AudioBusFormatList &

other

)

Compares two audio bus format lists.

Parameters

other

The other AudioBusFormatList instance.

Returns

True if the stored audio bus formats are different, false otherwise.

operator==()

bool switchboard::AudioBusFormatList::operator==

(

const AudioBusFormatList &

other

)

Compares two audio bus format lists.

Parameters

other

The other AudioBusFormatList instance.

Returns

True if all audio bus formats match, false otherwise.

---

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

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