diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index 6e4e93b61..d7555f25e 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -160,3 +160,25 @@ record: # Optional: Number of days to retain retain_days: 30 ``` + +### `birdseye` + +A dynamic combined camera view of all tracked cameras. This is optimized for minimal bandwidth and server resource utilization. Encoding is only performed when actively viewing the video feed, and only active (defined by the mode) cameras are included in the view. + +```yaml +birdseye: + # Optional: Enable birdseye view + enabled: True + # Optional: Width of the output resolution + width: 1280 + # Optional: Height of the output resolution + height: 720 + # Optional: Encoding quality of the mpeg1 feed. 1 is the highest quality, and 31 is the lowest. + # Lower quality feeds utilize less CPU resources. + quality: 8 + # Optional: Mode of the view. Available options are: objects, motion, and continuous + # objects - cameras are included if they have had a tracked object within the last 30 seconds + # motion - cameras are included if motion was detected in the last 30 seconds + # continuous - all cameras are included always + mode: objects +```