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

Node that allows multiple input buses, each can be muted separately, and also has solo functionality. More...

#include <AdvancedMuteNode.hpp>

Inheritance diagram for switchboard::AdvancedMuteNode:

Public Member Functions

 AdvancedMuteNode ()
 AdvancedMuteNode constructor.
 
bool getIsMuted (const uint busIndex) const
 Returns whether the bus is muted or not.
 
void setIsMuted (const uint busIndex, const bool newValue)
 Enables or disables muting.
 
void setSolo (const uint busIndex)
 Sets the solo functionality to the given bus (all other buses are muted, while this is enabled)
 
void clearSolo ()
 Clears the solo functionality.
 
uint getNumberOfBuses () const
 Gets the number of buses currently handled by the node.
 
bool setNumberOfBuses (const uint numberOfInputBuses, const uint numberOfOutputBuses) override
 
bool setBusFormats (AudioBusFormatList &inputBusFormats, AudioBusFormatList &outputBusFormats) override
 
bool process (AudioBusList &inBuses, AudioBusList &outBuses) override
 

Detailed Description

Node that allows multiple input buses, each can be muted separately, and also has solo functionality.

AdvancedMuteNode class.

Member Function Documentation

◆ getIsMuted()

bool switchboard::AdvancedMuteNode::getIsMuted ( const uint busIndex) const

Returns whether the bus is muted or not.

Parameters
busIndexThe index of the bus.
Returns
True if the node is muting the audio stream on given bus, false otherwise.

◆ getNumberOfBuses()

uint switchboard::AdvancedMuteNode::getNumberOfBuses ( ) const

Gets the number of buses currently handled by the node.

Returns
The number of buses.

◆ setIsMuted()

void switchboard::AdvancedMuteNode::setIsMuted ( const uint busIndex,
const bool newValue )

Enables or disables muting.

Parameters
busIndexThe index of the bus.
newValueThe new muting setting.

◆ setSolo()

void switchboard::AdvancedMuteNode::setSolo ( const uint busIndex)

Sets the solo functionality to the given bus (all other buses are muted, while this is enabled)

Parameters
busIndexThe index of the bus.