roc::pipeline::Receiver Class Reference

Receiver pipeline. More...

#include <receiver.h>

Inheritance diagram for roc::pipeline::Receiver:

Public Member Functions
	Receiver (const ReceiverConfig &config, const fec::CodecMap &codec_map, const rtp::FormatMap &format_map, packet::PacketPool &packet_pool, core::BufferPool< uint8_t > &byte_buffer_pool, core::BufferPool< audio::sample_t > &sample_buffer_pool, core::IAllocator &allocator)
	Initialize. More...
bool	valid ()
	Check if the pipeline was successfully constructed. More...
bool	add_port (const PortConfig &config)
	Add receiving port. More...
void	iterate_ports (void(*fn)(void *, const PortConfig &), void *arg) const
	Iterate added ports. More...
size_t	num_sessions () const
	Get number of alive sessions. More...
virtual State	state () const
	Get current receiver state. More...
virtual void	wait_active () const
	Wait until the receiver status becomes active. More...
virtual size_t	sample_rate () const
	Get source sample rate. More...
virtual bool	has_clock () const
	Check if the source has own clock. More...
virtual void	write (const packet::PacketPtr &)
	Write packet. More...
virtual bool	read (audio::Frame &)
	Read frame. More...
virtual size_t	sample_rate () const =0
	Get source sample rate. More...
virtual bool	has_clock () const =0
	Check if the source has own clock. More...
virtual State	state () const =0
	Get current source state. More...
virtual void	wait_active () const =0
	Wait until the source state becomes active. More...
virtual bool	read (audio::Frame &)=0
	Read frame. More...
virtual void	write (const PacketPtr &)=0
	Write packet. More...

Additional Inherited Members
Public Types inherited from roc::sndio::ISource
enum	State { Active , Inactive }
	Source state. More...

Detailed Description

Receiver pipeline.

Definition at line 39 of file receiver.h.

Constructor & Destructor Documentation

Receiver()

roc::pipeline::Receiver::Receiver	(	const ReceiverConfig &	config,
		const fec::CodecMap &	codec_map,
		const rtp::FormatMap &	format_map,
		packet::PacketPool &	packet_pool,
		core::BufferPool< uint8_t > &	byte_buffer_pool,
		core::BufferPool< audio::sample_t > &	sample_buffer_pool,
		core::IAllocator &	allocator
	)

Initialize.

Member Function Documentation

add_port()

bool roc::pipeline::Receiver::add_port

(

const PortConfig &

config

)

Add receiving port.

has_clock()

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

virtual

Check if the source has own clock.

Implements roc::sndio::ISource.

iterate_ports()

void roc::pipeline::Receiver::iterate_ports	(	void(*)(void *, const PortConfig &)	fn,
		void *	arg
	)		const

Iterate added ports.

num_sessions()

size_t roc::pipeline::Receiver::num_sessions

(

)

const

Get number of alive sessions.

read()

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

virtual

Read frame.

Implements roc::sndio::ISource.

sample_rate()

virtual size_t roc::pipeline::Receiver::sample_rate ( ) const

virtual

Get source sample rate.

Implements roc::sndio::ISource.

state()

virtual State roc::pipeline::Receiver::state ( ) const

virtual

Get current receiver state.

Implements roc::sndio::ISource.

valid()

bool roc::pipeline::Receiver::valid

(

)

Check if the pipeline was successfully constructed.

wait_active()

virtual void roc::pipeline::Receiver::wait_active ( ) const

virtual

Wait until the receiver status becomes active.

Implements roc::sndio::ISource.

write()

virtual void roc::pipeline::Receiver::write ( const packet::PacketPtr &  )

virtual

Write packet.

Implements roc::packet::IWriter.

---

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

• roc_pipeline/receiver.h