RecordingParameters Class Reference

Sets the recording parameters. More...

Functions

 RecordingParameters (String video_filename_="myRecording.svo", SVO_COMPRESSION_MODE compression_mode_=SVO_COMPRESSION_MODE::H264, unsigned int target_framerate_=0, unsigned int bitrate_=0, bool transcode_streaming_input_=false)
 Default constructor. Set all parameters to their default values. More...
 

Attributes

String video_filename
 filename of the SVO file. More...
 
SVO_COMPRESSION_MODE compression_mode = SVO_COMPRESSION_MODE::H264
 compression_mode : can be one of the SVO_COMPRESSION_MODE enum More...
 
unsigned int bitrate = 0
 bitrate : override default bitrate of the SVO file, in KBits/s. Only works if SVO_COMPRESSION_MODE is H264 or H265. : 0 means default values (depends on the resolution) More...
 
unsigned int target_framerate = 0
 defines the target framerate for the recording module. More...
 
bool transcode_streaming_input = false
 In case of streaming input, if set to false, it will avoid decoding/re-encoding and convert directly streaming input into a SVO file. This saves a encoding session and can be especially useful on NVIDIA Geforce cards where the number of encoding session is limited. More...
 

Detailed Description

Sets the recording parameters.

The default constructor sets all parameters to their default settings.

Note
Parameters can be user adjusted.

Constructor and Destructor

◆ RecordingParameters()

RecordingParameters ( String  video_filename_ = "myRecording.svo",
SVO_COMPRESSION_MODE  compression_mode_ = SVO_COMPRESSION_MODE::H264,
unsigned int  target_framerate_ = 0,
unsigned int  bitrate_ = 0,
bool  transcode_streaming_input_ = false 
)
inline

Default constructor. Set all parameters to their default values.

Variables

◆ video_filename

String video_filename

filename of the SVO file.

◆ compression_mode

compression_mode : can be one of the SVO_COMPRESSION_MODE enum

◆ bitrate

unsigned int bitrate = 0

bitrate : override default bitrate of the SVO file, in KBits/s. Only works if SVO_COMPRESSION_MODE is H264 or H265. : 0 means default values (depends on the resolution)

Note
Available range : 0 or [1000 - 60000]

◆ target_framerate

unsigned int target_framerate = 0

defines the target framerate for the recording module.

Warning
This framerate must be below or equal to the camera framerate and camera framerate must be a multiple of the target framerate. It means that it must respect camera_frameratetarget_framerate==0 Allowed framerates are 15,30, 60 or 100 if possible. Any other values will be discarded and camera FPS will be taken. 0 means that the camera framerate will be taken

◆ transcode_streaming_input

bool transcode_streaming_input = false

In case of streaming input, if set to false, it will avoid decoding/re-encoding and convert directly streaming input into a SVO file. This saves a encoding session and can be especially useful on NVIDIA Geforce cards where the number of encoding session is limited.

Note
compression_mode, target_framerate and bitrate will be ignored in this mode.