Skip to content

Commit a7fb76c

Browse files
DjDeveloperrDjDeveloperr
committed
Format stream quality docs
1 parent ab4e4b1 commit a7fb76c

3 files changed

Lines changed: 28 additions & 28 deletions

File tree

‎docs/api/health.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,17 @@ Returns the static bootstrap information the browser client needs, plus a freshn
2020
}
2121
```
2222

23-
| Field | Notes |
24-
| --------------------------- | --------------------------------------------------------------------------------------- |
25-
| `ok` | Always `true` if the route is reachable. Network failures are signalled by HTTP errors. |
26-
| `httpPort` | HTTP port for the REST API, browser UI, and WebRTC offer endpoint. |
27-
| `timestamp` | Server-side `time.now()` as a fractional Unix epoch in seconds. |
28-
| `videoCodec` | Active encoder. One of `h264` or `h264-software`. See [Video Pipeline](/guide/video). |
29-
| `lowLatency` | `true` when software H.264 low-latency mode was enabled at daemon startup. |
30-
| `realtimeStream` | `true` when the WebRTC stream is configured to favor freshness and realtime pacing. |
23+
| Field | Notes |
24+
| --------------------------- | ----------------------------------------------------------------------------------------- |
25+
| `ok` | Always `true` if the route is reachable. Network failures are signalled by HTTP errors. |
26+
| `httpPort` | HTTP port for the REST API, browser UI, and WebRTC offer endpoint. |
27+
| `timestamp` | Server-side `time.now()` as a fractional Unix epoch in seconds. |
28+
| `videoCodec` | Active encoder. One of `h264` or `h264-software`. See [Video Pipeline](/guide/video). |
29+
| `lowLatency` | `true` when software H.264 low-latency mode was enabled at daemon startup. |
30+
| `realtimeStream` | `true` when the WebRTC stream is configured to favor freshness and realtime pacing. |
3131
| `streamQuality` | Active realtime quality profile and encoder limits such as `maxEdge`, `fps`, and bitrate. |
32-
| `webRtc.iceServers` | ICE servers the browser should use when creating the WebRTC peer connection. |
33-
| `webRtc.iceTransportPolicy` | Browser ICE transport policy. One of `all` or `relay`. |
32+
| `webRtc.iceServers` | ICE servers the browser should use when creating the WebRTC peer connection. |
33+
| `webRtc.iceTransportPolicy` | Browser ICE transport policy. One of `all` or `relay`. |
3434

3535
The default access token is regenerated every time the server restarts. A client should refetch `/api/health` after any disconnection.
3636

‎docs/cli/flags.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,16 @@ Targets a specific running SimDeck daemon for commands that support the HTTP fas
2828

2929
`ui`, `daemon start`, and `daemon restart` accept the same server options. `ui` also accepts `--open`.
3030

31-
| Flag | Default | Description |
32-
| ------------------ | --------------------- | ------------------------------------------------------------------------------- |
33-
| `--port <u16>` | `4310` | HTTP port for the REST API, browser UI, and WebRTC offer endpoint. |
34-
| `--bind <ip>` | `127.0.0.1` | Bind address (`0.0.0.0` for [LAN access](/guide/lan-access), `::` for IPv6). |
35-
| `--advertise-host` | matches local host | Hostname or IP printed for LAN browser access. |
36-
| `--client-root` | bundled `client/dist` | Override the static browser client directory. |
37-
| `--video-codec` | `h264-software` | One of `h264` or `h264-software`. See [Video Pipeline](/guide/video). |
38-
| `--low-latency` | `false` | Software H.264 profile for slower runners: caps at 15 fps and favors freshness. |
31+
| Flag | Default | Description |
32+
| ------------------ | --------------------- | ------------------------------------------------------------------------------------------------------- |
33+
| `--port <u16>` | `4310` | HTTP port for the REST API, browser UI, and WebRTC offer endpoint. |
34+
| `--bind <ip>` | `127.0.0.1` | Bind address (`0.0.0.0` for [LAN access](/guide/lan-access), `::` for IPv6). |
35+
| `--advertise-host` | matches local host | Hostname or IP printed for LAN browser access. |
36+
| `--client-root` | bundled `client/dist` | Override the static browser client directory. |
37+
| `--video-codec` | `h264-software` | One of `h264` or `h264-software`. See [Video Pipeline](/guide/video). |
38+
| `--low-latency` | `false` | Software H.264 profile for slower runners: caps at 15 fps and favors freshness. |
3939
| `--stream-quality` | auto/default | Optional realtime stream quality profile: `quality`, `balanced`, `smooth`, `economy`, or `ci-software`. |
40-
| `--open` | `false` | `ui` only. Open the browser after the daemon is ready. |
40+
| `--open` | `false` | `ui` only. Open the browser after the daemon is ready. |
4141

4242
The public commands generate an access token automatically. Use `simdeck daemon status` to read it for direct API callers.
4343

‎docs/guide/daemon.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,16 @@ This starts or reuses the project daemon, serves the bundled browser client, and
5454

5555
`daemon start`, `daemon restart`, and `ui` accept the same server options:
5656

57-
| Flag | Default | Notes |
58-
| ------------------ | --------------------- | --------------------------------------------------------------------------------- |
59-
| `--port <u16>` | `4310` | HTTP port for the REST API, browser UI, and WebRTC offer endpoint. |
60-
| `--bind <ip>` | `127.0.0.1` | Bind address. Use `0.0.0.0` for [LAN access](/guide/lan-access). |
61-
| `--advertise-host` | matches local host | Hostname or IP advertised to browser clients. |
62-
| `--client-root` | bundled `client/dist` | Override the static browser client directory. |
63-
| `--video-codec` | `h264-software` | One of `h264` or `h264-software`. See [Video](/guide/video). |
64-
| `--low-latency` | `false` | Software H.264 profile for slower runners; caps at 15 fps and drops stale frames. |
57+
| Flag | Default | Notes |
58+
| ------------------ | --------------------- | ----------------------------------------------------------------------------------- |
59+
| `--port <u16>` | `4310` | HTTP port for the REST API, browser UI, and WebRTC offer endpoint. |
60+
| `--bind <ip>` | `127.0.0.1` | Bind address. Use `0.0.0.0` for [LAN access](/guide/lan-access). |
61+
| `--advertise-host` | matches local host | Hostname or IP advertised to browser clients. |
62+
| `--client-root` | bundled `client/dist` | Override the static browser client directory. |
63+
| `--video-codec` | `h264-software` | One of `h264` or `h264-software`. See [Video](/guide/video). |
64+
| `--low-latency` | `false` | Software H.264 profile for slower runners; caps at 15 fps and drops stale frames. |
6565
| `--stream-quality` | auto/default | Optional realtime stream quality profile, including `ci-software` for CI providers. |
66-
| `--open` | `false` | `ui` only. Open the browser after the daemon is ready. |
66+
| `--open` | `false` | `ui` only. Open the browser after the daemon is ready. |
6767

6868
Example:
6969

0 commit comments

Comments
 (0)