Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Loading...
Searching...
No Matches
roc::pipeline::ConverterSink Class Reference

Converter sink pipeline. More...

#include <converter_sink.h>

Inheritance diagram for roc::pipeline::ConverterSink:
roc::sndio::ISink roc::core::NonCopyable< T > roc::sndio::ITerminal roc::audio::IFrameWriter roc::core::ListNode roc::core::NonCopyable< ListNode >

Public Member Functions

 ConverterSink (const ConverterConfig &config, audio::IFrameWriter *output_writer, core::BufferFactory< audio::sample_t > &buffer_factory, core::IAllocator &allocator)
 Initialize.
 
bool valid ()
 Check if the pipeline was successfully constructed.
 
virtual audio::SampleSpec sample_spec () const
 Get sample specification of the sink.
 
virtual core::nanoseconds_t latency () const
 Get latency of the sink.
 
virtual bool has_clock () const
 Check if the sink has own clock.
 
virtual void write (audio::Frame &frame)
 Write audio frame.
 
virtual audio::SampleSpec sample_spec () const =0
 Get sample specification of the terminal.
 
virtual core::nanoseconds_t latency () const =0
 Get latency of the terminal.
 
virtual bool has_clock () const =0
 Check if the terminal has own clock.
 
virtual void write (Frame &frame)=0
 Write audio frame.
 
- Public Member Functions inherited from roc::core::ListNode
ListNodeDatalist_node_data () const
 Get list node data.
 

Detailed Description

Converter sink pipeline.

Remarks
  • input: frames
  • output: frames

Definition at line 36 of file converter_sink.h.

Constructor & Destructor Documentation

◆ ConverterSink()

roc::pipeline::ConverterSink::ConverterSink ( const ConverterConfig config,
audio::IFrameWriter output_writer,
core::BufferFactory< audio::sample_t > &  buffer_factory,
core::IAllocator allocator 
)

Initialize.

Member Function Documentation

◆ has_clock()

virtual bool roc::pipeline::ConverterSink::has_clock ( ) const
virtual

Check if the sink has own clock.

Implements roc::sndio::ITerminal.

◆ latency()

virtual core::nanoseconds_t roc::pipeline::ConverterSink::latency ( ) const
virtual

Get latency of the sink.

Implements roc::sndio::ITerminal.

◆ sample_spec()

virtual audio::SampleSpec roc::pipeline::ConverterSink::sample_spec ( ) const
virtual

Get sample specification of the sink.

Implements roc::sndio::ITerminal.

◆ valid()

bool roc::pipeline::ConverterSink::valid ( )

Check if the pipeline was successfully constructed.

◆ write()

virtual void roc::pipeline::ConverterSink::write ( audio::Frame frame)
virtual

Write audio frame.

Implements roc::audio::IFrameWriter.


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