Class RecordingsResource

constructor

• new RecordingsResource(http: HttpClient): RecordingsResource

  Parameters

  • http: HttpClient

  Returns RecordingsResource

Readonlycomposite

Readonlymerge

Readonlyparticipant

Readonlytrack

delete

• delete(id: string): Promise<string>

  Delete a room recording.

  Parameters

  • id: string

  Returns Promise<string>

get

• get(id: string, options?: { withTranscription?: boolean }): Promise<Recording>

  Fetch a room recording by id.

  Parameters

  • id: string
  • options: { withTranscription?: boolean } = {}

  Returns Promise<Recording>

list

• list(params?: ListRecordingsParams): Promise<Page<Recording>>

  List room recordings (paginated, async-iterable).

  Parameters

  • params: ListRecordingsParams = {}

  Returns Promise<Page<Recording>>

start

• start(roomId: string, options?: StartRecordingInput): Promise<EgressHandle>

  Start a room (composed) recording. Requires a live session. Returns an EgressHandle.

  Parameters

  • roomId: string
  • options: StartRecordingInput = {}

  Returns Promise<EgressHandle>

stop

• stop(target: string | EgressHandle): Promise<string>

  Stop a room recording. Pass the start EgressHandle or a bare roomId.

  Parameters

  • target: string | EgressHandle

  Returns Promise<string>