Subtitle API
Real-time speech-to-text transcription (subtitles) during class.
API Reference
checkTranscriptionStatus()
Query transcription task status (fetches the latest from the server; useful for post-join sync or after reconnect).
Returns: Promise<TResult<{ status: TranscriptionStatus; }>>
Example:
ts
const r = await classroom.checkTranscriptionStatus();
if (r.ok && r.data.status === 'running') toggleSubtitlePanel(true);startTranscription()
Start real-time transcription / subtitles (teacher side).
| Parameter | Type | Description |
|---|---|---|
| userIds? | string[] | User IDs to transcribe (defaults to current user) |
Returns: Promise<TResult<void>>
Example:
typescript
// 开启当前用户的字幕转写
const result = await classroom.startTranscription();
if (!result.ok) { console.error('Transcription start failed:', result.message); }stopTranscription()
Stop real-time transcription / subtitles (teacher side). state.subtitleEnabled$ becomes false on all clients.
Returns: Promise<TResult<void>>
Example:
ts
await classroom.stopTranscription();