switchboard::BusSwitchNode Class Reference

Forwards a single input audio bus to a single output audio bus out of multiple output audio buses. More...

#include <BusSwitchNode.hpp>

Inheritance diagram for switchboard::BusSwitchNode:

Public Member Functions
WASM	BusSwitchNode ()
	Initializes a BusSwitchNode instance.
WASM uint	getSelectedBus () const
	Gets the current selected bus index.
WASM bool	setSelectedBus (const uint newValue)
	Sets the selected bus index.
WASM uint	getNumberOfOutputBuses () const
	Gets the number of output 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 Parameter *	getParameter (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

Forwards a single input audio bus to a single output audio bus out of multiple output audio buses.

BusSwitchNode class.

Member Function Documentation

getNumberOfOutputBuses()

uint switchboard::BusSwitchNode::getNumberOfOutputBuses

(

)

const

Gets the number of output buses of the node.

Returns

The number of output buses.

getSelectedBus()

uint switchboard::BusSwitchNode::getSelectedBus

(

)

const

Gets the current selected bus index.

Returns

The bus index.

process()

bool switchboard::BusSwitchNode::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

inBuses	The input buses that contain the audio data.
outBuses	The 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::BusSwitchNode::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

inputBusFormats	The input bus formats to set.
outputBusFormats	The output bus formats to set.

Returns

True if the bus formats were set successfully, false otherwise.

Implements switchboard::AudioProcessorNode.

setNumberOfBuses()

bool switchboard::BusSwitchNode::setNumberOfBuses ( const uint numberOfInputBuses, const uint numberOfOutputBuses )

overridevirtual

Sets number of buses.

Should be overridden by subclasses

Parameters

numberOfInputBuses	The number of input buses to set.
numberOfOutputBuses	The number of output buses to set.

Returns

True for valid number of buses, false otherwise.

Implements switchboard::AudioProcessorNode.

setSelectedBus()

bool switchboard::BusSwitchNode::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 output buses.

Parameters

newValue

The bus index to set.

Returns

True if setting the selected bus index was successful.