switchboard::SingleBusAudioSourceNode Class Reference

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

#include <SingleBusAudioSourceNode.hpp>

Inheritance diagram for switchboard::SingleBusAudioSourceNode:

Public Member Functions
	SingleBusAudioSourceNode ()
	SingleBusAudioSourceNode constructor.
virtual bool	setBusFormat (AudioBusFormat &busFormat)=0
	Sets bus format.
virtual bool	produce (AudioBus &bus)=0
	Produces audio data in the given bus.
bool	setBusFormats (AudioBusFormatList &busFormats) override
	Sets bus formats.
bool	produce (AudioBusList &buses) override
	Produces audio data in the given buses.
Public Member Functions inherited from switchboard::AudioSourceNode
	AudioSourceNode (const uint numberOfOutputBuses)
	AudioSourceNode constructor.
Public Member Functions inherited from switchboard::AudioNode
	AudioNode (uint numberOfInputs, 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 constructor.
	~SwitchboardObject () override
	SwitchboardObject destructor.
std::string	getObjectID () const
	Gets the ID of the object.
void	setObjectID (const std::string &objectID)
	Sets the ID of the object.
std::string	getObjectType () const
	Gets the type of the object.
SwitchboardObject *	getParentObject () const
	Gets the parent object of the object.
void	setParentObject (SwitchboardObject *parentObject)
	Sets the parent object of the object.
void	registerConfiguration (const std::string &key, const std::map< std::string, std::any > &configuration)
	Registers a configuration for the object.
void	setConfigurationValue (const std::string &key, const std::any &value)
	Sets a configuration value for the object.
void	registerProperty (const std::string &key, const std::map< std::string, std::any > &propertyInfo)
	Registers a property for the object.
void	registerAction (const std::string &key, const std::map< std::string, std::any > &actionInfo)
	Registers an action for the object.
void	registerEvent (const std::string &eventName, const std::map< std::string, std::any > &eventInfo)
	Registers an event for the object.
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, Callback 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 Types inherited from switchboard::EventEmitter
using	Callback = std::function<void(const std::string&, const std::any&)>
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 std::any &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 AudioSourceNode which is useful when only a single bus is supported by the audio source.

SingleBusAudioSourceNode class.

Constructor & Destructor Documentation

SingleBusAudioSourceNode()

switchboard::SingleBusAudioSourceNode::SingleBusAudioSourceNode ( )

inline

SingleBusAudioSourceNode constructor.

Initializes a SingleBusAudioSourceNode with a single output bus.

Member Function Documentation

produce() [1/2]

virtual bool switchboard::SingleBusAudioSourceNode::produce ( AudioBus & bus )

pure virtual

Produces audio data in the given bus.

Should be overridden by subclasses.

Parameters

bus	The bus that should be filled with audio data.

Returns

True if audio was produced successfully, false otherwise.

produce() [2/2]

bool switchboard::SingleBusAudioSourceNode::produce ( AudioBusList & buses )

overridevirtual

Produces audio data in the given buses.

Should be overridden by subclasses.

Parameters

buses

The buses that should be filled with audio data.

Returns

True if audio was produced successfully, false otherwise.

Implements switchboard::AudioSourceNode.

setBusFormat()

virtual bool switchboard::SingleBusAudioSourceNode::setBusFormat ( AudioBusFormat & busFormat )

pure virtual

Sets bus format.

Should be overridden by subclasses.

Parameters

busFormat

The bus format to set.

Returns

True if the bus format was set successfully, false otherwise.

setBusFormats()

bool switchboard::SingleBusAudioSourceNode::setBusFormats ( AudioBusFormatList & busFormats )

overridevirtual

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.

Implements switchboard::AudioSourceNode.

---

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

• SingleBusAudioSourceNode.hpp