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

Update integration for RTSP

Browse Source
This commit is contained in:
Nicolas Mowen 2023-01-12 14:31:21 -07:00 committed by GitHub
parent f92995113b
commit 714753284c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/docs/integrations/home-assistant.md
View File

@ -64,7 +64,7 @@ Home Assistant > Configuration > Integrations > Frigate > Options
| Option | Description | | Option | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| RTMP URL Template | A [jinja2](https://jinja.palletsprojects.com/) template that is used to override the standard RTMP stream URL (e.g. for use with reverse proxies). This option is only shown to users who have [advanced mode](https://www.home-assistant.io/blog/2019/07/17/release-96/#advanced-mode) enabled. See [RTMP streams](#streams) below. | | RTSP URL Template | A [jinja2](https://jinja.palletsprojects.com/) template that is used to override the standard RTMP stream URL (e.g. for use with reverse proxies). This option is only shown to users who have [advanced mode](https://www.home-assistant.io/blog/2019/07/17/release-96/#advanced-mode) enabled. See [RTSP streams](#streams) below. |
## Entities Provided ## Entities Provided
@ -124,13 +124,17 @@ https://HA_URL/api/frigate/notifications/<event-id>/clip.mp4
## RTMP stream ## RTMP stream
In order for the live streams to function they need to be accessible on the RTMP RTMP is deprecated and it is recommended to switch to use RTSP restreams.
port (default: `1935`) at `<frigatehost>:1935`. Home Assistant will directly
## RTSP stream
In order for the live streams to function they need to be accessible on the RTSP
port (default: `8554`) at `<frigatehost>:8554`. Home Assistant will directly
connect to that streaming port when the live camera is viewed. connect to that streaming port when the live camera is viewed.
#### RTMP URL Template #### RTSP URL Template
For advanced usecases, this behavior can be changed with the [RTMP URL For advanced usecases, this behavior can be changed with the [RTSP URL
template](#options) option. When set, this string will override the default stream template](#options) option. When set, this string will override the default stream
address that is derived from the default behavior described above. This option supports address that is derived from the default behavior described above. This option supports
[jinja2 templates](https://jinja.palletsprojects.com/) and has the `camera` dict [jinja2 templates](https://jinja.palletsprojects.com/) and has the `camera` dict
@ -142,24 +146,24 @@ This is potentially useful when Frigate is behind a reverse proxy, and/or when
the default stream port is otherwise not accessible to Home Assistant (e.g. the default stream port is otherwise not accessible to Home Assistant (e.g.
firewall rules). firewall rules).
###### RTMP URL Template Examples ###### RTSP URL Template Examples
Use a different port number: Use a different port number:
``` ```
rtmp://<frigate_host>:2000/live/front_door rtsp://<frigate_host>:2000/front_door
``` ```
Use the camera name in the stream URL: Use the camera name in the stream URL:
``` ```
rtmp://<frigate_host>:2000/live/{{ name }} rtsp://<frigate_host>:2000/{{ name }}
``` ```
Use the camera name in the stream URL, converting it to lowercase first: Use the camera name in the stream URL, converting it to lowercase first:
``` ```
rtmp://<frigate_host>:2000/live/{{ name|lower }} rtsp://<frigate_host>:2000/{{ name|lower }}
``` ```
## Multiple Instance Support ## Multiple Instance Support