startRecording() - Corti API Documentation

Use startRecording() to begin recording within the current embedded session.

Applies to Web Component, Window API, and PostMessage. Examples on this page use the Web Component API shape.

Usage

await api.startRecording();

When consent.enabled is true in configureApp(), startRecording() resolves only after the user confirms consent. Handle the FORBIDDEN rejection:

try {
  await api.startRecording();
} catch (error) {
  // FORBIDDEN: the user declined consent, or the request was superseded or abandoned
}

Prerequisites

User must be authenticated.
An interaction must exist.
The application must be in an interview or session context.

Input validation

None

Possible errors

NOT_READY: Not in interview context or no interaction exists.
UNAUTHORIZED: User not authenticated.
NOT_FOUND: Interaction not found.
INTERNAL_ERROR: Failed to connect to the recording service.
FORBIDDEN: Patient consent is enabled and the user declined it, or the request was superseded by a newer start request or dropped, for example by navigating away.

Returns

void