Skip to main content

Effects

Overlay settings applied to returned or recorded images and video frames.

Example

{
"show_motion": false,
"show_bounding_boxes": true,
"show_bounding_box_labels": true,
"show_lines": true,
"show_regions": true,
"show_preliminary_detections": false,
"show_validated_detections": true,
"blur_non_validated_detections": false,
"show_confidence_levels": true,
"show_object_count": false,
"show_frame_number": false,
"show_track_id": false,
"show_alert_text": true,
"font_scale": 0.7
}

Fields

FieldTypeDescription
show_motionbooleanDraw motion contours.
show_bounding_boxesbooleanDraw object bounding boxes.
show_bounding_box_labelsbooleanDraw labels on bounding boxes.
show_linesbooleanDraw configured lines.
show_regionsbooleanDraw region outlines.
show_preliminary_detectionsbooleanShow preliminary detections before validation.
show_validated_detectionsbooleanShow validated detections.
blur_non_validated_detectionsbooleanBlur detections that did not validate.
show_confidence_levelsbooleanShow confidence values in overlays.
show_object_countbooleanShow object-count overlays.
show_frame_numberbooleanShow frame numbers.
show_track_idbooleanShow tracking IDs.
show_alert_textbooleanShow alert text when alert conditions are met.
font_scalenumberFont scale used for overlay text.