Class RecordingParticipantResource

Participant recordings — vsdk.recordings.participant.

Index

Constructors

Methods

delete get list start stop

Constructors

constructor

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

Methods

delete

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

get

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

list

list(
params?: ListIndividualRecordingsParams,
): Promise<Page<IndividualRecording>>
List participant recordings (paginated, async-iterable).
Parameters
- params: ListIndividualRecordingsParams = {}
Returns Promise<Page<IndividualRecording>>

start

start(roomId: string, options: StartParticipantRecordingInput): Promise<string>
Start recording a participant. Returns a confirmation message.
Parameters
- roomId: string
- options: StartParticipantRecordingInput
Returns Promise<string>

stop

stop(roomId: string, participantId: string): Promise<string>
Stop a participant recording (keyed by roomId + participantId).
Parameters
- roomId: string
- participantId: string
Returns Promise<string>