Switchboard SDK
Loading...
Searching...
No Matches
switchboard::AudioBusList Struct Referenceabstract

Holds a list of AudioBus instances. More...

#include <AudioBusList.hpp>

Inheritance diagram for switchboard::AudioBusList:
switchboard::AudioBusArray< N > switchboard::AudioBusVector

Public Member Functions

 AudioBusList ()=default
 Default constructor for AudioBusList.
 
virtual ~AudioBusList ()=default
 Default destructor for AudioBusList.
 
virtual AudioBusFormatListgetFormat ()=0
 Gets the formats of the audio buses.
 
virtual uint getNumberOfBuses () const =0
 Gets the number of audio buses.
 
virtual AudioBusgetBus (const uint busIndex) const =0
 Gets an audio bus by its index.
 
void copyFrom (const AudioBusList &srcAudioBusList) const
 Copies another AudioBusList instance.
 
void clear () const
 Sets the content of all audio buses to zero.
 
 AudioBusList (const AudioBusList &)=delete
 
AudioBusListoperator= (const AudioBusList &)=delete
 

Detailed Description

Holds a list of AudioBus instances.

AudioBusList abstract superclass.

See also
AudioBusArray
AudioBusVector

Member Function Documentation

◆ copyFrom()

void switchboard::AudioBusList::copyFrom ( const AudioBusList & srcAudioBusList) const

Copies another AudioBusList instance.

The number of buses has to match in both instances.

Parameters
srcAudioBusListThe other AudioBusList instance where data is copied from.

◆ getBus()

virtual AudioBus & switchboard::AudioBusList::getBus ( const uint busIndex) const
pure virtual

Gets an audio bus by its index.

Parameters
busIndexThe index of the audio bus.
Returns
The AudioBus instance.

Implemented in switchboard::AudioBusArray< N >, and switchboard::AudioBusVector.

◆ getFormat()

virtual AudioBusFormatList & switchboard::AudioBusList::getFormat ( )
pure virtual

Gets the formats of the audio buses.

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

Implemented in switchboard::AudioBusArray< N >, and switchboard::AudioBusVector.

◆ getNumberOfBuses()

virtual uint switchboard::AudioBusList::getNumberOfBuses ( ) const
pure virtual

Gets the number of audio buses.

Returns
The number of audio buses.

Implemented in switchboard::AudioBusArray< N >, and switchboard::AudioBusVector.