Skip to main content

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.

FieldValues
layoutgrid, spotlight, sidebar, or a custom template URL
prioritySPEAKER or PIN
gridSizetiles in grid, 0-25 (default 25)
orientationportrait or landscape
themeDARK, LIGHT, or DEFAULT
qualitylow, med, high, or ultra

There is no resolution option; use quality.

Got a Question? Ask us on discord


Was this helpful?