Loading...
Searching...
No Matches
Public Member Functions | List of all members
switchboard::MonoToMultiChannelNode Class Reference

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

#include <MonoToMultiChannelNode.hpp>

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

Public Member Functions

 MonoToMultiChannelNode ()
 Initializes a MonoToMultiChannelNode instance.
 
bool setBusFormat (AudioBusFormat &inputBusFormat, AudioBusFormat &outputBusFormat)
 Sets bus format.
 
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
virtual bool setBusFormat (AudioBusFormat &inputBusFormat, AudioBusFormat &outputBusFormat)=0
 Sets bus format.
 
virtual bool process (AudioBus &inBus, AudioBus &outBus)=0
 Processes audio data from the given input bus and produces the audio output to the given output bus.
 
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.
 
virtual bool setNumberOfBuses (const uint numberOfInputBuses, const uint numberOfOutputBuses)=0
 Sets number of buses.
 
virtual bool setBusFormats (AudioBusFormatList &inputBusFormats, AudioBusFormatList &outputBusFormats)=0
 Sets bus formats.
 
virtual bool process (AudioBusList &inBuses, AudioBusList &outBuses)=0
 Processes audio data from the given input buses and produces the audio output to the given output buses.
 
- Public Member Functions inherited from switchboard::AudioNode
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.
 

Additional Inherited Members

- Public Attributes inherited from switchboard::AudioNode
std::string name
 The name of the audio node.
 
- Protected Attributes inherited from switchboard::AudioNode
std::string type
 

Detailed Description

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

Member Function Documentation

◆ process()

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


The documentation for this class was generated from the following files: