Switchboard SDK
Loading...
Searching...
No Matches
switchboard::AudioNode Class Reference

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

#include <AudioNode.hpp>

Inheritance diagram for switchboard::AudioNode:
switchboard::AudioProcessorNode switchboard::AudioSinkNode switchboard::AudioSourceNode switchboard::AdvancedMuteNode switchboard::BusSelectNode switchboard::BusSplitterNode switchboard::BusSwitchNode switchboard::ChannelSplitterNode switchboard::CrossfaderNode switchboard::InvertNode switchboard::MixerNode switchboard::MonoBusMergerNode switchboard::MusicDuckingNode switchboard::MusicDuckingV2Node switchboard::SingleBusAudioProcessorNode switchboard::StereoBusMergerNode switchboard::SubgraphProcessorNode switchboard::AudioGraphOutputNode switchboard::DiscardNode switchboard::SingleBusAudioSinkNode switchboard::SubgraphSinkNode switchboard::AudioGraphInputNode switchboard::SilenceNode switchboard::SingleBusAudioSourceNode switchboard::SubgraphSourceNode

Public Member Functions

 AudioNode ()
 AudioNode constructor.
 
virtual ~AudioNode ()=default
 AudioNode virtual destructor.
 
const std::string & getType () const
 Gets the type of the audio node.
 
virtual const 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 ParametergetParameter (const std::string &id)
 Gets the parameter with the given name.
 

Public Attributes

std::string name
 The name of the audio node.
 

Protected Member Functions

void initParameters (std::map< std::string, std::any > config)
 Initializes the node parameters from the given configuration values.
 

Protected Attributes

std::string type
 
std::vector< std::unique_ptr< Parameter > > parameters
 

Detailed Description

Represents a node in the audio graph.

AudioNode class.

Member Function Documentation

◆ getDisplayName()

const 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()

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

Gets the parameter with the given name.

Parameters
idThe ID of the parameter.
Returns
Returns a pointer to the parameter, nullptr if not found.

◆ getParameters()

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.

◆ getType()

const std::string & switchboard::AudioNode::getType ( ) const

Gets the type of the audio node.

Returns
The type of the audio node.

◆ initParameters()

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

Initializes the node parameters from the given configuration values.

Parameters
configConfiguration values for the parameters.