Class RecordingCompositeResource

Composite recordings — vsdk.recordings.composite.

Index

Constructors

Methods

delete get list start stop

Constructors

constructor

new RecordingCompositeResource(http: HttpClient): RecordingCompositeResource
Parameters
- http: HttpClient
Returns RecordingCompositeResource

Methods

delete

delete(id: string): Promise<string>
Delete a composite recording.
Parameters
- id: string
Returns Promise<string>

get

get(id: string): Promise<CompositeRecording>
Fetch a composite recording by id.
Parameters
- id: string
Returns Promise<CompositeRecording>

list

list(params?: ListCompositeRecordingsParams): Promise<Page<CompositeRecording>>
List composite recordings (paginated, async-iterable).
Parameters
- params: ListCompositeRecordingsParams = {}
Returns Promise<Page<CompositeRecording>>

start

start(
roomId: string,
options?: StartCompositeRecordingInput,
): Promise<EgressHandle>
Start a composite recording. Returns an EgressHandle (id = the recordingId).
Parameters
- roomId: string
- options: StartCompositeRecordingInput = {}
Returns Promise<EgressHandle>

stop

stop(
target: EgressHandle | { recordingId: string; roomId: string },
): Promise<string>
Stop a composite recording. Requires its recordingId (from the start EgressHandle) — pass that handle or { roomId, recordingId }.
Parameters
- target: EgressHandle | { recordingId: string; roomId: string }
Returns Promise<string>