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

Mixes multiple audio buses into a single audio bus. More...

#include <MixerNode.hpp>

Inheritance diagram for switchboard::MixerNode:
switchboard::AudioProcessorNode switchboard::AudioNode

Public Member Functions

 MixerNode ()
 Creates a MixerNode instance.
 
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 &inAudioBuses, AudioBusList &outAudioBuses) 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

Mixes multiple audio buses into a single audio bus.

MixerNode class.

Member Function Documentation

◆ process()

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

◆ setNumberOfBuses()

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


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