Class RecordingTrackResource

Track recordings — vsdk.recordings.track.

Index

Constructors

Methods

delete get list start stop

Constructors

constructor

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

Methods

delete

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

get

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

list

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

start

start(roomId: string, options: StartTrackRecordingInput): Promise<string>
Start recording an individual track. Returns a confirmation message.
Parameters
- roomId: string
- options: StartTrackRecordingInput
Returns Promise<string>

stop

stop(roomId: string, participantId: string, kind: TrackKind): Promise<string>
Stop a track recording. roomId, participantId and kind are all required (they identify the track).
Parameters
- roomId: string
- participantId: string
- kind: TrackKind
Returns Promise<string>