Class RealtimeTranscriptionResource

Realtime (live) transcription — vsdk.transcription.realtime.

Runs against a room's active session (identified by roomId).

Index

Constructors

Methods

get list start stop

Constructors

constructor

new RealtimeTranscriptionResource(
http: HttpClient,
): RealtimeTranscriptionResource
Parameters
- http: HttpClient
Returns RealtimeTranscriptionResource

Methods

get

get(transcriptionId: string): Promise<RealtimeTranscription>
Fetch a realtime transcription by its transcriptionId.
Parameters
- transcriptionId: string
Returns Promise<RealtimeTranscription>

list

list(
params?: ListRealtimeTranscriptionsParams,
): Promise<Page<RealtimeTranscription>>
List realtime transcriptions (paginated, async-iterable).
Parameters
- params: ListRealtimeTranscriptionsParams = {}
Returns Promise<Page<RealtimeTranscription>>

start

start(
roomId: string,
options?: StartRealtimeTranscriptionInput,
): Promise<RealtimeTranscription>
Start realtime transcription on a room's active session.
Parameters
- roomId: string
- options: StartRealtimeTranscriptionInput = {}
Returns Promise<RealtimeTranscription>

stop

stop(target: string | RealtimeTranscription): Promise<RealtimeTranscription>
Stop realtime transcription. Keyed by roomId (stops the room's running transcription) — pass a bare roomId or the object returned by RealtimeTranscriptionResource.start/get/list.
Parameters
- target: string | RealtimeTranscription
Returns Promise<RealtimeTranscription>