diff --git a/docs/docs/configuration/reference.md b/docs/docs/configuration/reference.md index cac508195..0b079c13d 100644 --- a/docs/docs/configuration/reference.md +++ b/docs/docs/configuration/reference.md @@ -616,13 +616,11 @@ record: # never stored, so setting the mode to "all" here won't bring them back. mode: motion -# Optional: Configuration for the jpg snapshots written to the clips directory for each tracked object +# Optional: Configuration for the snapshots written to the clips directory for each tracked object # NOTE: Can be overridden at the camera level snapshots: - # Optional: Enable writing jpg snapshot to /media/frigate/clips (default: shown below) + # Optional: Enable writing snapshot images to /media/frigate/clips (default: shown below) enabled: False - # Optional: save a clean copy of the snapshot image (default: shown below) - clean_copy: True # Optional: print a timestamp on the snapshots (default: shown below) timestamp: False # Optional: draw bounding box on the snapshots (default: shown below) @@ -640,8 +638,8 @@ snapshots: # Optional: Per object retention days objects: person: 15 - # Optional: quality of the encoded jpeg, 0-100 (default: shown below) - quality: 70 + # Optional: quality of the encoded snapshot image, 0-100 (default: shown below) + quality: 60 # Optional: Configuration for semantic search capability semantic_search: diff --git a/docs/docs/configuration/snapshots.md b/docs/docs/configuration/snapshots.md index 01c034a04..f889faba4 100644 --- a/docs/docs/configuration/snapshots.md +++ b/docs/docs/configuration/snapshots.md @@ -3,7 +3,7 @@ id: snapshots title: Snapshots --- -Frigate can save a snapshot image to `/media/frigate/clips` for each object that is detected named as `-.jpg`. They are also accessible [via the api](../integrations/api/event-snapshot-events-event-id-snapshot-jpg-get.api.mdx) +Frigate can save a snapshot image to `/media/frigate/clips` for each object that is detected named as `--clean.webp`. They are also accessible [via the api](../integrations/api/event-snapshot-events-event-id-snapshot-jpg-get.api.mdx) Snapshots are accessible in the UI in the Explore pane. This allows for quick submission to the Frigate+ service. @@ -13,21 +13,19 @@ Snapshots sent via MQTT are configured in the [config file](/configuration) unde ## Frame Selection -Frigate does not save every frame — it picks a single "best" frame for each tracked object and uses it for both the snapshot and clean copy. As the object is tracked across frames, Frigate continuously evaluates whether the current frame is better than the previous best 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. The snapshot is written to disk once tracking ends using whichever frame was determined to be the best. +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 `cameras -> your_camera -> mqtt`. -## Clean Copy +## Rendering -Frigate can produce up to two snapshot files per event, each used in different places: +Frigate stores a single clean snapshot on disk: -| Version | File | Annotations | Used by | -| --- | --- | --- | --- | -| **Regular snapshot** | `-.jpg` | Respects your `timestamp`, `bounding_box`, `crop`, and `height` settings | API (`/api/events//snapshot.jpg`), MQTT (`/