Skip to main content

Track recording

Records a single media track. kind is required, and the kind you stop with must match the one you started.

await client.recordings.track.start(roomId, { participantId, kind: "video" });
await client.recordings.track.stop(roomId, participantId, "video");

kind is audio, video, screen_audio, or screen_video.

Manage recordings

List, fetch, and delete track recordings:

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

The recording object

Returned by recordings.track.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