frigate/docs/docs/configuration
Francesco Durighetto 4c689dde8e
Add optional idle heartbeat for Birdseye (#20453)
* Add optional idle heartbeat for Birdseye (periodic frame emission when idle)

birdseye: add optional idle heartbeat and FFmpeg tuning envs (default off)

This adds an optional configuration field `birdseye.idle_heartbeat_fps` to
enable a lightweight idle heartbeat mechanism in Birdseye. When set to a value
greater than 0, Birdseye periodically re-sends the last composed frame during
idle periods (no motion or active updates).

This helps downstream consumers such as go2rtc, Alexa, or Scrypted to attach
faster and maintain a low-latency RTSP stream when the system is idle.

Key details:
- Config-based (`birdseye.idle_heartbeat_fps`), default `0` (disabled).
- Uses existing Birdseye rendering pipeline; minimal performance impact.
- Does not alter behavior when unset.

Documentation: added tip section in docs/configuration/restream.md.

* Update docs/docs/configuration/restream.md

Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>

* Update docs/docs/configuration/reference.md

Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>

* Refactors Birdseye idle frame broadcasting

Simplifies the idle frame broadcasting logic by removing the dedicated thread.

The idle frame is now resent directly within the main loop,
improving efficiency and reducing complexity.  Also, limits the idle
heartbeat FPS to a maximum of 10 since the framebuffer is limited to 10 anyway

* ruff fix

---------

Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>
Co-authored-by: Francesco Durighetto <francesco.durighetto@subbyx.com>
Co-authored-by: duri <duri@homelabubuntu.durihome.unifi>
2025-10-19 05:20:36 -06:00
..
custom_classification Add docs for classification models (#20188) 2025-09-23 08:29:16 -06:00
genai Customizable GenAI Review prompt (#20296) 2025-09-30 18:07:16 -05:00
advanced.md Update go2rtc to 1.9.10 (#20202) 2025-09-25 06:15:04 -05:00
audio_detectors.md Fix audio transcription (#20395) 2025-10-08 18:06:03 -05:00
authentication.md Read secrets dir from CREDENTIALS_DIRECTORY (#19327) 2025-09-19 06:34:23 -06:00
autotracking.md Clarify docs on autotracking support (#20465) 2025-10-13 13:42:29 -06:00
bird_classification.md Bird classification docs (#17369) 2025-03-26 14:42:30 -05:00
birdseye.md Move database and config from homeassistant /config to addon /config (#16337) 2025-03-24 09:05:59 -05:00
camera_specific.md Update go2rtc to 1.9.10 (#20202) 2025-09-25 06:15:04 -05:00
cameras.md Clarify docs on autotracking support (#20465) 2025-10-13 13:42:29 -06:00
face_recognition.md Support face recognition via RKNN (#19687) 2025-08-21 06:18:55 -06:00
ffmpeg_presets.md docs: rk ffmpeg preset is outdated (#19780) 2025-08-26 15:24:58 -06:00
genai.md Review genai updates (#19448) 2025-08-16 10:20:33 -05:00
hardware_acceleration_enrichments.md Support face recognition via RKNN (#19687) 2025-08-21 06:18:55 -06:00
hardware_acceleration_video.md [Init] Initial commit for Synaptics SL1680 NPU (#19680) 2025-09-26 07:07:12 -05:00
index.md Move database and config from homeassistant /config to addon /config (#16337) 2025-03-24 09:05:59 -05:00
license_plate_recognition.md Add stationary scan duration for LPR (#20444) 2025-10-12 06:20:14 -06:00
live.md Improve live view console errors (#20340) 2025-10-03 06:37:18 -06:00
masks.md Update docs for clarity on review items (#12441) 2024-07-14 11:12:26 -06:00
metrics.md Use /api/metrics instead of /metrics (#16425) 2025-02-09 12:50:42 -07:00
motion_detection.md Fixes (#18500) 2025-06-03 06:33:32 -06:00
notifications.md Add note for notifications on iOS devices (#16744) 2025-02-22 09:19:37 -06:00
object_detectors.md Improve Intel Model (#20541) 2025-10-17 06:31:28 -06:00
object_filters.md Object area debugging and improvements (#16432) 2025-02-09 14:48:23 -07:00
objects.md Update object docs (#14295) 2024-10-12 07:13:00 -05:00
pwa.md Update pwa.md (#18568) 2025-06-04 14:32:25 -06:00
record.md Improve recording retention logic (#20506) 2025-10-15 11:09:28 -06:00
reference.md Add optional idle heartbeat for Birdseye (#20453) 2025-10-19 05:20:36 -06:00
restream.md Add optional idle heartbeat for Birdseye (#20453) 2025-10-19 05:20:36 -06:00
review.md Docs: Clarify review labels and objects to track (#16758) 2025-02-23 06:28:03 -07:00
semantic_search.md Triggers tweaks (#20339) 2025-10-03 06:36:14 -06:00
snapshots.md Fixes (#18139) 2025-05-11 12:03:53 -06:00
stationary_objects.md Remove parked car guide as it is no longer relevant (#11451) 2024-05-20 22:56:03 +05:30
tls.md Update tls.md instructions for letsencrypt archive dir (#17747) 2025-04-16 16:57:39 -06:00
zones.md Adjust loitering behavior based on object type (#19433) 2025-08-16 10:20:33 -05:00