docs(config): add Media configuration section with hardware decoding options
- commit
- 453cbd8b0585cc3c8d90e92bbf5dd160eda329a2
- author
- brice · · 2025-12-18 18:33 UTC
- committer
- brice · · 2025-12-19 05:28 UTC
- parent
- 46f04d2
- signature
- unsigned
1 file · +27 -0
M docs/CONFIG.md +27 -0
| @@ -268,6 +268,33 @@ cancel = ["escape"] | |||
| 268 | 268 | | `workspace.styling.transition_duration` | int | `120` | Border transition duration (ms) | | |
| 269 | 269 | | `workspace.styling.ui_scale` | float | `1.0` | UI scale multiplier (1.0 = 100%, 1.2 = 120%) | | |
| 270 | 270 | ||
| 271 | + | ## Media | |
| 272 | + | ||
| 273 | + | | Key | Type | Default | Valid Values | Description | | |
| 274 | + | |-----|------|---------|--------------|-------------| | |
| 275 | + | | `media.hardware_decoding` | string | `"auto"` | `auto`, `force`, `disable` | Hardware video decoding mode | | |
| 276 | + | | `media.prefer_av1` | bool | `true` | - | Prefer AV1 codec when available | | |
| 277 | + | | `media.show_diagnostics` | bool | `true` | - | Show media diagnostics warnings at startup | | |
| 278 | + | ||
| 279 | + | **Hardware decoding modes:** | |
| 280 | + | - `auto` (recommended): Hardware preferred with software fallback - fixes Twitch Error #4000 | |
| 281 | + | - `force`: Hardware only - fails if unavailable | |
| 282 | + | - `disable`: Software only - higher CPU usage | |
| 283 | + | ||
| 284 | + | **Example:** | |
| 285 | + | ```toml | |
| 286 | + | [media] | |
| 287 | + | hardware_decoding = "auto" # HW preferred, SW fallback | |
| 288 | + | prefer_av1 = true # AV1 is most efficient codec | |
| 289 | + | show_diagnostics = true # Log warnings if HW accel unavailable | |
| 290 | + | ``` | |
| 291 | + | ||
| 292 | + | **Diagnostics CLI:** | |
| 293 | + | ```bash | |
| 294 | + | # Check GStreamer plugins and VA-API status | |
| 295 | + | dumber media | |
| 296 | + | ``` | |
| 297 | + | ||
| 271 | 298 | ## Content Filtering | |
| 272 | 299 | ||
| 273 | 300 | | Key | Type | Default | Description | | |
| @@ -268,6 +268,33 @@ cancel = ["escape"] | |||||
| 268 | | `workspace.styling.transition_duration` | int | `120` | Border transition duration (ms) | | 268 | | `workspace.styling.transition_duration` | int | `120` | Border transition duration (ms) | | ||
| 269 | | `workspace.styling.ui_scale` | float | `1.0` | UI scale multiplier (1.0 = 100%, 1.2 = 120%) | | 269 | | `workspace.styling.ui_scale` | float | `1.0` | UI scale multiplier (1.0 = 100%, 1.2 = 120%) | | ||
| 270 | 270 | ||||
| 271 | + | ## Media | |||
| 272 | + | ||||
| 273 | + | | Key | Type | Default | Valid Values | Description | | |||
| 274 | + | |-----|------|---------|--------------|-------------| | |||
| 275 | + | | `media.hardware_decoding` | string | `"auto"` | `auto`, `force`, `disable` | Hardware video decoding mode | | |||
| 276 | + | | `media.prefer_av1` | bool | `true` | - | Prefer AV1 codec when available | | |||
| 277 | + | | `media.show_diagnostics` | bool | `true` | - | Show media diagnostics warnings at startup | | |||
| 278 | + | ||||
| 279 | + | **Hardware decoding modes:** | |||
| 280 | + | - `auto` (recommended): Hardware preferred with software fallback - fixes Twitch Error #4000 | |||
| 281 | + | - `force`: Hardware only - fails if unavailable | |||
| 282 | + | - `disable`: Software only - higher CPU usage | |||
| 283 | + | ||||
| 284 | + | **Example:** | |||
| 285 | + | ```toml | |||
| 286 | + | [media] | |||
| 287 | + | hardware_decoding = "auto" # HW preferred, SW fallback | |||
| 288 | + | prefer_av1 = true # AV1 is most efficient codec | |||
| 289 | + | show_diagnostics = true # Log warnings if HW accel unavailable | |||
| 290 | + | ``` | |||
| 291 | + | ||||
| 292 | + | **Diagnostics CLI:** | |||
| 293 | + | ```bash | |||
| 294 | + | # Check GStreamer plugins and VA-API status | |||
| 295 | + | dumber media | |||
| 296 | + | ``` | |||
| 297 | + | ||||
| 271 | ## Content Filtering | 298 | ## Content Filtering | ||
| 272 | 299 | ||||
| 273 | | Key | Type | Default | Description | | 300 | | Key | Type | Default | Description | | ||