Skip to main content

Participant recording

Records a single participant.

await client.recordings.participant.start(roomId, { participantId, fileFormat: "webm" });
await client.recordings.participant.stop(roomId, participantId);

fileFormat is mp4, webm, or m3u8.

Manage recordings

List, fetch, and delete participant recordings:

await client.recordings.participant.list({ roomId });
await client.recordings.participant.get(recordingId);
await client.recordings.participant.delete(recordingId);

The recording object

Returned by recordings.participant.list and get.

FieldTypeDescription
idstringRecording id.
roomIdstringRoom this recording belongs to.
participantNamestringName of the recorded participant.
filesobject[]Output files, each with a fileUrl.
webhookobjectWebhook delivery summary.
startstringStart time (ISO-8601).
endstringEnd time, null while still recording.

Got a Question? Ask us on discord