From 3b4ad188766c1ec3b68d9b544872df531da4a169 Mon Sep 17 00:00:00 2001 From: Nick Mowen Date: Mon, 16 Jan 2023 06:48:56 -0700 Subject: [PATCH] Update more docs --- docs/docs/configuration/cameras.md | 3 +-- docs/docs/configuration/index.md | 39 +++++++++++------------------- docs/docs/troubleshooting/faqs.md | 2 +- 3 files changed, 16 insertions(+), 28 deletions(-) diff --git a/docs/docs/configuration/cameras.md b/docs/docs/configuration/cameras.md index a889136f2..d8fefed8f 100644 --- a/docs/docs/configuration/cameras.md +++ b/docs/docs/configuration/cameras.md @@ -15,7 +15,6 @@ Each role can only be assigned to one input per camera. The options for roles ar | ---------- | ---------------------------------------------------------------------------------------- | | `detect` | Main feed for object detection | | `record` | Saves segments of the video feed based on configuration settings. [docs](record.md) | -| `restream` | Broadcast as RTSP feed and use the full res stream for live view. [docs](restream.md) | | `rtmp` | Deprecated: Broadcast as an RTMP feed for other services to consume. [docs](restream.md) | ```yaml @@ -29,7 +28,7 @@ cameras: - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2 roles: - detect - - rtmp + - rtmp # <- deprecated, recommend using restream instead - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/live roles: - record diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index 969f693e4..24c291140 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -126,6 +126,9 @@ environment_vars: birdseye: # Optional: Enable birdseye view (default: shown below) enabled: True + # Optional: Restream birdseye via RTSP (default: shown below) + # NOTE: Enabling this will set birdseye to run 24/7 which may increase CPU usage somewhat. + restream: False # Optional: Width of the output resolution (default: shown below) width: 1280 # Optional: Height of the output resolution (default: shown below) @@ -352,32 +355,18 @@ rtmp: enabled: False # Optional: Restream configuration -# NOTE: Can be overridden at the camera level +# Uses https://github.com/AlexxIT/go2rtc restream: - # Optional: Enable the restream (default: True) - enabled: True - # Optional: Set the audio codecs to restream with - # possible values are aac, copy, opus. Set to copy - # only to avoid transcoding (default: shown below) - audio_encoding: - - aac - - opus - # Optional: Video encoding to be used. By default the codec will be copied but - # it can be switched to another or an MJPEG stream can be encoded and restreamed - # as h264 (default: shown below) - video_encoding: "copy" - # Optional: Restream birdseye via RTSP (default: shown below) - # NOTE: Enabling this will set birdseye to run 24/7 which may increase CPU usage somewhat. - birdseye: False - # Optional: jsmpeg stream configuration for WebUI - jsmpeg: - # Optional: Set the height of the jsmpeg stream. (default: 720) - # This must be less than or equal to the height of the detect stream. Lower resolutions - # reduce bandwidth required for viewing the jsmpeg stream. Width is computed to match known aspect ratio. - height: 720 - # Optional: Set the encode quality of the jsmpeg stream (default: shown below) - # 1 is the highest quality, and 31 is the lowest. Lower quality feeds utilize less CPU resources. - quality: 8 + +# Optional: jsmpeg stream configuration for WebUI +live: + # Optional: Set the height of the jsmpeg stream. (default: 720) + # This must be less than or equal to the height of the detect stream. Lower resolutions + # reduce bandwidth required for viewing the jsmpeg stream. Width is computed to match known aspect ratio. + height: 720 + # Optional: Set the encode quality of the jsmpeg stream (default: shown below) + # 1 is the highest quality, and 31 is the lowest. Lower quality feeds utilize less CPU resources. + quality: 8 # Optional: in-feed timestamp style configuration # NOTE: Can be overridden at the camera level diff --git a/docs/docs/troubleshooting/faqs.md b/docs/docs/troubleshooting/faqs.md index ce68f6a17..20b8261f2 100644 --- a/docs/docs/troubleshooting/faqs.md +++ b/docs/docs/troubleshooting/faqs.md @@ -25,7 +25,7 @@ This almost always means that the width/height defined for your camera are not c ### I can't view events or recordings in the Web UI. -Ensure your cameras send h264 encoded video, or [transcode them](/configuration/restream.md#changing-restream-codec). +Ensure your cameras send h264 encoded video, or [transcode them](/configuration/restream.md). ### "[mov,mp4,m4a,3gp,3g2,mj2 @ 0x5639eeb6e140] moov atom not found"