Switchboard SDK
Loading...
Searching...
No Matches
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

SB_WASM BusSwitchNode ()
 Initializes a BusSwitchNode instance.
 
SB_WASM uint getSelectedBus () const
 Gets the current selected bus index.
 
SB_WASM bool setSelectedBus (const uint newValue)
 Sets the selected bus index.
 
SB_WASM uint getNumberOfOutputBuses () const
 Gets the number of output buses of the node.
 
SB_WASM bool setNumberOfBuses (const uint numberOfInputBuses, const uint numberOfOutputBuses) override
 
SB_WASM bool setBusFormats (AudioBusFormatList &inputBusFormats, AudioBusFormatList &outputBusFormats) override
 
SB_WASM bool process (AudioBusList &inBuses, AudioBusList &outBuses) override
 

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.

◆ 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
newValueThe bus index to set.
Returns
True if setting the selected bus index was successful.