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

Used by Pipe class, should not be instantiated elsewhere. More...

#include <PipeSinkNode.hpp>

Inheritance diagram for switchboard::PipeSinkNode:
switchboard::SingleBusAudioSinkNode switchboard::AudioSinkNode switchboard::AudioNode

Public Member Functions

 PipeSinkNode (Pipe *pipe)
 Instantiates a PipeSinkNode. Should only be used by Pipe.
 
bool setBusFormat (AudioBusFormat &busFormat) override
 Sets bus format.
 
bool consume (AudioBus &bus) override
 Consumes audio data from the given bus.
 
- Public Member Functions inherited from switchboard::SingleBusAudioSinkNode
bool setNumberOfBuses (const uint numberOfBuses) override
 Sets number of buses.
 
bool setBusFormats (AudioBusFormatList &busFormats) override
 Sets bus formats.
 
bool consume (AudioBusList &buses) override
 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 &name)
 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 Attributes inherited from switchboard::AudioNode
std::string type
 
std::vector< std::unique_ptr< Parameter > > parameters
 

Detailed Description

Used by Pipe class, should not be instantiated elsewhere.

PipeSinkNode.

Member Function Documentation

◆ consume()

bool switchboard::PipeSinkNode::consume ( AudioBus & bus)
overridevirtual

Consumes audio data from the given bus.

Parameters
busThe bus that contain the audio data.
Returns
True if audio was consumed successfully, false otherwise.

Implements switchboard::SingleBusAudioSinkNode.

◆ setBusFormat()

bool switchboard::PipeSinkNode::setBusFormat ( AudioBusFormat & busFormat)
overridevirtual

Sets bus format.

Parameters
busFormatThe bus format to set.
Returns
True if the bus format was set successfully, false otherwise.

Implements switchboard::SingleBusAudioSinkNode.