switchboard::AudioSinkNode Class Reference

A node that consumes audio and only has incoming connections. More...

#include <AudioSinkNode.hpp>

Inheritance diagram for switchboard::AudioSinkNode:

Public Member Functions
	AudioSinkNode (const uint numberOfInputs)
	AudioSinkNode constructor.
virtual bool	setBusFormats (AudioBusFormatList &busFormats)=0
	Sets bus formats.
virtual bool	consume (AudioBusList &buses)=0
	Consumes audio data from the given buses.
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

A node that consumes audio and only has incoming connections.

AudioSinkNode class.

Constructor & Destructor Documentation

AudioSinkNode()

switchboard::AudioSinkNode::AudioSinkNode ( const uint numberOfInputs )

inline

AudioSinkNode constructor.

Initializes an AudioSinkNode with the specified number of inputs.

Parameters

numberOfInputs

The number of inputs for the audio sink node.

Member Function Documentation

consume()

virtual bool switchboard::AudioSinkNode::consume ( AudioBusList & buses )

pure virtual

Consumes audio data from the given buses.

Should be overridden by subclasses.

Parameters

buses

The buses that contain the audio data.

Returns

True if audio was consumed successfully, false otherwise.

Implemented in switchboard::SingleBusAudioSinkNode.

setBusFormats()

virtual bool switchboard::AudioSinkNode::setBusFormats ( AudioBusFormatList & busFormats )

pure virtual

Sets bus formats.

Should be overridden by subclasses.

Parameters

busFormats

The bus formats to set.

Returns

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

Implemented in switchboard::SingleBusAudioSinkNode.

---

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

• AudioSinkNode.hpp