Interface StartParticipantRecordingInput

Options for RecordingParticipantResource.start.

interface StartParticipantRecordingInput {
    dirPath?: string;
    fileFormat?: ParticipantFileFormat;
    metadata?: Record<string, unknown>;
    participantId: string;
    webhookUrl?: string;
}

Index

Properties

dirPath? fileFormat? metadata? participantId webhookUrl?

Properties

`Optional`dirPath

dirPath?: string

Storage path prefix for the output files.

`Optional`fileFormat

fileFormat?: ParticipantFileFormat

Defaults to "webm".

`Optional`metadata

metadata?: Record<string, unknown>

participantId

participantId: string

The participant to record. Required.

`Optional`webhookUrl

webhookUrl?: string