RecordingParameters Struct Reference

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

Functions
	RecordingParameters (string filename="", SVO_COMPRESSION_MODE compression=SVO_COMPRESSION_MODE.H264_BASED, uint bitrate=0, int fps=0, bool transcode=false)
	Default constructor. More...

Attributes
string	videoFilename
	Filename of the file to save the recording into. More...
SVO_COMPRESSION_MODE	compressionMode
	Compression mode the recording. More...
int	targetFPS
	Framerate for the recording file. More...
uint	bitrate
	Overrides the default bitrate of the SVO file, in kbits/s. More...
bool	transcode
	Defines whether to decode and re-encode a streaming source. More...

Detailed Description

Structure containing the options used to record.

Note

For more info, read about the ZED SDK C++ class it mirrors: RecordingParameters

Constructor and Destructor

RecordingParameters()

RecordingParameters ( string  filename = "", SVO_COMPRESSION_MODE  compression = SVO_COMPRESSION_MODE.H264_BASED, uint  bitrate = 0, int  fps = 0, bool  transcode = false  )

inline

Default constructor.

All the parameters are set to their default values.

Variables

videoFilename

string videoFilename

Filename of the file to save the recording into.

Referenced by Camera.EnableRecording().

compressionMode

SVO_COMPRESSION_MODE compressionMode

Compression mode the recording.

Default: sl.SVO_COMPRESSION_MODE.H264_BASED

Referenced by Camera.EnableRecording().

targetFPS

int targetFPS

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 cameraFPStargetFPS == 0.

Allowed framerates are 15,30, 60 or 100 if possible.

Any other values will be discarded and camera FPS will be taken.

Referenced by Camera.EnableRecording().

bitrate

uint 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 compressionMode is sl.SVO_COMPRESSION_MODE.H264_BASED or sl.SVO_COMPRESSION_MODE.H265_BASED.

Available range: 0 or [1000 - 60000]

Referenced by Camera.EnableRecording(), and RecordingParameters.RecordingParameters().

transcode

bool transcode

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.

compressionMode, targetFPS and bitrate will be ignored in this mode.

Referenced by Camera.EnableRecording(), and RecordingParameters.RecordingParameters().