roc::node::SenderEncoder Class Reference

Sender encoder node. More...

#include <sender_encoder.h>

Inheritance diagram for roc::node::SenderEncoder:

Collaboration diagram for roc::node::SenderEncoder:

Public Member Functions
	SenderEncoder (Context &context, const pipeline::SenderConfig &pipeline_config)
	Initialize. More...
	~SenderEncoder ()
	Deinitialize. More...
bool	is_valid () const
	Check if successfully constructed. More...
bool	activate (address::Interface iface, address::Protocol proto)
	Activate interface. More...
bool	get_metrics (pipeline::SenderSlotMetrics &slot_metrics, pipeline::SenderSessionMetrics &sess_metrics)
	Get metrics. More...
bool	is_complete ()
	Check if everything is connected. More...
ROC_ATTR_NODISCARD status::StatusCode	read (address::Interface iface, packet::PacketPtr &packet)
	Read encoded packet. More...
sndio::ISink &	sink ()
	Sink for writing frames for encoding. More...
Public Member Functions inherited from roc::node::Node
	Node (Context &context)
	Initialize. More...
virtual	~Node ()
	Deinitialize. More...
Context &	context ()
	All nodes hold reference to context. More...

Detailed Description

Sender encoder node.

Definition at line 33 of file sender_encoder.h.

Constructor & Destructor Documentation

SenderEncoder()

roc::node::SenderEncoder::SenderEncoder	(	Context &	context,
		const pipeline::SenderConfig &	pipeline_config
	)

Initialize.

~SenderEncoder()

roc::node::SenderEncoder::~SenderEncoder

(

)

Deinitialize.

Member Function Documentation

activate()

bool roc::node::SenderEncoder::activate	(	address::Interface	iface,
		address::Protocol	proto
	)

Activate interface.

get_metrics()

bool roc::node::SenderEncoder::get_metrics	(	pipeline::SenderSlotMetrics &	slot_metrics,
		pipeline::SenderSessionMetrics &	sess_metrics
	)

Get metrics.

is_complete()

bool roc::node::SenderEncoder::is_complete

(

)

Check if everything is connected.

is_valid()

bool roc::node::SenderEncoder::is_valid

(

)

const

Check if successfully constructed.

read()

ROC_ATTR_NODISCARD status::StatusCode roc::node::SenderEncoder::read	(	address::Interface	iface,
		packet::PacketPtr &	packet
	)

Read encoded packet.

sink()

sndio::ISink& roc::node::SenderEncoder::sink

(

)

Sink for writing frames for encoding.

---

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

• roc_node/sender_encoder.h