* add generation script a script to read yaml code blocks from docs markdown files and generate corresponding "Frigate UI" tab instructions based on the json schema, i18n, section configs (hidden fields), and nav mappings * first pass * components * add to gitignore * second pass * fix broken anchors * fixes * clean up tabs * version bump * tweaks * remove role mapping config from ui
5.7 KiB
| id | title |
|---|---|
| snapshots | Snapshots |
import ConfigTabs from "@site/src/components/ConfigTabs"; import TabItem from "@theme/TabItem"; import NavPath from "@site/src/components/NavPath";
Frigate can save a snapshot image to /media/frigate/clips for each object that is detected named as <camera>-<id>-clean.webp. They are also accessible via the api
Snapshots are accessible in the UI in the Explore pane. This allows for quick submission to the Frigate+ service.
To only save snapshots for objects that enter a specific zone, see the zone docs
Snapshots sent via MQTT are configured separately under the camera MQTT settings, not here.
Enabling Snapshots
Enable snapshot saving and configure the default settings that apply to all cameras.
Navigate to .
- Set Enable snapshots to on
snapshots:
enabled: True
To override snapshot settings for a specific camera:
Navigate to and select your camera.
- Set Enable snapshots to on
cameras:
front_door:
snapshots:
enabled: True
Snapshot Options
Configure how snapshots are rendered and stored. These settings control the defaults applied when snapshots are requested via the API.
Navigate to .
| Field | Description |
|---|---|
| Enable snapshots | Enable or disable saving snapshots for tracked objects |
| Timestamp overlay | Overlay a timestamp on snapshots from API |
| Bounding box overlay | Draw bounding boxes for tracked objects on snapshots from API |
| Crop snapshot | Crop snapshots from API to the detected object's bounding box |
| Snapshot height | Height in pixels to resize snapshots to; leave empty to preserve original size |
| Snapshot quality | Encode quality for saved snapshots (0-100) |
| Required zones | Zones an object must enter for a snapshot to be saved |
snapshots:
enabled: True
timestamp: False
bounding_box: True
crop: False
height: 175
required_zones: []
quality: 60
Snapshot Retention
Configure how long snapshots are retained on disk. Per-object retention overrides allow different retention periods for specific object types.
Navigate to .
| Field | Description |
|---|---|
| Snapshot retention > Default retention | Number of days to retain snapshots (default: 10) |
| Snapshot retention > Retention mode | Retention mode: all, motion, or active_objects |
| Snapshot retention > Object retention > Person | Per-object overrides for retention days (e.g., keep person snapshots for 15 days) |
snapshots:
enabled: True
retain:
default: 10
mode: motion
objects:
person: 15
Frame Selection
Frigate does not save every frame. It picks a single "best" frame for each tracked object based on detection confidence, object size, and the presence of key attributes like faces or license plates. Frames where the object touches the edge of the frame are deprioritized. That best frame is written to disk once tracking ends.
MQTT snapshots are published more frequently — each time a better thumbnail frame is found during tracking, or when the current best image is older than best_image_timeout (default: 60s). These use their own annotation settings configured under the camera MQTT settings.
Rendering
Frigate stores a single clean snapshot on disk:
| API / Use | Result |
|---|---|
| Stored file | <camera>-<id>-clean.webp, always unannotated |
/api/events/<id>/snapshot.jpg |
Starts from the camera's snapshots defaults, then applies any query param overrides at request time |
/api/events/<id>/snapshot-clean.webp |
Returns the same stored snapshot without annotations |
| Frigate+ submission | Uses the same stored clean snapshot |
MQTT snapshots are configured separately under the camera MQTT settings and are unrelated to the stored event snapshot.