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

Transcoder sink pipeline. More...

#include <transcoder_sink.h>

Inheritance diagram for roc::pipeline::TranscoderSink:
roc::sndio::ISink roc::core::NonCopyable< Tag > roc::sndio::IDevice roc::audio::IFrameWriter roc::core::ListNode< Tag > roc::core::NonCopyable< Tag >

Public Member Functions

 TranscoderSink (const TranscoderConfig &config, audio::IFrameWriter *output_writer, core::IPool &buffer_pool, core::IArena &arena)
 Initialize.
 
bool is_valid ()
 Check if the pipeline was successfully constructed.
 
virtual sndio::ISinkto_sink ()
 Cast IDevice to ISink.
 
virtual sndio::ISourceto_source ()
 Cast IDevice to ISink.
 
virtual sndio::DeviceType type () const
 Get device type.
 
virtual sndio::DeviceState state () const
 Get device state.
 
virtual void pause ()
 Pause reading.
 
virtual bool resume ()
 Resume paused reading.
 
virtual bool restart ()
 Restart reading from the beginning.
 
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_latency () const
 Check if the sink supports latency reports.
 
virtual bool has_clock () const
 Check if the sink has own clock.
 
virtual void write (audio::Frame &frame)
 Write audio frame.
 
virtual ISinkto_sink ()=0
 Cast IDevice to ISink.
 
virtual ISourceto_source ()=0
 Cast IDevice to ISink.
 
virtual DeviceType type () const =0
 Get device type.
 
virtual DeviceState state () const =0
 Get device state.
 
virtual void pause ()=0
 Pause device.
 
virtual bool resume ()=0
 Resume device after pause.
 
virtual bool restart ()=0
 Restart device.
 
virtual audio::SampleSpec sample_spec () const =0
 Get sample specification of the device.
 
virtual core::nanoseconds_t latency () const =0
 Get latency of the device.
 
virtual bool has_latency () const =0
 Check if the device supports latency reports.
 
virtual bool has_clock () const =0
 Check if the device has own clock.
 
virtual void write (Frame &frame)=0
 Write audio frame.
 
- Public Member Functions inherited from roc::core::ListNode< Tag >
ListDatalist_data () const
 Get pointer to internal data.
 

Additional Inherited Members

- Static Public Member Functions inherited from roc::core::ListNode< Tag >
static ListNodelist_node (ListData *data)
 Get pointer to parent node from pointer to internal data.
 

Detailed Description

Transcoder sink pipeline.

Remarks
  • input: frames
  • output: frames

Definition at line 34 of file transcoder_sink.h.

Constructor & Destructor Documentation

◆ TranscoderSink()

roc::pipeline::TranscoderSink::TranscoderSink ( const TranscoderConfig config,
audio::IFrameWriter output_writer,
core::IPool buffer_pool,
core::IArena arena 
)

Initialize.

Member Function Documentation

◆ has_clock()

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

Check if the sink has own clock.

Implements roc::sndio::IDevice.

◆ has_latency()

virtual bool roc::pipeline::TranscoderSink::has_latency ( ) const
virtual

Check if the sink supports latency reports.

Implements roc::sndio::IDevice.

◆ is_valid()

bool roc::pipeline::TranscoderSink::is_valid ( )

Check if the pipeline was successfully constructed.

◆ latency()

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

Get latency of the sink.

Implements roc::sndio::IDevice.

◆ pause()

virtual void roc::pipeline::TranscoderSink::pause ( )
virtual

Pause reading.

Implements roc::sndio::IDevice.

◆ restart()

virtual bool roc::pipeline::TranscoderSink::restart ( )
virtual

Restart reading from the beginning.

Implements roc::sndio::IDevice.

◆ resume()

virtual bool roc::pipeline::TranscoderSink::resume ( )
virtual

Resume paused reading.

Implements roc::sndio::IDevice.

◆ sample_spec()

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

Get sample specification of the sink.

Implements roc::sndio::IDevice.

◆ state()

virtual sndio::DeviceState roc::pipeline::TranscoderSink::state ( ) const
virtual

Get device state.

Implements roc::sndio::IDevice.

◆ to_sink()

virtual sndio::ISink * roc::pipeline::TranscoderSink::to_sink ( )
virtual

Cast IDevice to ISink.

Implements roc::sndio::IDevice.

◆ to_source()

virtual sndio::ISource * roc::pipeline::TranscoderSink::to_source ( )
virtual

Cast IDevice to ISink.

Implements roc::sndio::IDevice.

◆ type()

virtual sndio::DeviceType roc::pipeline::TranscoderSink::type ( ) const
virtual

Get device type.

Implements roc::sndio::IDevice.

◆ write()

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

Write audio frame.

Implements roc::audio::IFrameWriter.


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