Video Streaming
This content is for the 1.0 version. Switch to the latest version for up-to-date documentation.
Video Streaming surfaces live video streaming as an app section. It reuses the
browser webcam publisher (WebRTC publish → LiveKit) and the server-side RTMP egress
so an operator can go live to YouTube, Twitch, … straight from an app tab — no
need to leave the app. The full-screen Studio page (/broadcast/:app) remains
available for advanced use.
| Plugin id | streaming |
| Category | tool |
| UI slot | app-tab |
| Needs worker | No |
No worker is needed: the browser publishes over WebRTC and the server’s room-composite egress forwards to RTMP — both already exposed via the app’s token and broadcast endpoints. The manifest only declares the config the tool pre-fills its form with.
Configuration
Section titled “Configuration”| Field | Type | Default | Description |
|---|---|---|---|
room |
string |
studio |
LiveKit room the webcam publishes to and the egress composes. |
defaultRtmpUrl |
string |
`` (empty) | Optional. Pre-fills the destination field (rtmp:// or rtmps://). |
audioOnly |
boolean |
false |
Start the tool in audio-only mode by default. |
Enable and configure
Section titled “Enable and configure”Dashboard: open the app’s Plugins tab → Install Video Streaming → toggle Active. A Streaming tab appears inside the app. Configure to pre-fill the room and default RTMP destination.
API:
curl -X PATCH https://YOUR-DOMAIN/api/v1/apps/live/plugins/streaming \ -H "Authorization: Bearer sk_..." \ -H "Content-Type: application/json" \ -d '{"enabled": true, "config": {"room": "studio", "defaultRtmpUrl": "rtmp://a.rtmp.youtube.com/live2/<stream-key>"}}'