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

Selects and forwards a single audio bus from multiple input audio buses to it's output. More...

#include <BusSelectNode.hpp>

Inheritance diagram for switchboard::BusSelectNode:
switchboard::AudioProcessorNode switchboard::AudioNode

Public Member Functions

WASM BusSelectNode ()
 Initializes a BusSelectNode instance.
 
WASM uint getSelectedBus () const
 Gets the current selected bus index.
 
WASM bool setSelectedBus (const uint newValue)
 Sets the selected bus index.
 
WASM uint getNumberOfInputBuses () const
 Gets the number of input buses of the node.
 
WASM bool setNumberOfBuses (const uint numberOfInputBuses, const uint numberOfOutputBuses) override
 Sets number of buses.
 
WASM bool setBusFormats (AudioBusFormatList &inputBusFormats, AudioBusFormatList &outputBusFormats) override
 Sets bus formats.
 
WASM bool process (AudioBusList &inBuses, AudioBusList &outBuses) override
 Processes audio data from the given input buses and produces the audio output to the given output buses.
 
- Public Member Functions inherited from switchboard::AudioProcessorNode
virtual ~AudioProcessorNode ()=default
 AudioProcessorNode virtual destructor.
 
- Public Member Functions inherited from switchboard::AudioNode
 AudioNode ()
 AudioNode constructor.
 
virtual ~AudioNode ()=default
 AudioNode virtual destructor.
 
const std::string & getType () const
 Gets the type of the audio node.
 
virtual const std::string getDisplayName () const
 Gets the display name of the audio node.
 
virtual std::vector< std::unique_ptr< Parameter > > & getParameters ()
 Gets the parameters of the audio node.
 
virtual ParametergetParameter (const std::string &id)
 Gets the parameter with the given name.
 

Additional Inherited Members

- Public Attributes inherited from switchboard::AudioNode
std::string name
 The name of the audio node.
 
- Protected Member Functions inherited from switchboard::AudioNode
void initParameters (std::map< std::string, std::any > config)
 Initializes the node parameters from the given configuration values.
 
- Protected Attributes inherited from switchboard::AudioNode
std::string type
 
std::vector< std::unique_ptr< Parameter > > parameters
 

Detailed Description

Selects and forwards a single audio bus from multiple input audio buses to it's output.

BusSelectNode class.

Member Function Documentation

◆ getNumberOfInputBuses()

uint switchboard::BusSelectNode::getNumberOfInputBuses ( ) const

Gets the number of input buses of the node.

Returns
The number of input buses..

◆ getSelectedBus()

uint switchboard::BusSelectNode::getSelectedBus ( ) const

Gets the current selected bus index.

Returns
The bus index.

◆ process()

bool switchboard::BusSelectNode::process ( AudioBusList & inBuses,
AudioBusList & outBuses )
overridevirtual

Processes audio data from the given input buses and produces the audio output to the given output buses.

Should be overridden by subclasses.

Parameters
inBusesThe input buses that contain the audio data.
outBusesThe output buses which should be filled with the processed audio data.
Returns
True if audio was processed successfully, false otherwise.

Implements switchboard::AudioProcessorNode.

◆ setBusFormats()

bool switchboard::BusSelectNode::setBusFormats ( AudioBusFormatList & inputBusFormats,
AudioBusFormatList & outputBusFormats )
overridevirtual

Sets bus formats.

Should be overridden by subclasses. Please note that setNumberOfBuses is guaranteed to be called before this method.

Parameters
inputBusFormatsThe input bus formats to set.
outputBusFormatsThe output bus formats to set.
Returns
True if the bus formats were set successfully, false otherwise.

Implements switchboard::AudioProcessorNode.

◆ setNumberOfBuses()

bool switchboard::BusSelectNode::setNumberOfBuses ( const uint numberOfInputBuses,
const uint numberOfOutputBuses )
overridevirtual

Sets number of buses.

Should be overridden by subclasses

Parameters
numberOfInputBusesThe number of input buses to set.
numberOfOutputBusesThe number of output buses to set.
Returns
True for valid number of buses, false otherwise.

Implements switchboard::AudioProcessorNode.

◆ setSelectedBus()

bool switchboard::BusSelectNode::setSelectedBus ( const uint newValue)

Sets the selected bus index.

Will return false if the bus index is bigger than or equal than max number of input buses.

Parameters
newValueThe bus index to set.
Returns
True if setting the selected bus index was successful.