roc::pipeline::ReceiverSource Class Reference

Receiver source pipeline. More...

#include <roc_pipeline/receiver_source.h>

Inheritance diagram for roc::pipeline::ReceiverSource:

Public Member Functions
	ReceiverSource (const ReceiverSourceConfig &source_config, const rtp::EncodingMap &encoding_map, core::IPool &packet_pool, core::IPool &packet_buffer_pool, core::IPool &frame_buffer_pool, core::IArena &arena)
	Initialize.
bool	is_valid () const
	Check if the pipeline was successfully constructed.
ReceiverSlot *	create_slot (const ReceiverSlotConfig &slot_config)
	Create slot.
void	delete_slot (ReceiverSlot *slot)
	Delete slot.
size_t	num_sessions () const
	Get number of active sessions.
core::nanoseconds_t	refresh (core::nanoseconds_t current_time)
	Pull packets and refresh pipeline according to current time.
virtual sndio::ISink *	to_sink ()
	Cast IDevice to ISink.
virtual sndio::ISource *	to_source ()
	Cast IDevice to ISink.
virtual sndio::DeviceType	type () const
	Get device type.
virtual sndio::DeviceState	state () const
	Get current receiver 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 source.
virtual core::nanoseconds_t	latency () const
	Get latency of the source.
virtual bool	has_latency () const
	Check if the source supports latency reports.
virtual bool	has_clock () const
	Check if the source has own clock.
virtual void	reclock (core::nanoseconds_t playback_time)
	Adjust sessions clock to match consumer clock.
virtual bool	read (audio::Frame &)
	Read audio frame.
Public Member Functions inherited from roc::core::ListNode< Tag >
ListData *	list_data () const
	Get pointer to internal data.

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

Detailed Description

Receiver source pipeline.

Contains:

• one or more receiver slots
• mixer, to mix audio from all slots

Pipeline:

• input: packets
• output: frames

Definition at line 43 of file receiver_source.h.

Constructor & Destructor Documentation

ReceiverSource()

roc::pipeline::ReceiverSource::ReceiverSource	(	const ReceiverSourceConfig &	source_config,
		const rtp::EncodingMap &	encoding_map,
		core::IPool &	packet_pool,
		core::IPool &	packet_buffer_pool,
		core::IPool &	frame_buffer_pool,
		core::IArena &	arena
	)

Initialize.

Member Function Documentation

create_slot()

ReceiverSlot * roc::pipeline::ReceiverSource::create_slot

(

const ReceiverSlotConfig &

slot_config

)

Create slot.

delete_slot()

void roc::pipeline::ReceiverSource::delete_slot

(

ReceiverSlot *

slot

)

Delete slot.

has_clock()

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

virtual

Check if the source has own clock.

Implements roc::sndio::IDevice.

has_latency()

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

virtual

Check if the source supports latency reports.

Implements roc::sndio::IDevice.

is_valid()

bool roc::pipeline::ReceiverSource::is_valid

(

)

const

Check if the pipeline was successfully constructed.

latency()

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

virtual

Get latency of the source.

Implements roc::sndio::IDevice.

num_sessions()

size_t roc::pipeline::ReceiverSource::num_sessions

(

)

const

Get number of active sessions.

pause()

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

virtual

Pause reading.

Implements roc::sndio::IDevice.

read()

virtual bool roc::pipeline::ReceiverSource::read ( audio::Frame &  )

virtual

Read audio frame.

Implements roc::audio::IFrameReader.

reclock()

virtual void roc::pipeline::ReceiverSource::reclock ( core::nanoseconds_t  playback_time )

virtual

Adjust sessions clock to match consumer clock.

Remarks

playback_time specified absolute time when first sample of last frame retrieved from pipeline will be actually played on sink

Implements roc::sndio::ISource.

refresh()

core::nanoseconds_t roc::pipeline::ReceiverSource::refresh

(

core::nanoseconds_t

current_time

)

Pull packets and refresh pipeline according to current time.

Remarks

Should be invoked before reading each frame. Also should be invoked after provided deadline if no frames were read until that deadline expires.

Returns

deadline (absolute time) when refresh should be invoked again if there are no frames

restart()

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

virtual

Restart reading from the beginning.

Implements roc::sndio::IDevice.

resume()

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

virtual

Resume paused reading.

Implements roc::sndio::IDevice.

sample_spec()

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

virtual

Get sample specification of the source.

Implements roc::sndio::IDevice.

state()

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

virtual

Get current receiver state.

Implements roc::sndio::IDevice.

to_sink()

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

virtual

Cast IDevice to ISink.

Implements roc::sndio::IDevice.

to_source()

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

virtual

Cast IDevice to ISink.

Implements roc::sndio::IDevice.

type()

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

virtual

Get device type.

Implements roc::sndio::IDevice.

---

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

• roc_pipeline/receiver_source.h