switchboard::PipeSinkNode Class Reference

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

#include <PipeSinkNode.hpp>

Inheritance diagram for switchboard::PipeSinkNode:

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
virtual bool	setBusFormat (AudioBusFormat &busFormat)=0
	Sets bus format.
virtual bool	consume (AudioBus &bus)=0
	Consumes audio data from the given bus.
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.
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
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.

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

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

bus	The 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

busFormat

The bus format to set.

Returns

True if the bus format was set successfully, false otherwise.

Implements switchboard::SingleBusAudioSinkNode.

---

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

• /Users/jenkins/.jenkins/workspace/Switchboard Developer Site - Production/SwitchboardSDK/src/all/AudioGraphNodes/Pipe/PipeSinkNode.hpp
• /Users/jenkins/.jenkins/workspace/Switchboard Developer Site - Production/SwitchboardSDK/src/all/AudioGraphNodes/Pipe/PipeSinkNode.cpp