字幕转写 API
实时语音转字幕功能(云端 ASR)。
API 参考
checkTranscriptionStatus()
查询字幕转写任务状态(从服务端拉取最新状态,用于进房后或异常重连时同步本地状态)。
返回值: Promise<TResult<{ status: TranscriptionStatus; }>>
示例:
ts
const r = await classroom.checkTranscriptionStatus();
if (r.ok && r.data.status === 'running') toggleSubtitlePanel(true);startTranscription()
开启字幕转写(老师端)。
| 参数 | 类型 | 说明 |
|---|---|---|
| userIds? | string[] | 需要转写的用户 ID 列表(不传则默认当前用户) |
返回值: Promise<TResult<void>>
示例:
typescript
// 开启当前用户的字幕转写
const result = await classroom.startTranscription();
if (!result.ok) { console.error('Transcription start failed:', result.message); }stopTranscription()
停止字幕转写(老师端)。所有端 state.subtitleEnabled$ 变为 false。
返回值: Promise<TResult<void>>
示例:
ts
await classroom.stopTranscription();