Switchboard SDK
Loading...
Searching...
No Matches
switchboard::AudioSinkNode Class Referenceabstract

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

#include <AudioSinkNode.hpp>

Inheritance diagram for switchboard::AudioSinkNode:
switchboard::AudioNode switchboard::AudioGraphOutputNode switchboard::DiscardNode switchboard::SingleBusAudioSinkNode switchboard::SubgraphSinkNode switchboard::ClippingDetectorNode switchboard::PipeSinkNode switchboard::RecorderNode switchboard::ResampledSinkNode switchboard::VUMeterNode switchboard::VoiceActivityDetectorNode

Public Member Functions

virtual bool setNumberOfBuses (const uint numberOfBuses)=0
 Sets number of buses.
 
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 ()
 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.
 

Additional Inherited Members

- Public Attributes inherited from switchboard::AudioNode
std::string name
 The name of the audio node.
 
- Protected Member Functions inherited from switchboard::AudioNode
void initParameters (std::map< std::string, std::any > config)
 Initializes the node parameters from the given configuration values.
 
- Protected Attributes inherited from switchboard::AudioNode
std::string type
 
std::vector< std::unique_ptr< Parameter > > parameters
 

Detailed Description

A node that consumes audio and only has incoming connections.

AudioSinkNode class.

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
busesThe buses that contain the audio data.
Returns
True if audio was consumed successfully, false otherwise.

Implemented in switchboard::AudioGraphOutputNode, switchboard::DiscardNode, switchboard::SingleBusAudioSinkNode, and switchboard::SubgraphSinkNode.

◆ setBusFormats()

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

Sets bus formats.

Should be overridden by subclasses.

Parameters
busFormatsThe bus formats to set.
Returns
True if the bus formats were set successfully, false otherwise.

Implemented in switchboard::AudioGraphOutputNode, switchboard::DiscardNode, switchboard::SingleBusAudioSinkNode, and switchboard::SubgraphSinkNode.

◆ setNumberOfBuses()

virtual bool switchboard::AudioSinkNode::setNumberOfBuses ( const uint numberOfBuses)
pure virtual

Sets number of buses.

Should be overridden by subclasses.

Parameters
numberOfBusesThe number of buses to set.
Returns
True if the number of buses was set successfully, false otherwise.

Implemented in switchboard::AudioGraphOutputNode, switchboard::DiscardNode, switchboard::SingleBusAudioSinkNode, and switchboard::SubgraphSinkNode.