switchboard::AudioNode Class Reference

Represents a node in the audio graph. More...

#include <AudioNode.hpp>

Inheritance diagram for switchboard::AudioNode:

Public Member Functions
	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.

Protected Member Functions
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
std::vector< std::unique_ptr< Parameter > >	parameters
Protected Attributes inherited from switchboard::Node
std::string	type
unsigned int	numberOfInputs
unsigned int	numberOfOutputs

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.

Detailed Description

Represents a node in the audio graph.

AudioNode class.

Constructor & Destructor Documentation

AudioNode()

switchboard::AudioNode::AudioNode	(	uint	numberOfInputs,
		uint	numberOfOutputs )

AudioNode constructor.

Parameters

numberOfInputs	The number of inputs for the audio node.
numberOfOutputs	The number of outputs for the audio node.

Member Function Documentation

callAction()

Result< std::any > switchboard::AudioNode::callAction ( const std::string & actionName, const std::map< std::string, std::any > & params )

overridevirtual

Calls an action on the object.

Parameters

actionName	The name of the action.
params	The parameters of the action.

Returns

The result of the action.

Reimplemented from switchboard::SwitchboardObject.

getDisplayName()

virtual std::string switchboard::AudioNode::getDisplayName ( ) const

virtual

Gets the display name of the audio node.

By default the display name follows this format: name (type)

Returns

The display name of the node.

getParameter()

virtual Parameter * switchboard::AudioNode::getParameter ( const std::string & id )

virtual

Gets the parameter with the given name.

Parameters

id	The ID of the parameter.

Returns

Returns a pointer to the parameter, nullptr if not found.

getParameters()

virtual std::vector< std::unique_ptr< Parameter > > & switchboard::AudioNode::getParameters ( )

virtual

Gets the parameters of the audio node.

Returns

A list of parameters that belong to the audio node.

getValue()

Result< std::any > switchboard::AudioNode::getValue ( const std::string & key )

overridevirtual

Gets a value from the object.

Parameters

key	The key of the value.

Returns

The value.

Reimplemented from switchboard::SwitchboardObject.

initParameters()

void switchboard::AudioNode::initParameters ( const std::map< std::string, std::any > & config )

protected

Initializes the node parameters from the given configuration values.

Parameters

config

Configuration values for the parameters.

setValue()

Result< void > switchboard::AudioNode::setValue ( const std::string & key, const std::any & value )

overridevirtual

Sets a value on the object.

Parameters

key	The key of the value.
value	The value to set.

Returns

A successful result if the value was set successfully, an error result otherwise.

Reimplemented from switchboard::SwitchboardObject.

---

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

• AudioNode.hpp