Image Recording

Specifies options for recording image output to disk.

Example

"recording": {
	"enabled": true,
	"record_with_alert": true,
	"record_with_detection": false,
	"record_with_motion": false,
	"save_original_copy": false,
	"save_detection_data": true,
	"recording_folder": "/home/eyesonit_user/output/recording",
	"video_recording": {
		"enabled": false,
	},
	"image_recording": {
		"enabled": true,
		"record_full_frame": true,
		"record_object_bounds": false,
		"record_all_frames": false,
		"frame_record_interval": 5
	}
}

Attributes

Name	Type	Description
enabled	boolean	true to save images based on recording conditions. The default value is false.
record_full_frame	boolean	true to save full frame images (as opposed to just the bounding box of the detected object). The default value is false. Full frame images are only saved when an object is detected. Images are saved to the recording folder with a file name like person_full_2025_06_09_14:50:23.405.jpg.
record_object_bounds	boolean	true to save the area of the bounding box for the detected object. The default value is false. Boundig box images are only saved when an object is detected. Images are saved to the recording folder with a file name like person_bbox_2025_06_09_14:50:23.405.jpg.
record_all_frames	boolean	true to save all frames when an object is present. false to only save the first frame when an object is detected. The default is false.
frame_record_interval	integer	when record_all_frames is true, this attribute sets the frame recording interval. If frame_record_interval is null, every frame is recorded while the object is present. Otherwise, frame_record_interval specifies the recording interval as a number of frames. For example, if frame_record_interval is 5 then EyesOnIt will save every 5th frame while the object is present.

Example​

Attributes​

Example

Attributes