apps/go2rtc
1
0
Fork 0
mirror of https://github.com/AlexxIT/go2rtc.git synced 2026-04-22 23:57:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

📝 docs(README): update documentation for clarity and accuracy

Browse Source
This commit is contained in:
Sergey Krashevich
2026-01-26 00:35:06 +03:00
parent a41185c22a
commit 5970dd2fe4
11 changed files with 93 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/mjpeg/README.md
+9 -9
View File
@@ -1,13 +1,13 @@
# MJPEG
**Important.** For stream in MJPEG format, your source MUST contain the MJPEG codec. If your stream has an MJPEG codec, you can receive **MJPEG stream** or **JPEG snapshots** via API.
**Important.** For a stream in MJPEG format, your source MUST contain the MJPEG codec. If your stream has the MJPEG codec, you can receive an **MJPEG stream** or **JPEG snapshots** via the API.
You can receive an MJPEG stream in several ways:
- some cameras support MJPEG codec inside [RTSP stream](#source-rtsp) (ex. second stream for Dahua cameras)
- some cameras have an HTTP link with [MJPEG stream](#source-http)
- some cameras have an HTTP link with snapshots - go2rtc can convert them to [MJPEG stream](#source-http)
- you can convert H264/H265 stream from your camera via [FFmpeg integraion](#source-ffmpeg)
- you can convert an H264/H265 stream from your camera via [FFmpeg integration](#source-ffmpeg)
With this example, your stream will have both H264 and MJPEG codecs:
@@ -23,7 +23,7 @@ streams:
**MJPEG stream**
```
http://192.168.1.123:1984/api/stream.mjpeg?src=camera1`
http://192.168.1.123:1984/api/stream.mjpeg?src=camera1
```
**JPEG snapshots**
@@ -32,13 +32,13 @@ http://192.168.1.123:1984/api/stream.mjpeg?src=camera1`
http://192.168.1.123:1984/api/frame.jpeg?src=camera1
```
- You can use `width`/`w` and/or `height`/`h` params.
- You can use `width`/`w` and/or `height`/`h` parameters.
- You can use `rotate` param with `90`, `180`, `270` or `-90` values.
- You can use `hardware`/`hw` param [read more](https://github.com/AlexxIT/go2rtc/wiki/Hardware-acceleration).
- You can use `cache` param (`1m`, `10s`, etc.) to get a cached snapshot.
- The snapshot is cached only when requested with the `cache` parameter.
- A cached snapshot will be used if its time is not older than the time specified in the `cache` parameter.
- The `cache` parameter does not check the image sizes from the cache and those specified in the query.
- The `cache` parameter does not check the image dimensions from the cache and those specified in the query.
## Stream as ASCII to Terminal
@@ -49,9 +49,9 @@ http://192.168.1.123:1984/api/frame.jpeg?src=camera1
- 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
- different terminals support different numbers of colors (8, 256, rgb)
- URL-encode the `text` parameter
- you can stream any camera or file from disk
**go2rtc.yaml** - transcoding to MJPEG, terminal size - 210x59 (16/9), fps - 10
@@ -66,7 +66,7 @@ streams:
- example: `30` (black), `37` (white), `38;5;226` (yellow)
- `back` - background color, values: empty, `8`, `256`, `rgb`, [SGR](https://en.wikipedia.org/wiki/ANSI_escape_code)
- example: `40` (black), `47` (white), `48;5;226` (yellow)
- `text` - character set, values: empty, one char, `block`, list of chars (in order of brightness)
- `text` - character set, values: empty, one character, `block`, list of chars (in order of brightness)
- example: `%20` (space), `block` (keyword for block elements), `ox` (two chars)
**Examples**