Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::pipeline::TranscoderSource Class Reference

Transcoder source pipeline. More...

#include <transcoder_source.h>

Inheritance diagram for roc::pipeline::TranscoderSource:
Collaboration diagram for roc::pipeline::TranscoderSource:

Public Member Functions

 TranscoderSource (const TranscoderConfig &config, sndio::ISource &input_source, core::IPool &buffer_pool, core::IArena &arena)
 Initialize. More...
 
bool is_valid ()
 Check if the pipeline was successfully constructed. More...
 
virtual sndio::ISinkto_sink ()
 Cast IDevice to ISink. More...
 
virtual sndio::ISourceto_source ()
 Cast IDevice to ISink. More...
 
virtual sndio::DeviceType type () const
 Get device type. More...
 
virtual sndio::DeviceState state () const
 Get device state. More...
 
virtual void pause ()
 Pause reading. More...
 
virtual bool resume ()
 Resume paused reading. More...
 
virtual bool restart ()
 Restart reading from the beginning. More...
 
virtual audio::SampleSpec sample_spec () const
 Get sample specification of the source. More...
 
virtual core::nanoseconds_t latency () const
 Get latency of the source. More...
 
virtual bool has_latency () const
 Check if the source supports latency reports. More...
 
virtual bool has_clock () const
 Check if the sink has own clock. More...
 
virtual void reclock (core::nanoseconds_t timestamp)
 Adjust source clock to match consumer clock. More...
 
virtual bool read (audio::Frame &)
 Read frame. More...
 
- Public Member Functions inherited from roc::core::ListNode< Tag >
ListDatalist_data () const
 Get pointer to internal data. More...
 

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. More...
 

Detailed Description

Transcoder source pipeline.

Remarks
  • input: frames
  • output: frames

Definition at line 33 of file transcoder_source.h.

Constructor & Destructor Documentation

◆ TranscoderSource()

roc::pipeline::TranscoderSource::TranscoderSource ( const TranscoderConfig config,
sndio::ISource input_source,
core::IPool buffer_pool,
core::IArena arena 
)

Initialize.

Member Function Documentation

◆ has_clock()

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

Check if the sink has own clock.

Implements roc::sndio::IDevice.

◆ has_latency()

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

Check if the source supports latency reports.

Implements roc::sndio::IDevice.

◆ is_valid()

bool roc::pipeline::TranscoderSource::is_valid ( )

Check if the pipeline was successfully constructed.

◆ latency()

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

Get latency of the source.

Implements roc::sndio::IDevice.

◆ pause()

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

Pause reading.

Implements roc::sndio::IDevice.

◆ read()

virtual bool roc::pipeline::TranscoderSource::read ( audio::Frame )
virtual

Read frame.

Implements roc::audio::IFrameReader.

◆ reclock()

virtual void roc::pipeline::TranscoderSource::reclock ( core::nanoseconds_t  timestamp)
virtual

Adjust source clock to match consumer clock.

Implements roc::sndio::ISource.

◆ restart()

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

Restart reading from the beginning.

Implements roc::sndio::IDevice.

◆ resume()

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

Resume paused reading.

Implements roc::sndio::IDevice.

◆ sample_spec()

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

Get sample specification of the source.

Implements roc::sndio::IDevice.

◆ state()

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

Get device state.

Implements roc::sndio::IDevice.

◆ to_sink()

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

Cast IDevice to ISink.

Implements roc::sndio::IDevice.

◆ to_source()

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

Cast IDevice to ISink.

Implements roc::sndio::IDevice.

◆ type()

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

Get device type.

Implements roc::sndio::IDevice.


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