Skip to main content

Room recording

Records the whole room, composed into one file. start requires a live session and returns an egress handle you pass to stop (or stop by room id).

const rec = await client.recordings.start(roomId, {
composition: { layout: "grid", quality: "high" },
fileFormat: "mp4",
});

await client.recordings.stop(rec); // or client.recordings.stop(roomId)

start options: composition (see Composition), transcription, onFailure, fileFormat (mp4 or webm), webhookUrl, dirPath, resourceId, preSignedUrl.

Manage finished recordings:

await client.recordings.list({ roomId, withTranscription: true });
await client.recordings.get(recordingId, { withTranscription: true });
await client.recordings.delete(recordingId);

Got a Question? Ask us on discord