SL_RecordingParameters Struct Reference

Structure containing the options used to record. More...

Data Fields

unsigned char video_filename [256]
 Filename of the file to save the recording into.
 
enum SL_SVO_COMPRESSION_MODE compression_mode
 Compression mode the recording. More...
 
unsigned int bitrate
 Overrides the default bitrate of the SVO file, in kbits/s. More...
 
unsigned int target_framerate
 Framerate for the recording file. More...
 
bool transcode_streaming_input
 Defines whether to decode and re-encode a streaming source. More...
 

Detailed Description

Structure containing the options used to record.

Field Documentation

◆ compression_mode

enum SL_SVO_COMPRESSION_MODE SL_RecordingParameters::compression_mode

Compression mode the recording.

Default: SL_SVO_COMPRESSION_MODE_H264

◆ bitrate

unsigned int SL_RecordingParameters::bitrate

Overrides the default bitrate of the SVO file, in kbits/s.

Default: 0 (the default values associated with the resolution)

Note
Only works if compression_mode is H264 or H265.
Available range: 0 or [1000 - 60000]

◆ target_framerate

unsigned int SL_RecordingParameters::target_framerate

Framerate for the recording file.

Default: 0 (camera framerate will be taken)

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 <code 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.

◆ transcode_streaming_input

bool SL_RecordingParameters::transcode_streaming_input

Defines whether to decode and re-encode a streaming source.

Default: false

Note
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.
compression_mode, target_framerate and bitrate will be ignored in this mode.