Recordings
The recordings resource captures a meeting five ways:
- the whole room, composed into one file;
- one participant;
- one track (audio, video, or screen);
- a server-side composite mix of selected participants;
- a two-channel stereo audio merge.
start and stop act on a room's live session.
Egress handles
Room and composite start return an egress handle you pass to stop (a room recording can also stop by room id). The handle carries the ids needed to stop the right egress.
Composition
The composition option controls layout and rendering; the same shape is used by HLS and RTMP. Set a named layout, or a custom template URL.
| Field | Values |
|---|---|
layout | grid, spotlight, sidebar, or a custom template URL |
priority | SPEAKER or PIN |
gridSize | tiles in grid, 0-25 (default 25) |
orientation | portrait or landscape |
theme | DARK, LIGHT, or DEFAULT |
quality | low, med, high, or ultra |
There is no resolution option; use quality.
Got a Question? Ask us on discord

