frigate/docs
Francesco Durighetto 7789260a83 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.
2025-10-12 20:48:10 +00:00
..
docs Add optional idle heartbeat for Birdseye (periodic frame emission when idle) 2025-10-12 20:48:10 +00:00
plugins docs: include available objects in documentation 2021-03-09 06:23:37 -06:00
src Add chinese docs (#17954) 2025-05-06 08:49:49 -06:00
static Api docs updates (#20388) 2025-10-08 14:55:38 -05:00
.gitignore docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
babel.config.js docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
docusaurus.config.ts Merge remote-tracking branch 'origin/master' into dev 2025-06-27 06:53:02 -05:00
package-lock.json Deps updates (#20133) 2025-09-19 06:02:02 -05:00
package.json Merge remote-tracking branch 'origin/master' into dev 2025-06-27 06:53:02 -05:00
README.md Use Swagger documentation for Frigate HTTP API (#14178) 2024-10-07 14:27:35 -06:00
sidebars.ts Add docs for HomeKit (#20435) 2025-10-11 16:29:24 -05:00

Website

This website is built using Docusaurus 3.5, a modern static website generator.

For installation and contributing instructions, please follow the Contributing Docs.

Development

  1. Run npm i to install dependencies
  2. Run npm run start to start the website