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
	SingleBusAudioProcessorNode ()
	SingleBusAudioProcessorNode constructor.
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	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
	AudioProcessorNode (const uint numberOfInputs, const uint numberOfOutputs)
virtual	~AudioProcessorNode ()=default
	AudioProcessorNode virtual destructor.
Public Member Functions inherited from switchboard::AudioNode
	AudioNode (const uint numberOfInputs, const uint numberOfOutputs)
	AudioNode constructor.
virtual	~AudioNode ()=default
	AudioNode virtual destructor.
virtual 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.
Result< void >	setValue (const std::string &key, const std::any &value) override
	Sets a value on the object.
Result< std::any >	getValue (const std::string &key) override
	Gets a value from the object.
Result< std::any >	callAction (const std::string &actionName, const std::map< std::string, std::any > &params) override
	Calls an action on the object.
Public Member Functions inherited from switchboard::Node
	Node (const uint numberOfInputs, const uint numberOfOutputs)
	Node constructor.
const std::string &	getType () const
	Gets the type of the node.
unsigned int	getNumberOfInputs () const
	Gets the number of inputs for the node.
unsigned int	getNumberOfOutputs () const
	Gets the number of outputs for the node.
Result< std::any >	getValue (const std::string &key) override
	Gets a value from the object.
Result< void >	setValue (const std::string &key, const std::any &value) override
	Sets a value on the object.
Result< std::any >	callAction (const std::string &actionName, const std::map< std::string, std::any > &params) override
	Calls an action on the object.
Public Member Functions inherited from switchboard::SwitchboardObject
	SwitchboardObject (const std::string &objectType)
	~SwitchboardObject () override=default
	SwitchboardObject destructor.
Public Member Functions inherited from switchboard::EventEmitter
	EventEmitter ()
	Constructor for the EventEmitter class.
virtual	~EventEmitter ()
	Destructor for the EventEmitter class.
unsigned int	addEventListener (const std::string &eventName, EventCallback callback)
	Adds a new event listener to the object.
bool	removeEventListener (unsigned int listenerID)
	Removes an event listener from the object.

Additional Inherited Members
Public Attributes inherited from switchboard::Node
std::string	name
	The name of the node.
Protected Member Functions inherited from switchboard::AudioNode
void	initParameters (const std::map< std::string, std::any > &config)
	Initializes the node parameters from the given configuration values.
Protected Member Functions inherited from switchboard::EventEmitter
void	emitEvent (const std::string &eventName, const EventData &data)
	Emits an event.
Protected Attributes inherited from switchboard::AudioNode
std::vector< std::unique_ptr< Parameter > >	parameters
Protected Attributes inherited from switchboard::Node
std::string	type
unsigned int	numberOfInputs
unsigned int	numberOfOutputs

Detailed Description

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

SingleBusAudioProcessorNode class.

Constructor & Destructor Documentation

SingleBusAudioProcessorNode()

switchboard::SingleBusAudioProcessorNode::SingleBusAudioProcessorNode ( )

inline

SingleBusAudioProcessorNode constructor.

Initializes a SingleBusAudioProcessorNode with a single input and output bus.

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.

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.

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.

---

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

• SingleBusAudioProcessorNode.hpp