11 KiB
| id | title |
|---|---|
| review | Review |
import ConfigTabs from "@site/src/components/ConfigTabs"; import TabItem from "@theme/TabItem"; import NavPath from "@site/src/components/NavPath";
The Review page of the Frigate UI is for quickly reviewing historical footage of interest from your cameras. Review items are indicated on a vertical timeline and displayed as a grid of previews - bandwidth-optimized, low frame rate, low resolution videos. Hovering over or swiping a preview plays the video and marks it as reviewed. If more in-depth analysis is required, the preview can be clicked/tapped and the full frame rate, full resolution recording is displayed.
Review items are filterable by date, object type, and camera.
Review items vs. tracked objects (formerly "events")
In Frigate 0.13 and earlier versions, the UI presented "events". An event was synonymous with a tracked or detected object. In Frigate 0.14 and later, a review item is a time period where any number of tracked objects were active.
For example, consider a situation where two people walked past your house. One was walking a dog. At the same time, a car drove by on the street behind them.
In this scenario, Frigate 0.13 and earlier would show 4 "events" in the UI - one for each person, another for the dog, and yet another for the car. You would have had 4 separate videos to watch even though they would have all overlapped.
In 0.14 and later, all of that is bundled into a single review item which starts and ends to capture all of that activity. Reviews for a single camera cannot overlap. Once you have watched that time period on that camera, it is marked as reviewed.
Alerts and Detections
Not every segment of video captured by Frigate may be of the same level of interest to you. Video of people who enter your property may be a different priority than those walking by on the sidewalk. For this reason, Frigate categorizes review items as alerts and detections. By default, all person and car objects are considered alerts. You can refine categorization of your review items by configuring required zones for them.
:::note
Alerts and detections categorize the tracked objects in review items, but Frigate must first detect those objects with your configured object detector (Coral, OpenVINO, etc). By default, the object tracker only detects person. Setting labels for alerts and detections does not automatically enable detection of new objects. To detect more than person, you should add more labels via or and select your camera. Alternatively, add the following to your config:
objects:
track:
- person
- car
- ...
See the objects documentation for the list of objects that Frigate's default model tracks. :::
Restricting alerts to specific labels
By default a review item will only be marked as an alert if a person or car is detected. Configure the alert labels to include any object or audio label.
Navigate to or and select your camera.
Expand Alerts config and configure which labels and zones should generate alerts.
# can be overridden at the camera level
review:
alerts:
labels:
- car
- cat
- dog
- person
- speech
Restricting detections to specific labels
By default all detections that do not qualify as an alert qualify as a detection. However, detections can further be filtered to only include certain labels or certain zones.
Navigate to or and select your camera.
Expand Detections config and configure which labels should qualify as detections.
# can be overridden at the camera level
review:
detections:
labels:
- bark
- dog
Excluding a camera from alerts or detections
To exclude a specific camera from alerts or detections, provide an empty list to the alerts or detections labels field at the camera level.
For example, to exclude objects on the camera gatecamera from any detections:
- Navigate to and select the gatecamera camera.
- Expand Detections config and turn off all of the object label switches.
cameras:
gatecamera:
review:
detections:
labels: []
Restricting review items to specific zones
By default a review item will be created if any review -> alerts -> labels and review -> detections -> labels are detected anywhere in the camera frame. You will likely want to configure review items to only be created when the object enters an area of interest, see the zone docs for more information
:::info
Because zones don't apply to audio, audio labels will always be marked as a detection by default.
:::
Reviewing Motion
The Review page also can show periods of motion that didn't produce a tracked object, and provides a way to search past recordings for motion in a specific region. These tools complement the alerts and detections workflow above — see Tuning Motion Detection for how the underlying motion detector is configured.
Motion Previews
The Motion Previews pane shows preview clips for periods of significant motion that did not produce a tracked object. It is useful for spotting things that motion detection picked up but object detection did not, which can help validate tuning or catch missed objects.
On the page, click the 3-dots menu on a camera and choose Motion Previews. Each card represents a continuous range of motion-only activity and plays back the recorded preview for that range. A heatmap overlay dims areas of the frame with no motion so the moving regions stand out.
The pane provides a few controls:
- Speed — speeds up or slows down all of the preview clips at once.
- Dim — controls how strongly non-motion areas are darkened by the heatmap overlay. Higher values increase motion area visibility.
- Filter — opens a 16×16 grid overlaid on a snapshot of the camera. Select one or more cells to only show clips with motion in those regions. This is helpful for filtering out motion in areas like a busy street while keeping motion in your driveway.
Clicking a preview clip seeks the recording player to that timestamp so you can review the full footage.
Motion Search
Motion Search lets you scan recorded footage for changes inside a region of interest you draw on the camera. Unlike Motion Previews, which surfaces what Frigate's motion detector flagged in real time, Motion Search re-analyzes the saved recordings, so it can find changes that were missed (for example, an object that appeared while motion detection was paused by lightning_threshold, or in a region that is normally motion-masked).
To start a search, click the 3-dots menu on a camera in the page and choose Motion Search. In the dialog:
- Pick the camera and time range to scan.
- Draw a polygon on the camera frame to define the region of interest.
- Adjust the search parameters if needed:
| Field | Description |
|---|---|
| Sensitivity Threshold | Per-pixel luminance change required to count as motion inside the ROI. Behaves like Frigate's motion detection threshold setting. |
| Minimum Change Area | Minimum percentage of the region of interest that must change for a frame to be considered significant. Raise it to ignore small movements (leaves, distant motion); lower it when the object you care about only covers a small slice of the ROI. |
| Frame Skip | Number of frames to skip between samples — at a camera recording 20 fps, a skip value of 20 takes motion samples roughly once per second. Higher values scan much faster and are usually the right choice; lower it only when you need to catch the exact appearance or disappearance of a fast-moving object. |
| Maximum Results | Maximum number of matching timestamps to return. |
| Parallel mode | Process multiple recording segments in parallel. Speeds up large time ranges at the cost of higher CPU usage. |
Once running, Frigate scans the recording segments that overlap the time range and reports timestamps where changes were detected inside the polygon, along with the percentage of the ROI that changed. Clicking a result seeks the player to that moment so you can review what happened.
The status panel shows live progress and metrics such as how many segments were scanned, how many were skipped because no motion was recorded for that segment (using the stored motion heatmap), how many frames were decoded, and the total wall-clock time. Segments with no recorded motion in the selected ROI are skipped automatically, which is what makes searching long time ranges practical.