Add support streaming as ascii to terminal

2026-04-22 23:57:20 +08:00 · 2024-05-16 11:35:25 +03:00
parent 75020d4df7
commit 41badbfb8e
5 changed files with 227 additions and 25 deletions
@@ -0,0 +1,33 @@
+## Stream as ASCII to Terminal
+
+**Tips**
+
+- this feature works only with MJPEG codec (use transcoding)
+- choose a low frame rate (FPS)
+- choose the width and height to fit in your terminal
+- different terminals support different numbers of colours (8, 256, rgb)
+- escape text param with urlencode
+- you can stream any camera or file from a disc
+
+**go2rtc.yaml** - transcoding to MJPEG, terminal size - 210x60, fps - 4
+
+```yaml
+streams:
+  macarena: ffmpeg:macarena.mp4#video=mjpeg#hardware#width=210#height=60#raw=-r 4
+```
+
+**API params**
+
+- `color` - foreground color, values: empty, `8`, `256`, `rgb`
+- `back` - background color, values: empty, `8`, `256`, `rgb`
+- `text` - character set, values: empty, one space, two spaces, anything you like (in order of brightness)
+
+**Examples**
+
+```bash
+% curl "http://192.168.1.123:1984/api/stream.ascii?src=macarena"
+% curl "http://192.168.1.123:1984/api/stream.ascii?src=macarena&color=256"
+% curl "http://192.168.1.123:1984/api/stream.ascii?src=macarena&back=256&text=%20"
+% curl "http://192.168.1.123:1984/api/stream.ascii?src=macarena&back=8&text=%20%20"
+% curl "http://192.168.1.123:1984/api/stream.ascii?src=macarena&text=helloworld"
+```