gilles/go2rtc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Alex X
2026-02-07 09:12:31 +03:00
parent f3ad4ad977
commit be4b6c3271
6 changed files with 123 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/README.md
+99 -55
View File
@@ -3,9 +3,9 @@
go2rtc tries to name formats, protocols and codecs the same way they are named in FFmpeg.
Some formats and protocols go2rtc supports exclusively. They have no equivalent in FFmpeg.
- The `echo`, `expr`, `hass` and `onvif` modules receive a link to a stream. They don't know the protocol in advance.
- The `exec` and `ffmpeg` modules support many formats. They are identical to the `http` module.
- The `api`, `app`, `debug`, `ngrok`, `pinggy`, `srtp`, `streams` are supporting modules.
- The [`echo`], [`expr`], [`hass`] and [`onvif`] modules receive a link to a stream. They don't know the protocol in advance.
- The [`exec`] and [`ffmpeg`] modules support many formats. They are identical to the [`http`] module.
- The [`api`], [`app`], [`debug`], [`ngrok`], [`pinggy`], [`srtp`], [`streams`] are supporting modules.
**Modules** implement communication APIs: authorization, encryption, command set, structure of media packets.
@@ -13,55 +13,99 @@ Some formats and protocols go2rtc supports exclusively. They have no equivalent
**Protocols** implement transport for data transmission.
| module | formats | protocols | input | output | ingest | two-way |
|--------------|-----------------|------------------|-------|--------|--------|---------|
| `alsa` | `pcm` | `ioctl` | yes | | | |
| `bubble` | - | `http` | yes | | | |
| `doorbird` | `mulaw` | `http` | yes | | | yes |
| `dvrip` | - | `tcp` | yes | | | yes |
| `echo` | * | * | yes | | | |
| `eseecloud` | `rtp` | `http` | yes | | | |
| `exec` | * | `pipe`, `rtsp` | yes | | | yes |
| `expr` | * | * | yes | | | |
| `ffmpeg` | * | `pipe`, `rtsp` | yes | | | |
| `flussonic` | `mp4` | `ws` | yes | | | |
| `gopro` | `mpegts` | `udp` | yes | | | |
| `hass` | * | * | yes | | | |
| `hls` | `mpegts`, `mp4` | `http` | | yes | | |
| `homekit` | `rtp` | `hap` | yes | yes | | no |
| `http` | `adts` | `http`, `tcp` | yes | | | |
| `http` | `flv` | `http`, `tcp` | yes | | | |
| `http` | `h264` | `http`, `tcp` | yes | | | |
| `http` | `hevc` | `http`, `tcp` | yes | | | |
| `http` | `hls` | `http`, `tcp` | yes | | | |
| `http` | `mjpeg` | `http`, `tcp` | yes | | | |
| `http` | `mpjpeg` | `http` | yes | | | |
| `http` | `mpegts` | `http`, `tcp` | yes | | | |
| `http` | `wav` | `http`, `tcp` | yes | | | |
| `http` | `yuv4mpegpipe` | `http`, `tcp` | yes | | | |
| `isapi` | `alaw`, `mulaw` | `http` | | | | yes |
| `ivideon` | `mp4` | `ws` | yes | | | |
| `mjpeg` | `ascii` | `http` | | yes | | |
| `mjpeg` | `jpeg` | `http` | | yes | | |
| `mjpeg` | `mpjpeg` | `http` | | yes | yes | |
| `mjpeg` | `yuv4mpegpipe` | `http` | | yes | | |
| `mp4` | `mp4` | `http`, `ws` | | yes | | |
| `mpegts` | `adts` | `http` | | yes | | |
| `mpegts` | `mpegts` | `http` | | yes | yes | |
| `multitrans` | `rtp` | `tcp` | | | | yes |
| `nest` | `srtp` | `rtsp`, `webrtc` | yes | | | no |
| `onvif` | `rtp` | * | yes | yes | | |
| `ring` | `srtp` | `webrtc` | yes | | | yes |
| `roborock` | `srtp` | `webrtc` | yes | | | yes |
| `rtmp` | `rtmp` | `rtmp` | yes | yes | yes | |
| `rtmp` | `flv` | `http` | | yes | yes | |
| `rtsp` | `rtsp` | `rtsp` | yes | yes | yes | yes |
| `tapo` | `mpegts` | `http` | yes | | | yes |
| `tuya` | `srtp` | `webrtc` | yes | | | yes |
| `v4l2` | `rawvideo` | `ioctl` | yes | | | |
| `webrtc` | `srtp` | `webrtc` | yes | yes | yes | yes |
| `webtorrent` | `srtp` | `webrtc` | yes | yes | | |
| `wyoming` | `pcm` | `tcp` | | yes | | |
| `wyze` | - | `tutk` | yes | | | yes |
| `xiaomi` | - | `cs2`, `tutk` | yes | | | yes |
| `yandex` | `srtp` | `webrtc` | yes | | | |
| module | formats | protocols | input | output | ingest | two-way |
|----------------|-----------------|------------------|-------|--------|--------|---------|
| [`alsa`] | `pcm` | `ioctl` | yes | | | |
| [`bubble`] | - | `http` | yes | | | |
| [`doorbird`] | `mulaw` | `http` | yes | | | yes |
| [`dvrip`] | - | `tcp` | yes | | | yes |
| [`echo`] | * | * | yes | | | |
| [`eseecloud`] | `rtp` | `http` | yes | | | |
| [`exec`] | * | `pipe`, `rtsp` | yes | | | yes |
| [`expr`] | * | * | yes | | | |
| [`ffmpeg`] | * | `pipe`, `rtsp` | yes | | | |
| [`flussonic`] | `mp4` | `ws` | yes | | | |
| [`gopro`] | `mpegts` | `udp` | yes | | | |
| [`hass`] | * | * | yes | | | |
| [`hls`] | `mpegts`, `mp4` | `http` | | yes | | |
| [`homekit`] | `srtp` | `hap` | yes | yes | | no |
| [`http`] | `adts` | `http`, `tcp` | yes | | | |
| [`http`] | `flv` | `http`, `tcp` | yes | | | |
| [`http`] | `h264` | `http`, `tcp` | yes | | | |
| [`http`] | `hevc` | `http`, `tcp` | yes | | | |
| [`http`] | `hls` | `http`, `tcp` | yes | | | |
| [`http`] | `mjpeg` | `http`, `tcp` | yes | | | |
| [`http`] | `mpjpeg` | `http` | yes | | | |
| [`http`] | `mpegts` | `http`, `tcp` | yes | | | |
| [`http`] | `wav` | `http`, `tcp` | yes | | | |
| [`http`] | `yuv4mpegpipe` | `http`, `tcp` | yes | | | |
| [`isapi`] | `alaw`, `mulaw` | `http` | | | | yes |
| [`ivideon`] | `mp4` | `ws` | yes | | | |
| [`mjpeg`] | `ascii` | `http` | | yes | | |
| [`mjpeg`] | `jpeg` | `http` | | yes | | |
| [`mjpeg`] | `mpjpeg` | `http` | | yes | yes | |
| [`mjpeg`] | `yuv4mpegpipe` | `http` | | yes | | |
| [`mp4`] | `mp4` | `http`, `ws` | | yes | | |
| [`mpegts`] | `adts` | `http` | | yes | | |
| [`mpegts`] | `mpegts` | `http` | | yes | yes | |
| [`multitrans`] | `rtp` | `tcp` | | | | yes |
| [`nest`] | `srtp` | `rtsp`, `webrtc` | yes | | | no |
| [`onvif`] | `rtp` | * | yes | yes | | |
| [`ring`] | `srtp` | `webrtc` | yes | | | yes |
| [`roborock`] | `srtp` | `webrtc` | yes | | | yes |
| [`rtmp`] | `flv` | `rtmp` | yes | yes | yes | |
| [`rtmp`] | `flv` | `http` | | yes | yes | |
| [`rtsp`] | `rtsp` | `rtsp` | yes | yes | yes | yes |
| [`tapo`] | `mpegts` | `http` | yes | | | yes |
| [`tuya`] | `srtp` | `webrtc` | yes | | | yes |
| [`v4l2`] | `rawvideo` | `ioctl` | yes | | | |
| [`webrtc`] | `srtp` | `webrtc` | yes | yes | yes | yes |
| [`webtorrent`] | `srtp` | `webrtc` | yes | yes | | |
| [`wyoming`] | `pcm` | `tcp` | | yes | | |
| [`wyze`] | - | `tutk` | yes | | | yes |
| [`xiaomi`] | - | `cs2`, `tutk` | yes | | | yes |
| [`yandex`] | `srtp` | `webrtc` | yes | | | |
[`alsa`]: alsa/README.md
[`api`]: api/README.md
[`app`]: app/README.md
[`bubble`]: bubble/README.md
[`debug`]: debug/README.md
[`doorbird`]: doorbird/README.md
[`dvrip`]: dvrip/README.md
[`echo`]: echo/README.md
[`eseecloud`]: eseecloud/README.md
[`exec`]: exec/README.md
[`expr`]: expr/README.md
[`ffmpeg`]: ffmpeg/README.md
[`flussonic`]: flussonic/README.md
[`gopro`]: gopro/README.md
[`hass`]: hass/README.md
[`hls`]: hls/README.md
[`homekit`]: homekit/README.md
[`http`]: http/README.md
[`isapi`]: isapi/README.md
[`ivideon`]: ivideon/README.md
[`mjpeg`]: mjpeg/README.md
[`mp4`]: mp4/README.md
[`mpegts`]: mpegts/README.md
[`multitrans`]: multitrans/README.md
[`nest`]: nest/README.md
[`ngrok`]: ngrok/README.md
[`onvif`]: onvif/README.md
[`pinggy`]: pinggy/README.md
[`ring`]: ring/README.md
[`roborock`]: roborock/README.md
[`rtmp`]: rtmp/README.md
[`rtsp`]: rtsp/README.md
[`srtp`]: srtp/README.md
[`streams`]: streams/README.md
[`tapo`]: tapo/README.md
[`tuya`]: tuya/README.md
[`v4l2`]: v4l2/README.md
[`webrtc`]: webrtc/README.md
[`webtorrent`]: webtorrent/README.md
[`wyoming`]: wyze/README.md
[`wyze`]: wyze/README.md
[`xiaomi`]: xiaomi/README.md
[`yandex`]: yandex/README.md
internal/app/README.md
+3 -3
View File
@@ -1,6 +1,6 @@
# App
The application module is responsible for reading configuration files and running other modules.
The application module is responsible for reading configuration files, running other modules and setting up [logs](#log).
The configuration can be edited through the application's WebUI with code highlighting, syntax and specification checking.
@@ -60,10 +60,10 @@ api:
listen: ":1984" # default public port for WebUI and HTTP API
ffmpeg:
bin: "ffmpeg" # default binary path for FFmpeg
bin: "ffmpeg" # default binary path for FFmpeg
log:
level: "info" # default log level
level: "info" # default log level
output: "stdout"
time: "UNIXMS"