switchboard::SingleBusAudioProcessorNode Class Reference

Provides a simplified interface for AudioProcessorNode which is useful when only a single bus is supported by the audio processor. More...

#include <SingleBusAudioProcessorNode.hpp>

Inheritance diagram for switchboard::SingleBusAudioProcessorNode:

Public Member Functions
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.
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 &name)
	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 Attributes inherited from switchboard::AudioNode
std::string	type
std::vector< std::unique_ptr< Parameter > >	parameters

Detailed Description

Provides a simplified interface for AudioProcessorNode which is useful when only a single bus is supported by the audio processor.

SingleBusAudioProcessorNode class.

Member Function Documentation

process() [1/2]

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

pure 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

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.

Implemented in switchboard::MonoToMultiChannelNode, switchboard::MultiChannelToMonoNode, switchboard::ResamplerNode, switchboard::DiagnosticRecorderNode, switchboard::GainNode, switchboard::MuteNode, switchboard::NoiseGateNode, switchboard::OffsetNode, switchboard::PassthroughNode, switchboard::StereoPannerNode, and switchboard::UsageTrackerNode.

process() [2/2]

bool switchboard::SingleBusAudioProcessorNode::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

inBuses	The input buses that contain the audio data.
outBuses	The output buses which should be filled with the processed audio data.

Returns

True if audio was processed successfully, false otherwise.

Implements switchboard::AudioProcessorNode.

setBusFormat()

virtual bool switchboard::SingleBusAudioProcessorNode::setBusFormat ( AudioBusFormat & inputBusFormat, AudioBusFormat & outputBusFormat )

pure virtual

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.

Implemented in switchboard::MonoToMultiChannelNode, switchboard::MultiChannelToMonoNode, switchboard::ResamplerNode, switchboard::DiagnosticRecorderNode, switchboard::GainNode, switchboard::MuteNode, switchboard::NoiseGateNode, switchboard::OffsetNode, switchboard::PassthroughNode, switchboard::StereoPannerNode, and switchboard::UsageTrackerNode.

setBusFormats()

bool switchboard::SingleBusAudioProcessorNode::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

inputBusFormats	The input bus formats to set.
outputBusFormats	The output bus formats to set.

Returns

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

Implements switchboard::AudioProcessorNode.

setNumberOfBuses()

bool switchboard::SingleBusAudioProcessorNode::setNumberOfBuses ( const uint numberOfInputBuses, const uint numberOfOutputBuses )

overridevirtual

Sets number of buses.

Should be overridden by subclasses

Parameters

numberOfInputBuses	The number of input buses to set.
numberOfOutputBuses	The number of output buses to set.

Returns

True for valid number of buses, false otherwise.

Implements switchboard::AudioProcessorNode.