Skip to content

Commit ac20741

Browse files
authored
Add hardware video codec support info to README.md. (#652)
1 parent 477cc52 commit ac20741

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,20 @@ LiveKit is a dynamic realtime environment and calls can fail for various reasons
274274

275275
You may throw errors of the type `RpcError` with a string `message` in an RPC method handler and they will be received on the caller's side with the message intact. Other errors will not be transmitted and will instead arrive to the caller as `1500` ("Application Error"). Other built-in errors are detailed in `RpcError`.
276276

277+
## Hardware video codec support
278+
279+
The underlying Rust SDK ships with platform-specific hardware-accelerated encoders/decoders, These are used automatically when available and compatible with the runtime environment (OS, drivers, GPU, and codec).
280+
281+
| Platform | Codec(s) | Encoder | Decoder | Backend |
282+
| ------------------------------ | ---------- | ------- | ------- | -------------------------------------- |
283+
| macOS | H264, H265 ||| VideoToolbox |
284+
| Linux (AMD GPU) | H264 || | VAAPI |
285+
| Linux x64 (NVIDIA GPU) | H264, H265 ||| NVENC / NVDEC (NVIDIA Video Codec SDK) |
286+
287+
Software encoders (libvpx for VP8/VP9, libaom for AV1, OpenH264 for H264) are used as a fallback when hardware acceleration is not available.
288+
289+
> **Note:** Availability depends on the specific machine configuration, including GPU model, driver support, and runtime environment.
290+
277291
## Examples
278292

279293
- [Facelandmark](https://github.com/livekit/python-sdks/tree/main/examples/face_landmark): Use mediapipe to detect face landmarks (eyes, nose ...)

0 commit comments

Comments
 (0)