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:
switchboard::AudioProcessorNode switchboard::AudioNode

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
 Sets number of buses.
 
bool setBusFormats (AudioBusFormatList &inputBusFormats, AudioBusFormatList &outputBusFormats) override
 Sets bus formats.
 
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

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.

◆ process()

bool switchboard::AdvancedMuteNode::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::AdvancedMuteNode::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.

◆ 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.

◆ setNumberOfBuses()

bool switchboard::AdvancedMuteNode::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.

◆ 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.