Recording

Specifies options for writing image, video and data to disk based on supported conditions. When images or videos are recorded, the attributes specified in the effects element are applied to each recorded frame.

Note that recording images and video can consume significant CPU, GPU and disk resources. This feature should be used with care. Consuming excessive resources could cause missed detections or other undesirable side effects.

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,
		"record_all_frames": false
	},
	"image_recording": {
		"enabled": false,
		"record_full_frame": false,
		"record_object_bounds": false,
		"record_all_frames": false,
		"frame_record_interval": null
	}
}

Attributes

All of the attributes are optional.

The record_with_* attributes are processed independently. As an example you can set both record_with_motion and record_with_detection as true. The record_with_* attributes apply to both images and videos.

Name	Type	Description
enabled	boolean	true to record images, videos or JSON data based on specified conditions. If enabled is false, then all recording is disabled. The default value is false.
record_with_alert	boolean	true to record when the alert conditions for a given detection configuration have been met. The default value is false.
record_with_detection	boolean	true to record when an object is detected. The default value is false.
record_with_motion	boolean	true to record when motion is detected. The default value is false.
save_original_copy	boolean	true to save an original copy of a video without any effects applied. If true, EyesOnIt will save an .orig.mp4 file in addition to the mp4 file. The default value is false.
save_detection_data	boolean	true to save JSON detection data when a detection occurs. If true, detections from live streams will be saved to detections.json.txt in the folder specified by the recording_folder attribute. Detections from archived video files will be saved to <input video file name>.json.txt in the recording folder. The file will contain a single line of JSON for each detection. The JSON format matches the detection element. The default value for save_detection_data is false.
recording_folder	string	the folder where EyesOnIt will write images, videos and JSON detection data. If running the Docker version of EyesOnIt, this folder path should start with "/home/eyesonit_user/output". For example: "/home/eyesonit_user/output/recordings". If running without Docker, the folder path can be any folder to which EyesOnIt has write permissions. The default value is null.
video_recording	Video Recording	Additional options specific to processing video
image_recording	Image Recording	Additional options specific to processing images.

Example​

Attributes​

Example

Attributes