Switchboard SDK
Loading...
Searching...
No Matches
switchboard::AudioBusFormatVector Class Reference

Holds a list of AudioBusList instances on the heap. More...

#include <AudioBusFormatVector.hpp>

Inheritance diagram for switchboard::AudioBusFormatVector:
switchboard::AudioBusFormatList

Public Member Functions

 AudioBusFormatVector (const uint numberOfBuses)
 Creates an AudioBusFormatVector instance.
 
 AudioBusFormatVector (const std::vector< AudioBusFormat > &busFormats)
 Creates an AudioBusFormatVector instance from a vector of AudioBusFormat values.
 
uint getNumberOfBuses () const override
 Returns the number of audio bus formats.
 
AudioBusFormatgetBusFormat (const uint busIndex) const override
 Returns the audio bus format for the specified index.
 
AudioBusFormatListoperator= (const AudioBusFormatList &other) override
 Makes an audio bus format list equal to another audio bus format list.
 
- Public Member Functions inherited from switchboard::AudioBusFormatList
 AudioBusFormatList ()=default
 Default constructor for AudioBusFormatList.
 
virtual ~AudioBusFormatList ()=default
 Default destructor for AudioBusFormatList.
 
void reset ()
 Resets all audio bus formats stored in the instance.
 
bool isSet () const
 Checks whether all audio bus formats are set.
 
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.
 
std::string toString () const
 Returns a string representing the object.
 
 AudioBusFormatList (const AudioBusFormatList &)=delete
 

Additional Inherited Members

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

Detailed Description

Holds a list of AudioBusList instances on the heap.

AudioBusFormatVector class.

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

See also
AudioBusFormatList
AudioBusFormatArray

Constructor & Destructor Documentation

◆ AudioBusFormatVector() [1/2]

switchboard::AudioBusFormatVector::AudioBusFormatVector ( const uint numberOfBuses)

Creates an AudioBusFormatVector instance.

Allocates enough memory on the heap to hold the AudioBusFormat instances.

Parameters
numberOfBusesThe number of audio bus formats handled by this instance.

◆ AudioBusFormatVector() [2/2]

switchboard::AudioBusFormatVector::AudioBusFormatVector ( const std::vector< AudioBusFormat > & busFormats)

Creates an AudioBusFormatVector instance from a vector of AudioBusFormat values.

Allocates enough memory on the heap to hold the AudioBusFormat instances.

Parameters
busFormatsThe vector holding the AudioBusFormat values.

Member Function Documentation

◆ getBusFormat()

AudioBusFormat & switchboard::AudioBusFormatVector::getBusFormat ( const uint busIndex) const
overridevirtual

Returns the audio bus format for the specified index.

Parameters
busIndexThe index of the audio bus.
Returns
The AudioBusFormat for the bus index.

Implements switchboard::AudioBusFormatList.

◆ getNumberOfBuses()

uint switchboard::AudioBusFormatVector::getNumberOfBuses ( ) const
overridevirtual

Returns the number of audio bus formats.

Returns
The number of audio buses.

Implements switchboard::AudioBusFormatList.

◆ operator=()

AudioBusFormatList & switchboard::AudioBusFormatVector::operator= ( const AudioBusFormatList & other)
overridevirtual

Makes an audio bus format list equal to another audio bus format list.

Parameters
otherThe other audio bus format list.

Implements switchboard::AudioBusFormatList.