StreamingParameters Class Reference

Sets the streaming parameters. More...

General Functions
	StreamingParameters (STREAMING_CODEC codec_=STREAMING_CODEC_HEVC, unsigned short port_=30000, unsigned int bitrate_=8000, int gop_size_=-1, bool adaptative_bitrate_=false)
	Default constructor. Set all parameters to their default values. More...

Attributes
STREAMING_CODEC	codec = STREAMING_CODEC_HEVC
	Defines the codec used for streaming. More...
unsigned short	port = 30000
	Defines the port used for streaming. More...
unsigned int	bitrate = 8000
	Defines the streaming bitrate in Kbits/s. More...
int	gop_size = -1
	Defines the gop size in number of frames. More...
bool	adaptative_bitrate = false
	Enable/Disable adaptive bitrate. More...

Detailed Description

Sets the streaming parameters.

The default constructor sets all parameters to their default settings.

Note

Parameters can be user adjusted.

Constructor and Destructor

StreamingParameters()

StreamingParameters	(	STREAMING_CODEC	codec_ = STREAMING_CODEC_HEVC,
		unsigned short	port_ = 30000,
		unsigned int	bitrate_ = 8000,
		int	gop_size_ = -1,
		bool	adaptative_bitrate_ = false
	)

Default constructor. Set all parameters to their default values.

Variables

codec

STREAMING_CODEC codec = STREAMING_CODEC_HEVC

Defines the codec used for streaming.

Warning

If HEVC is used, make sure the receiving host is compatible with HEVC decoding (basically a pascal NVIDIA card). If not, prefer to use AVCHD since every compatible NVIDIA card supports AVCHD decoding

port

unsigned short port = 30000

Defines the port used for streaming.

Warning

Port must be an even number. Any odd number will be rejected.

Port must be opened.

bitrate

unsigned int bitrate = 8000

Defines the streaming bitrate in Kbits/s.

gop_size

int gop_size = -1

Defines the gop size in number of frames.

Note

if value is set to -1, the gop size will last at maximum 2 seconds, depending on camera fps.

The gop size determines the maximum distance between IDR/I-frames. Very high GOP size will result in slightly more efficient compression, especially on static scenes. But latency will increase.

adaptative_bitrate

bool adaptative_bitrate = false

Enable/Disable adaptive bitrate.

Note

Bitrate will be adjusted depending the number of packet dropped during streaming.

if activated, bitrate can vary between [bitrate/4, bitrate] Currently, the adaptive bitrate only works when "sending" device is a NVIDIA Jetson (X1,X2,Xavier,Nano)