Overview
Every SDK capability, grouped by concern. Read only what you need.
Each page covers one feature in depth. Pick the relevant ones for your project.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Every SDK capability, grouped by concern. Read only what you need.
| Video, codecs, resolution | Pick a codec and tune the video pipeline. |
| SFU (one-to-many) | One UE instance → many viewers. |
| Stream statistics | Live FPS, bitrate, latency, packet loss. |
| Input controls | Mouse, keyboard, touch, gamepad. |
| Audio & media input | Capture mic and forward audio to UE. |
| Voice & text chat | Real-time chat between viewers. |
| AFK / idle timeout | Hooks for the project-level inactivity timeout. |
| Queue system | Hold viewers when all workers are busy. |
| Reconnection | Auto and manual reconnection. |
| Communicating with Unreal | Send and receive JSON to/from your UE app. |