Skip to main content
Paid plans only useRecordingInstances(): RecordingInstanceState[] This is useful when working with multi-instance recording to enumerate and display all active (and recently stopped) recording instances.

Return value

An array of RecordingInstanceState objects, each with the following properties:
boolean
true if this instance encountered a recording error.
string
Error message for this instance, if any.
string
The unique identifier for this recording instance.
boolean
Whether the local participant is recorded by this instance.
boolean
Whether this instance is currently recording.
Object
The recording layout configuration for this instance.
boolean
true if this is a local recording.
string
The recording ID for this instance.
Date
When this instance started recording.
string
The session ID of the participant who started this recording.
string
The recording type (e.g., 'cloud', 'local').

Example

See also