administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-02-03 01:35:22 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update docs to reflect restream role

Browse Source
This commit is contained in:
Nick Mowen 2022-10-14 14:57:43 -06:00
parent 8b029dbdf8
commit 73276cc64b
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/docs/configuration/index.md
View File

@ -19,7 +19,7 @@ cameras:
- path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2 - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2
roles: roles:
- detect - detect
- rtmp - restream
detect: detect:
width: 1280 width: 1280
height: 720 height: 720
@ -338,7 +338,13 @@ snapshots:
# Optional: RTMP configuration # Optional: RTMP configuration
# NOTE: Can be overridden at the camera level # NOTE: Can be overridden at the camera level
rtmp: rtmp:
# Optional: Enable the RTMP stream (default: True) # Optional: Enable the RTMP stream (default: False)
enabled: False
# Optional: Restream configuration
# NOTE: Can be overridden at the camera level
rtmp:
# Optional: Enable the restream (default: True)
enabled: True enabled: True
# Optional: Live stream configuration for WebUI # Optional: Live stream configuration for WebUI
@ -351,6 +357,10 @@ live:
# Optional: Set the encode quality of the live stream (default: shown below) # Optional: Set the encode quality of the live stream (default: shown below)
# 1 is the highest quality, and 31 is the lowest. Lower quality feeds utilize less CPU resources. # 1 is the highest quality, and 31 is the lowest. Lower quality feeds utilize less CPU resources.
quality: 8 quality: 8
# Optional: Set the source of the live stream (default: shown below)
# mp4 is full res stream that does not support audio
# jsmpeg is the detect stream, capped at 10 fps
source: mp4
# Optional: in-feed timestamp style configuration # Optional: in-feed timestamp style configuration
# NOTE: Can be overridden at the camera level # NOTE: Can be overridden at the camera level
@ -387,11 +397,12 @@ cameras:
# Required: the path to the stream # Required: the path to the stream
# NOTE: path may include environment variables, which must begin with 'FRIGATE_' and be referenced in {} # NOTE: path may include environment variables, which must begin with 'FRIGATE_' and be referenced in {}
- path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2 - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2
# Required: list of roles for this stream. valid values are: detect,record,rtmp # Required: list of roles for this stream. valid values are: detect,record,restream,rtmp
# NOTICE: In addition to assigning the record, and rtmp roles, # NOTICE: In addition to assigning the record, restream, and rtmp roles,
# they must also be enabled in the camera config. # they must also be enabled in the camera config.
roles: roles:
- detect - detect
- restream
- rtmp - rtmp
# Optional: stream specific global args (default: inherit) # Optional: stream specific global args (default: inherit)
# global_args: # global_args: