VideoSenderOptions Class

Declaration

class simaai::neat::nodes::groups::VideoSenderOptions { ... }

Included Headers

#include <VideoSender.h>

Enumerations Index

enum class	InputKind { ... }

Friends Index

simaai::neat::Graph	VideoSender

Private Constructors Index

	VideoSenderOptions ()=default

Public Member Functions Index

bool	is_raw_input () const
bool	is_encoded_input () const
int	width () const
	Fixed legacy input width, or zero when resolution follows the input. More...
int	height () const
	Fixed legacy input height, or zero when resolution follows the input. More...
int	fps () const
int	video_port () const

Public Member Attributes Index

std::string	host = "127.0.0.1"
int	channel = 0
int	video_port_base = 9000
bool	sync = false
	Wait for packet timestamps against the pipeline clock. More...
bool	async = false
	Permit the sink to wait for its first preroll buffer. More...
VideoSenderRtpOptions	rtp {}
VideoSenderEncoderOptions	encoder {}

Private Member Attributes Index

InputKind	input_kind_ = InputKind::Encoded
RtspCodec	codec_ = RtspCodec::H264
	Codec used consistently by the raw encoder and RTP packetization. More...
int	width_ = 0
int	height_ = 0
int	fps_ = 0
std::optional< std::string >	rate_control_
std::optional< int >	gop_length_
std::optional< int >	idr_interval_
std::optional< int >	quality_
int	num_buffers_ = -1

Public Static Functions Index

static VideoSenderOptions	FromRaw (SimaEncodeOptions encode)
	Encode raw frames at their input resolution, then send the selected codec over RTP/UDP. More...
static VideoSenderOptions	H264RtpUdpFromRaw (int width, int height, int fps)
static VideoSenderOptions	H264RtpUdpFromEncoded ()
static VideoSenderOptions	Passthrough (RtspCodec codec)
	Forward already-encoded frames of codec as RTP over UDP without re-encoding. More...

Definition at line 28 of file VideoSender.h.

Enumerations

InputKind

enum class simaai::neat::nodes::groups::VideoSenderOptions::InputKind

strong

Enumeration values

Raw
Encoded

Definition at line 75 of file VideoSender.h.

Friends

VideoSender

friend simaai::neat::Graph const VideoSenderOptions & opt

Definition at line 92 of file VideoSender.h.

Private Constructors

VideoSenderOptions()

simaai::neat::nodes::groups::VideoSenderOptions::VideoSenderOptions ()

default

Definition at line 77 of file VideoSender.h.

Public Member Functions

fps()

int simaai::neat::nodes::groups::VideoSenderOptions::fps ()

inline

Definition at line 57 of file VideoSender.h.

height()

int simaai::neat::nodes::groups::VideoSenderOptions::height ()

inline

Fixed legacy input height, or zero when resolution follows the input.

Definition at line 54 of file VideoSender.h.

is_encoded_input()

bool simaai::neat::nodes::groups::VideoSenderOptions::is_encoded_input ()

inline

Definition at line 46 of file VideoSender.h.

is_raw_input()

bool simaai::neat::nodes::groups::VideoSenderOptions::is_raw_input ()

inline

Definition at line 43 of file VideoSender.h.

video_port()

int simaai::neat::nodes::groups::VideoSenderOptions::video_port ()

inline

Definition at line 60 of file VideoSender.h.

width()

int simaai::neat::nodes::groups::VideoSenderOptions::width ()

inline

Fixed legacy input width, or zero when resolution follows the input.

Definition at line 50 of file VideoSender.h.

Public Member Attributes

async

bool simaai::neat::nodes::groups::VideoSenderOptions::async = false

Permit the sink to wait for its first preroll buffer.

Keep false to let Core render an encoded passthrough sender in its producer's pipeline behind a tee.

Definition at line 70 of file VideoSender.h.

channel

int simaai::neat::nodes::groups::VideoSenderOptions::channel = 0

Definition at line 65 of file VideoSender.h.

encoder

VideoSenderEncoderOptions simaai::neat::nodes::groups::VideoSenderOptions::encoder {}

Definition at line 72 of file VideoSender.h.

host

std::string simaai::neat::nodes::groups::VideoSenderOptions::host = "127.0.0.1"

Definition at line 64 of file VideoSender.h.

rtp

VideoSenderRtpOptions simaai::neat::nodes::groups::VideoSenderOptions::rtp {}

Definition at line 71 of file VideoSender.h.

sync

bool simaai::neat::nodes::groups::VideoSenderOptions::sync = false

Wait for packet timestamps against the pipeline clock.

Definition at line 67 of file VideoSender.h.

video_port_base

int simaai::neat::nodes::groups::VideoSenderOptions::video_port_base = 9000

Definition at line 66 of file VideoSender.h.

Private Member Attributes

codec_

RtspCodec simaai::neat::nodes::groups::VideoSenderOptions::codec_ = RtspCodec::H264

Codec used consistently by the raw encoder and RTP packetization.

Definition at line 81 of file VideoSender.h.

fps_

int simaai::neat::nodes::groups::VideoSenderOptions::fps_ = 0

Definition at line 84 of file VideoSender.h.

gop_length_

std::optional<int> simaai::neat::nodes::groups::VideoSenderOptions::gop_length_

Definition at line 87 of file VideoSender.h.

height_

int simaai::neat::nodes::groups::VideoSenderOptions::height_ = 0

Definition at line 83 of file VideoSender.h.

idr_interval_

std::optional<int> simaai::neat::nodes::groups::VideoSenderOptions::idr_interval_

Definition at line 88 of file VideoSender.h.

input_kind_

InputKind simaai::neat::nodes::groups::VideoSenderOptions::input_kind_ = InputKind::Encoded

Definition at line 79 of file VideoSender.h.

num_buffers_

int simaai::neat::nodes::groups::VideoSenderOptions::num_buffers_ = -1

Definition at line 90 of file VideoSender.h.

quality_

std::optional<int> simaai::neat::nodes::groups::VideoSenderOptions::quality_

Definition at line 89 of file VideoSender.h.

rate_control_

std::optional<std::string> simaai::neat::nodes::groups::VideoSenderOptions::rate_control_

Definition at line 86 of file VideoSender.h.

width_

int simaai::neat::nodes::groups::VideoSenderOptions::width_ = 0

Definition at line 82 of file VideoSender.h.

Public Static Functions

FromRaw()

VideoSenderOptions simaai::neat::nodes::groups::VideoSenderOptions::FromRaw (SimaEncodeOptions encode)

static

Encode raw frames at their input resolution, then send the selected codec over RTP/UDP.

Definition at line 31 of file VideoSender.h.

H264RtpUdpFromEncoded()

VideoSenderOptions simaai::neat::nodes::groups::VideoSenderOptions::H264RtpUdpFromEncoded ()

static

Definition at line 36 of file VideoSender.h.

H264RtpUdpFromRaw()

VideoSenderOptions simaai::neat::nodes::groups::VideoSenderOptions::H264RtpUdpFromRaw (int width, int height, int fps)

static

Deprecated

Use FromRaw with SimaEncodeType::H264.

Definition at line 34 of file VideoSender.h.

Passthrough()

VideoSenderOptions simaai::neat::nodes::groups::VideoSenderOptions::Passthrough (RtspCodec codec)

static

Forward already-encoded frames of codec as RTP over UDP without re-encoding.

Throws std::invalid_argument for codecs the sender cannot packetize.

Definition at line 41 of file VideoSender.h.

---

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

• VideoSender.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.