frigate/docs/docs/configuration/live.md
Nicolas Mowen ff56262c6e
Add ability to restream birdseye (#4761)
* Try using RTSP for restream

* Add ability to get snapshot of birdseye when birdseye restream is enabled

* Write to pipe instead of encoding mpeg1

* Write to cache instead

* Use const for location

* Formatting

* Add hardware encoding for birdseye based on ffmpeg preset

* Provide framerate

* Adjust args

* Fix order

* Delete pipe file if it exists

* Cleanup spacing

* Fix spacing
2022-12-31 08:54:10 -06:00

1.9 KiB

id title
live Live View

Frigate has different live view options, some of which require restream to be enabled.

Live View Options

Live view options can be selected while viewing the live stream. The options are:

Source Latency Frame Rate Resolution Audio Requires Restream Other Limitations
jsmpeg low same as detect -> fps, capped at 10 same as detect no no none
mse low native native yes (depends on audio codec) yes not supported on iOS
webrtc lowest native native yes (depends on audio codec) yes requires extra config

WebRTC extra configuration:

webRTC works by creating a websocket connection on extra ports. One of the following is required for webRTC to work:

  • Frigate is run with network_mode: host to support automatic UDP port pass through locally and remotely. See https://github.com/AlexxIT/go2rtc#module-webrtc for more details
  • Frigate is run with network_mode: bridge and has:
    • Router setup to forward port 8555 to port 8555 on the frigate device.
    • For local webRTC, you will need to create your own go2rtc config:
webrtc:
  listen: ":8555"
  candidates:
    - <frigate host ip address>:8555 # <--- enter frigate host IP here
    - stun:8555

and pass that config to frigate via docker or frigate-go2rtc.yaml for addon users:

See https://github.com/AlexxIT/go2rtc#module-webrtc for more details

volumes:
  - /path/to/your/go2rtc.yaml:/config/frigate-go2rtc.yaml:ro