RecordingParameters Class Reference

Sets the recording parameters. More...

Functions
def	__cinit__ (self, video_filename="myRecording.svo", compression_mode=SVO_COMPRESSION_MODE.H264, target_framerate=0, bitrate=0, transcode_streaming_input=False)
	Constructor. More...
def	video_filename (self)
	filename of the SVO file.
def	compression_mode (self)
	compression_mode : can be one of the SVO_COMPRESSION_MODE enum
def	target_framerate (self)
	defines the target framerate for the streaming output. More...
def	bitrate (self)
	overrides default bitrate of the SVO file, in KBits/s. More...
def	transcode_streaming_input (self)
	In case of streaming input, if set to false, it will avoid decoding/re-encoding and convert directly streaming input into a SVO file. More...

Detailed Description

Sets the recording parameters.

The default constructor sets all parameters to their default settings.

Note

Parameters can be user adjusted.

Functions

__cinit__()

def __cinit__	(		self,
			video_filename = "myRecording.svo",
			compression_mode = SVO_COMPRESSION_MODE.H264,
			target_framerate = 0,
			bitrate = 0,
			transcode_streaming_input = False
	)

Constructor.

Parameters

video_filename	: the chosen video_filename
compression_mode	: the chosen compression_mode
target_framerate	: the chosen target_framerate
bitrate	: the chosen bitrate
transcode_streaming_input	: enables transcode_streaming_input

params = sl.RecordingParameters(video_filename="record.svo",compression_mode=SVO_COMPRESSION_MODE.H264)

target_framerate()

def target_framerate

(

self

)

defines the target framerate for the streaming output.

This framerate must be below or equal to the camera framerate. Allowed framerates are 15,30, 60 or 100 if possible. Any other values will be discarded and camera FPS will be taken.

Note

By default 0 means that the camera framerate will be taken

bitrate()

def bitrate

(

self

)

overrides 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]

transcode_streaming_input()

def transcode_streaming_input

(

self

)

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