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

Converts a multi-channel audio bus to a mono audio bus. More...

#include <MultiChannelToMonoNode.hpp>

Inheritance diagram for switchboard::MultiChannelToMonoNode:
switchboard::SingleBusAudioProcessorNode switchboard::AudioProcessorNode switchboard::AudioNode

Public Member Functions

WASM MultiChannelToMonoNode ()
 Initializes a MultiChannelToMono instance.
 
WASM void setNormalize (const bool normalize)
 Enables signal normalization to the largest signal after mixing.
 
WASM bool getNormalize () const
 Gets if signal normalization to the largest signal after mixing is enabled.
 
WASM bool setBusFormat (AudioBusFormat &inputBusFormat, AudioBusFormat &outputBusFormat)
 Sets bus format.
 
WASM bool process (AudioBus &inBus, AudioBus &outBus)
 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 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

Converts a multi-channel audio bus to a mono audio bus.

Member Function Documentation

◆ getNormalize()

bool switchboard::MultiChannelToMonoNode::getNormalize ( ) const

Gets if signal normalization to the largest signal after mixing is enabled.

Returns
True if the signals have to be normalized to the largest signal after mixing.

◆ process()

bool switchboard::MultiChannelToMonoNode::process ( AudioBus & inBus,
AudioBus & outBus )
virtual

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

Should be overridden by subclasses.

Parameters
inBusThe input bus that contain the audio data.
outBusThe 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::MultiChannelToMonoNode::setBusFormat ( AudioBusFormat & inputBusFormat,
AudioBusFormat & outputBusFormat )
virtual

Sets bus format.

Should be overridden by subclasses.

Parameters
inputBusFormatThe input bus format to set.
outputBusFormatThe output bus format to set.
Returns
True if the bus formats were set successfully, false otherwise.

Implements switchboard::SingleBusAudioProcessorNode.

◆ setNormalize()

void switchboard::MultiChannelToMonoNode::setNormalize ( const bool normalize)

Enables signal normalization to the largest signal after mixing.

Parameters
normalizeTrue if the signals have to be normalized to the largest signal after mixing.