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:

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.
 

Detailed Description

Used by Pipe class, should not be instantiated elsewhere.

PipeSinkNode.

Member Function Documentation

◆ consume()

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

Consumes audio data from the given bus.

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

◆ setBusFormat()

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

Sets bus format.

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