From 7acb44d6fba129f455c7fd7a873660e32e47c1be Mon Sep 17 00:00:00 2001 From: Nick Mowen Date: Tue, 12 Dec 2023 13:07:02 -0700 Subject: [PATCH] remove rtmp from docs --- docs/docs/configuration/camera_specific.md | 7 +------ docs/docs/configuration/cameras.md | 2 -- docs/docs/configuration/index.md | 14 ++------------ docs/docs/configuration/restream.md | 4 ---- docs/docs/guides/configuring_go2rtc.md | 2 +- docs/docs/integrations/home-assistant.md | 4 ---- 6 files changed, 4 insertions(+), 29 deletions(-) diff --git a/docs/docs/configuration/camera_specific.md b/docs/docs/configuration/camera_specific.md index b9b2fefb9..2901300cc 100644 --- a/docs/docs/configuration/camera_specific.md +++ b/docs/docs/configuration/camera_specific.md @@ -69,16 +69,12 @@ cameras: ffmpeg: output_args: record: -f segment -segment_time 10 -segment_format mp4 -reset_timestamps 1 -strftime 1 -c:v copy -tag:v hvc1 -bsf:v hevc_mp4toannexb -c:a aac - rtmp: -c:v copy -c:a aac -f flv inputs: - path: rtsp://user:password@camera-ip:554/H264/ch1/main/av_stream # <----- Update for your camera roles: - detect - record - - rtmp - rtmp: - enabled: False # <-- RTMP should be disabled if your stream is not H264 detect: width: # <- optional, by default Frigate tries to automatically detect resolution height: # <- optional, by default Frigate tries to automatically detect resolution @@ -156,13 +152,12 @@ go2rtc: [See the go2rtc docs for more information](https://github.com/AlexxIT/go2rtc/tree/v1.8.4#source-rtsp) -In the Unifi 2.0 update Unifi Protect Cameras had a change in audio sample rate which causes issues for ffmpeg. The input rate needs to be set for record and rtmp if used directly with unifi protect. +In the Unifi 2.0 update Unifi Protect Cameras had a change in audio sample rate which causes issues for ffmpeg. The input rate needs to be set for record if used directly with unifi protect. ```yaml ffmpeg: output_args: record: preset-record-ubiquiti - rtmp: preset-rtmp-ubiquiti # recommend using go2rtc instead ``` ### TP-Link VIGI Cameras diff --git a/docs/docs/configuration/cameras.md b/docs/docs/configuration/cameras.md index a95ffae86..19f773528 100644 --- a/docs/docs/configuration/cameras.md +++ b/docs/docs/configuration/cameras.md @@ -16,7 +16,6 @@ Each role can only be assigned to one input per camera. The options for roles ar | `detect` | Main feed for object detection. [docs](object_detectors.md) | | `record` | Saves segments of the video feed based on configuration settings. [docs](record.md) | | `audio` | Feed for audio based detection. [docs](audio_detectors.md) | -| `rtmp` | Deprecated: Broadcast as an RTMP feed for other services to consume. [docs](restream.md) | ```yaml mqtt: @@ -29,7 +28,6 @@ cameras: - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2 roles: - detect - - 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 64584125e..6c5478a2b 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -206,8 +206,6 @@ ffmpeg: detect: -threads 2 -f rawvideo -pix_fmt yuv420p # Optional: output args for record streams (default: shown below) record: preset-record-generic - # Optional: output args for rtmp streams (default: shown below) - rtmp: preset-rtmp-generic # Optional: Time in seconds to wait before ffmpeg retries connecting to the camera. (default: shown below) # If set too low, frigate will retry a connection to the camera's stream too frequently, using up the limited streams some cameras can allow at once # If set too high, then if a ffmpeg crash or camera stream timeout occurs, you could potentially lose up to a maximum of retry_interval second(s) of footage @@ -430,13 +428,6 @@ snapshots: # Optional: quality of the encoded jpeg, 0-100 (default: shown below) quality: 70 -# Optional: RTMP configuration -# NOTE: RTMP is deprecated in favor of restream -# NOTE: Can be overridden at the camera level -rtmp: - # Optional: Enable the RTMP stream (default: False) - enabled: False - # Optional: Restream configuration # Uses https://github.com/AlexxIT/go2rtc (v1.8.3) go2rtc: @@ -493,14 +484,13 @@ cameras: # Required: the path to the stream # NOTE: path may include environment variables or docker secrets, 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 - # Required: list of roles for this stream. valid values are: audio,detect,record,rtmp - # NOTICE: In addition to assigning the audio, record, and rtmp roles, + # Required: list of roles for this stream. valid values are: audio,detect,record + # NOTICE: In addition to assigning the audio and record roles, # they must also be enabled in the camera config. roles: - audio - detect - record - - rtmp # Optional: stream specific global args (default: inherit) # global_args: # Optional: stream specific hwaccel args (default: inherit) diff --git a/docs/docs/configuration/restream.md b/docs/docs/configuration/restream.md index 23c09b2d9..f0a490bf1 100644 --- a/docs/docs/configuration/restream.md +++ b/docs/docs/configuration/restream.md @@ -38,10 +38,6 @@ go2rtc: **NOTE:** This does not apply to localhost requests, there is no need to provide credentials when using the restream as a source for frigate cameras. -## RTMP (Deprecated) - -In previous Frigate versions RTMP was used for re-streaming. RTMP has disadvantages however including being incompatible with H.265, high bitrates, and certain audio codecs. RTMP is deprecated and it is recommended to move to the new restream role. - ## Reduce Connections To Camera Some cameras only support one active connection or you may just want to have a single connection open to the camera. The RTSP restream allows this to be possible. diff --git a/docs/docs/guides/configuring_go2rtc.md b/docs/docs/guides/configuring_go2rtc.md index 1279f9950..7847a4b81 100644 --- a/docs/docs/guides/configuring_go2rtc.md +++ b/docs/docs/guides/configuring_go2rtc.md @@ -9,7 +9,7 @@ Use of the bundled go2rtc is optional. You can still configure FFmpeg to connect - WebRTC or MSE for live viewing with higher resolutions and frame rates than the jsmpeg stream which is limited to the detect stream - Live stream support for cameras in Home Assistant Integration -- RTSP (instead of RTMP) relay for use with other consumers to reduce the number of connections to your camera streams +- RTSP relay for use with other consumers to reduce the number of connections to your camera streams # Setup a go2rtc stream diff --git a/docs/docs/integrations/home-assistant.md b/docs/docs/integrations/home-assistant.md index f9cb74ebb..462cdeabc 100644 --- a/docs/docs/integrations/home-assistant.md +++ b/docs/docs/integrations/home-assistant.md @@ -124,10 +124,6 @@ https://HA_URL/api/frigate/notifications//clip.mp4 -## RTMP stream - -RTMP is deprecated and it is recommended to switch to use RTSP restreams. - ## RTSP stream In order for the live streams to function they need to be accessible on the RTSP