switchboard::MuteNode Class Reference

Node that mutes and unmutes an audio stream. More...

#include <MuteNode.hpp>

Inheritance diagram for switchboard::MuteNode:

Public Member Functions
WASM	MuteNode ()
	MuteNode constructor.
WASM bool	getIsMuted () const
	Returns whether the node is muting or not.
WASM void	setIsMuted (const bool newValue)
	Enables or disables muting.
WASM bool	setBusFormat (AudioBusFormat &inputBusFormat, AudioBusFormat &outputBusFormat) override
	Sets bus format.
WASM bool	process (AudioBus &inBus, AudioBus &outBus) override
	Processes audio data from the given input bus and produces the audio output to the given output bus.
Public Member Functions inherited from switchboard::SingleBusAudioProcessorNode
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 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

Node that mutes and unmutes an audio stream.

MuteNode class.

Member Function Documentation

getIsMuted()

bool switchboard::MuteNode::getIsMuted

(

)

const

Returns whether the node is muting or not.

Returns

True if the node is muting the audio stream, false otherwise.

process()

bool switchboard::MuteNode::process ( AudioBus & inBus, AudioBus & outBus )

overridevirtual

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

Should be overridden by subclasses.

Parameters

inBus	The input bus that contain the audio data.
outBus	The output bus which should be filled with the processed audio data.

Returns

True if audio was processed successfully, false otherwise.

Implements switchboard::SingleBusAudioProcessorNode.

setBusFormat()

bool switchboard::MuteNode::setBusFormat ( AudioBusFormat & inputBusFormat, AudioBusFormat & outputBusFormat )

overridevirtual

Sets bus format.

Should be overridden by subclasses.

Parameters

inputBusFormat	The input bus format to set.
outputBusFormat	The output bus format to set.

Returns

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

Implements switchboard::SingleBusAudioProcessorNode.

setIsMuted()

void switchboard::MuteNode::setIsMuted

(

const bool

newValue

)

Enables or disables muting.

Parameters

newValue

The new muting setting.