Interface StartRecordingInput

Options for RecordingsResource.start (room / composed recording).

interface StartRecordingInput {
    composition?: Composition;
    dirPath?: string;
    fileFormat?: RecordingFileFormat;
    onFailure?: OnFailureConfig;
    preSignedUrl?: string;
    resourceId?: string;
    transcription?: TranscriptionConfig;
    webhookUrl?: string;
}

Index

Properties

composition? dirPath? fileFormat? onFailure? preSignedUrl? resourceId? transcription? webhookUrl?

Properties

`Optional`composition

composition?: Composition

Composition options — layout, quality, orientation, and theme.

`Optional`dirPath

dirPath?: string

Storage path prefix for the output files.

`Optional`fileFormat

fileFormat?: RecordingFileFormat

"mp4" (default) or "webm".

`Optional`onFailure

onFailure?: OnFailureConfig

Behavior if the composition fails.

`Optional`preSignedUrl

preSignedUrl?: string

`Optional`resourceId

resourceId?: string

Pre-acquired resource-pool unit id.

`Optional`transcription

transcription?: TranscriptionConfig

Optional post-recording transcription / summary.

`Optional`webhookUrl

webhookUrl?: string