From 764cca5a70785a32011ad5efd2dc74d11cd39d32 Mon Sep 17 00:00:00 2001 From: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com> Date: Thu, 5 Sep 2024 20:47:17 -0500 Subject: [PATCH] Clarify decoding and the detect role (#13579) --- docs/docs/configuration/cameras.md | 8 ++++++++ docs/docs/guides/getting_started.md | 9 ++++++++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/docs/configuration/cameras.md b/docs/docs/configuration/cameras.md index 52361e9bf..21680af87 100644 --- a/docs/docs/configuration/cameras.md +++ b/docs/docs/configuration/cameras.md @@ -46,6 +46,14 @@ cameras: side: ... ``` +:::note + +If you only define one stream in your `inputs` and do not assign a `detect` role to it, Frigate will automatically assign it the `detect` role. Frigate will always decode a stream to support motion detection, Birdseye, the API image endpoints, and other features, even if you have disabled object detection with `enabled: False` in your config's `detect` section. + +If you plan to use Frigate for recording only, it is still recommended to define a `detect` role for a low resolution stream to minimize resource usage from the required stream decoding. + +::: + For camera model specific settings check the [camera specific](camera_specific.md) infos. ## Setting up camera PTZ controls diff --git a/docs/docs/guides/getting_started.md b/docs/docs/guides/getting_started.md index b74cb9377..f18740d85 100644 --- a/docs/docs/guides/getting_started.md +++ b/docs/docs/guides/getting_started.md @@ -294,6 +294,14 @@ cameras: If you don't have separate streams for detect and record, you would just add the record role to the list on the first input. +:::note + +If you only define one stream in your `inputs` and do not assign a `detect` role to it, Frigate will automatically assign it the `detect` role. Frigate will always decode a stream to support motion detection, Birdseye, the API image endpoints, and other features, even if you have disabled object detection with `enabled: False` in your config's `detect` section. + +If you only plan to use Frigate for recording, it is still recommended to define a `detect` role for a low resolution stream to minimize resource usage from the required stream decoding. + +::: + By default, Frigate will retain video of all events for 10 days. The full set of options for recording can be found [here](../configuration/reference.md). ### Step 7: Complete config @@ -309,4 +317,3 @@ Now that you have a working install, you can use the following documentation for 3. [Review](../configuration/review.md) 4. [Masks](../configuration/masks.md) 5. [Home Assistant Integration](../integrations/home-assistant.md) - Integrate with Home Assistant -