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.
	~AudioNode () override=default
	AudioNode virtual destructor.
virtual std::string	getDisplayName () const
	Gets the display name of the audio node.
Public Member Functions inherited from switchboard::Node
	Node (uint numberOfInputs, 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< SBAny >	getValue (const std::string &key) override
	Gets a value from the object.
Result< void >	setValue (const std::string &key, const SBAny &value) override
	Sets a value on the object.
Result< SBAny >	callAction (const std::string &actionName, const SBAnyMap &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	getURI ()
	Gets the URI of the object.
std::string	getObjectType () const
	Gets the type of the object.
std::optional< std::string >	getObjectSubtype () const
	Gets the subtype of the object.
void	setObjectSubtype (std::optional< std::string > subtype)
	Sets the subtype 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 SBAnyMap &configuration)
	Registers a configuration for the object.
void	setConfigurationValue (const std::string &key, const SBAny &value)
	Sets a configuration value for the object.
void	registerProperty (const std::string &key, const SBAnyMap &propertyInfo)
	Registers a property for the object.
void	registerAction (const std::string &key, const SBAnyMap &actionInfo)
	Registers an action for the object.
void	registerEvent (const std::string &eventName, const SBAnyMap &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 SBAny&)>
Protected Member Functions inherited from switchboard::EventEmitter
void	emitEvent (const std::string &eventName, const SBAny &data)
	Emits an event.
Protected Attributes inherited from switchboard::Node
std::string	type
	The type of the node.
unsigned int	numberOfInputs
	The number of inputs (audio buses) for the node.
unsigned int	numberOfOutputs
	The number of outputs (audio buses) for the node.
std::string	title
	The title of the node that can be displayed in the UI.

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

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.

---

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

• AudioNode.hpp