"description":"Mode for including cameras in Birdseye: 'objects', 'motion', or 'continuous'."
},
"order":{
"label":"Position",
"description":"Numeric position controlling the camera's ordering in the Birdseye layout."
}
},
"detect":{
"label":"Object Detection",
"description":"Settings for the detection/detect role used to run object detection and initialize trackers.",
"enabled":{
"label":"Detection enabled",
"description":"Enable or disable object detection for this camera. Detection must be enabled for object tracking to run."
},
"height":{
"label":"Detect height",
"description":"Height (pixels) of frames used for the detect stream; leave empty to use the native stream resolution."
},
"width":{
"label":"Detect width",
"description":"Width (pixels) of frames used for the detect stream; leave empty to use the native stream resolution."
},
"fps":{
"label":"Detect FPS",
"description":"Desired frames per second to run detection on; lower values reduce CPU usage (recommended value is 5, only set higher - at most 10 - if tracking extremely fast moving objects)."
},
"min_initialized":{
"label":"Minimum initialization frames",
"description":"Number of consecutive detection hits required before creating a tracked object. Increase to reduce false initializations. Default value is fps divided by 2."
},
"max_disappeared":{
"label":"Maximum disappeared frames",
"description":"Number of frames without a detection before a tracked object is considered gone."
},
"stationary":{
"label":"Stationary objects config",
"description":"Settings to detect and manage objects that remain stationary for a period of time.",
"interval":{
"label":"Stationary interval",
"description":"How often (in frames) to run a detection check to confirm a stationary object."
},
"threshold":{
"label":"Stationary threshold",
"description":"Number of frames with no position change required to mark an object as stationary."
},
"max_frames":{
"label":"Max frames",
"description":"Limits how long stationary objects are tracked before being discarded.",
"default":{
"label":"Default max frames",
"description":"Default maximum frames to track a stationary object before stopping."
"description":"Height (pixels) to render the jsmpeg live stream in the Web UI; must be <= detect stream height."
},
"quality":{
"label":"Live quality",
"description":"Encoding quality for the jsmpeg stream (1 highest, 31 lowest)."
}
},
"lpr":{
"label":"License Plate Recognition",
"description":"License plate recognition settings including detection thresholds, formatting, and known plates.",
"enabled":{
"label":"Enable LPR",
"description":"Enable or disable LPR on this camera."
},
"expire_time":{
"label":"Expire seconds",
"description":"Time in seconds after which an unseen plate is expired from the tracker (for dedicated LPR cameras only)."
},
"min_area":{
"label":"Minimum plate area",
"description":"Minimum plate area (pixels) required to attempt recognition."
},
"enhancement":{
"label":"Enhancement level",
"description":"Enhancement level (0-10) to apply to plate crops prior to OCR; higher values may not always improve results, levels above 5 may only work with night time plates and should be used with caution."
}
},
"motion":{
"label":"Motion detection",
"description":"Default motion detection settings for this camera.",
"enabled":{
"label":"Enable motion detection",
"description":"Enable or disable motion detection for this camera."
},
"threshold":{
"label":"Motion threshold",
"description":"Pixel difference threshold used by the motion detector; higher values reduce sensitivity (range 1-255)."
"description":"Threshold to detect and ignore brief lighting spikes (lower is more sensitive, values between 0.3 and 1.0). This does not prevent motion detection entirely; it merely causes the detector to stop analyzing additional frames once the threshold is exceeded. Motion-based recordings are still created during these events."
},
"skip_motion_threshold":{
"label":"Skip motion threshold",
"description":"If more than this fraction of the image changes in a single frame, the detector will return no motion boxes and immediately recalibrate. This can save CPU and reduce false positives during lightning, storms, etc., but may miss real events such as a PTZ camera auto‑tracking an object. The trade‑off is between dropping a few megabytes of recordings versus reviewing a couple short clips. Range 0.0 to 1.0."
"description":"Apply contrast improvement to frames before motion analysis to help detection."
},
"contour_area":{
"label":"Contour area",
"description":"Minimum contour area in pixels required for a motion contour to be counted."
},
"delta_alpha":{
"label":"Delta alpha",
"description":"Alpha blending factor used in frame differencing for motion calculation."
},
"frame_alpha":{
"label":"Frame alpha",
"description":"Alpha value used when blending frames for motion preprocessing."
},
"frame_height":{
"label":"Frame height",
"description":"Height in pixels to scale frames to when computing motion."
},
"mask":{
"label":"Mask coordinates",
"description":"Ordered x,y coordinates defining the motion mask polygon used to include/exclude areas."
},
"mqtt_off_delay":{
"label":"MQTT off delay",
"description":"Seconds to wait after last motion before publishing an MQTT 'off' state."
},
"enabled_in_config":{
"label":"Original motion state",
"description":"Indicates whether motion detection was enabled in the original static configuration."
},
"raw_mask":{
"label":"Raw Mask"
}
},
"objects":{
"label":"Objects",
"description":"Object tracking defaults including which labels to track and per-object filters.",
"track":{
"label":"Objects to track",
"description":"List of object labels to track for this camera."
},
"filters":{
"label":"Object filters",
"description":"Filters applied to detected objects to reduce false positives (area, ratio, confidence).",
"min_area":{
"label":"Minimum object area",
"description":"Minimum bounding box area (pixels or percentage) required for this object type. Can be pixels (int) or percentage (float between 0.000001 and 0.99)."
},
"max_area":{
"label":"Maximum object area",
"description":"Maximum bounding box area (pixels or percentage) allowed for this object type. Can be pixels (int) or percentage (float between 0.000001 and 0.99)."
},
"min_ratio":{
"label":"Minimum aspect ratio",
"description":"Minimum width/height ratio required for the bounding box to qualify."
},
"max_ratio":{
"label":"Maximum aspect ratio",
"description":"Maximum width/height ratio allowed for the bounding box to qualify."
},
"threshold":{
"label":"Confidence threshold",
"description":"Average detection confidence threshold required for the object to be considered a true positive."
},
"min_score":{
"label":"Minimum confidence",
"description":"Minimum single-frame detection confidence required for the object to be counted."
},
"mask":{
"label":"Filter mask",
"description":"Polygon coordinates defining where this filter applies within the frame."
"description":"Minutes between cleanup passes that remove expired recording segments."
},
"continuous":{
"label":"Continuous retention",
"description":"Number of days to retain recordings regardless of tracked objects or motion. Set to 0 if you only want to retain recordings of alerts and detections.",
"description":"Number of days to retain recordings triggered by motion regardless of tracked objects. Set to 0 if you only want to retain recordings of alerts and detections.",
"description":"Mode for retention: all (save all segments), motion (save segments with motion), or active_objects (save segments with active objects)."
"description":"Mode for retention: all (save all segments), motion (save segments with motion), or active_objects (save segments with active objects)."
"description":"Save an unannotated clean copy of snapshots in addition to annotated ones."
},
"timestamp":{
"label":"Timestamp overlay",
"description":"Overlay a timestamp on saved snapshots."
},
"bounding_box":{
"label":"Bounding box overlay",
"description":"Draw bounding boxes for tracked objects on saved snapshots."
},
"crop":{
"label":"Crop snapshot",
"description":"Crop saved snapshots to the detected object's bounding box."
},
"required_zones":{
"label":"Required zones",
"description":"Zones an object must enter for a snapshot to be saved."
},
"height":{
"label":"Snapshot height",
"description":"Height (pixels) to resize saved snapshots to; leave empty to preserve original size."
},
"retain":{
"label":"Snapshot retention",
"description":"Retention settings for saved snapshots including default days and per-object overrides.",
"default":{
"label":"Default retention",
"description":"Default number of days to retain snapshots."
},
"mode":{
"label":"Retention mode",
"description":"Mode for retention: all (save all segments), motion (save segments with motion), or active_objects (save segments with active objects)."
},
"objects":{
"label":"Object retention",
"description":"Per-object overrides for snapshot retention days."
"description":"Control zoom level on tracked objects. Lower values keep more scene in view; higher values zoom in closer but may lose tracking. Values between 0.1 and 0.75."
},
"track":{
"label":"Tracked objects",
"description":"List of object types that should trigger autotracking."
},
"required_zones":{
"label":"Required zones",
"description":"Objects must enter one of these zones before autotracking begins."
},
"return_preset":{
"label":"Return preset",
"description":"ONVIF preset name configured in camera firmware to return to after tracking ends."
},
"timeout":{
"label":"Return timeout",
"description":"Wait this many seconds after losing tracking before returning camera to preset position."
},
"movement_weights":{
"label":"Movement weights",
"description":"Calibration values automatically generated by camera calibration. Do not modify manually."
},
"enabled_in_config":{
"label":"Original autotrack state",
"description":"Internal field to track whether autotracking was enabled in configuration."
"description":"Ignore time synchronization differences between camera and Frigate server for ONVIF communication."
}
},
"type":{
"label":"Camera type",
"description":"Camera Type"
},
"ui":{
"label":"Camera UI",
"description":"Display ordering and visibility for this camera in the UI. Ordering affects the default dashboard. For more granular control, use camera groups.",
"order":{
"label":"UI order",
"description":"Numeric order used to sort the camera in the UI (default dashboard and lists); larger numbers appear later."
},
"dashboard":{
"label":"Show in UI",
"description":"Toggle whether this camera is visible everywhere in the Frigate UI. Disabling this will require manually editing the config to view this camera in the UI again."
}
},
"webui_url":{
"label":"Camera URL",
"description":"URL to visit the camera directly from system page"
},
"zones":{
"label":"Zones",
"description":"Zones allow you to define a specific area of the frame so you can determine whether or not an object is within a particular area.",
"friendly_name":{
"label":"Zone name",
"description":"A user-friendly name for the zone, displayed in the Frigate UI. If not set, a formatted version of the zone name will be used."
"description":"Filters to apply to objects within this zone. Used to reduce false positives or restrict which objects are considered present in the zone.",
"min_area":{
"label":"Minimum object area",
"description":"Minimum bounding box area (pixels or percentage) required for this object type. Can be pixels (int) or percentage (float between 0.000001 and 0.99)."
},
"max_area":{
"label":"Maximum object area",
"description":"Maximum bounding box area (pixels or percentage) allowed for this object type. Can be pixels (int) or percentage (float between 0.000001 and 0.99)."
},
"min_ratio":{
"label":"Minimum aspect ratio",
"description":"Minimum width/height ratio required for the bounding box to qualify."
},
"max_ratio":{
"label":"Maximum aspect ratio",
"description":"Maximum width/height ratio allowed for the bounding box to qualify."
},
"threshold":{
"label":"Confidence threshold",
"description":"Average detection confidence threshold required for the object to be considered a true positive."
},
"min_score":{
"label":"Minimum confidence",
"description":"Minimum single-frame detection confidence required for the object to be counted."
},
"mask":{
"label":"Filter mask",
"description":"Polygon coordinates defining where this filter applies within the frame."
"description":"Polygon coordinates that define the zone area. Can be a comma-separated string or a list of coordinate strings. Coordinates should be relative (0-1) or absolute (legacy)."
},
"distances":{
"label":"Real-world distances",
"description":"Optional real-world distances for each side of the zone quadrilateral, used for speed or distance calculations. Must have exactly 4 values if set."
},
"inertia":{
"label":"Inertia frames",
"description":"Number of consecutive frames an object must be detected in the zone before it is considered present. Helps filter out transient detections."
},
"loitering_time":{
"label":"Loitering seconds",
"description":"Number of seconds an object must remain in the zone to be considered as loitering. Set to 0 to disable loitering detection."
},
"speed_threshold":{
"label":"Minimum speed",
"description":"Minimum speed (in real-world units if distances are set) required for an object to be considered present in the zone. Used for speed-based zone triggers."
},
"objects":{
"label":"Trigger objects",
"description":"List of object types (from labelmap) that can trigger this zone. Can be a string or a list of strings. If empty, all objects are considered."
