Skip to main content

Recording

Reference for the Recording JSON element.

See also: Recording

Example

{
"enabled": true,
"record_with_alert": true,
"recording_folder": "/home/eyesonit_user/output/recordings",
"video_recording": { "enabled": true, "record_all_frames": false },
"image_recording": { "enabled": true, "record_full_frame": true, "record_object_bounds": false, "record_all_frames": false, "frame_record_interval": 5 }
}

Fields

FieldTypeDescription
enabledbooleanEnable recording.
record_with_alertbooleanRecord when alert conditions are met.
record_with_detectionbooleanRecord when detections occur.
record_with_motionbooleanRecord when motion is detected.
record_combined_confidence_thresholdnumberCombined confidence threshold.
save_detection_databooleanSave detection JSON.
save_original_copybooleanSave an original copy without overlays.
recording_folderstringOutput folder for recorded data.
output_file_namestringBase filename for output.
include_stream_namestringStream-name handling for filenames.
video_recordingVideo RecordingVideo recording settings.
image_recordingImage RecordingImage recording settings.