Skip to content

媒体播放 API

VOD 视频点播和背景音乐播放控制。

API 参考

getMediaPlayState()

获取当前 VOD 播放状态。

与 state.vodCurrentTime$(有 200ms 节流)不同,此方法调用时实时计算 currentTime, 在 VOD 暂停时能返回精确的暂停位置而非陈旧的信号值(修复 L-11)。 returning the exact pause position instead of a stale signal value when VOD is paused.

返回值: object


pauseMusic()

暂停背景音乐(老师端)。state.musicPlayStatus$ 变为 'paused'

返回值: Promise<TResult<void>>


pauseVod()

暂停 VOD 播放(老师端)。

暂停后所有学生端同步暂停,state.vodPlayStatus$ 变为 'paused'

返回值: Promise<TResult<void>>


resumeMusic()

恢复背景音乐(老师端)。

返回值: Promise<TResult<void>>


resumeVod()

恢复 VOD 播放(老师端)。

返回值: Promise<TResult<void>>


seekMusic()

跳转背景音乐播放进度(老师端,所有端同步)。

参数类型说明
timenumber播放进度(秒)

返回值: Promise<TResult<void>>


seekVod()

跳转 VOD 播放进度(老师端)。

跳转后所有学生端同步跳转到相同时间点。

参数类型说明
timenumber跳转时间点(秒)

返回值: Promise<TResult<void>>

示例:

ts
// 跳到第 30 秒 / Seek to 30s
await classroom.seekVod(30);

setMusicVolume()

设置背景音乐本地音量(仅本地生效,不广播信令)。

学生端可独立调整自己听到的音量,不影响其他人。

参数类型说明
volumenumber音量值(0~100)

返回值: Promise<TResult<void>>

示例:

ts
await classroom.setMusicVolume(50); // 50% 音量 / 50% volume

startMusic()

开始播放背景音乐(老师端)。

参数类型说明
paramMusicPlayParam音乐播放参数

返回值: Promise<TResult<void>>

示例:

typescript
const result = await classroom.startMusic({
  url: 'https://example.com/bgm.mp3',
  title: 'Background Music',
});
if (!result.ok) { console.error('Music start failed:', result.message); }

startVod()

开始播放 VOD 视频(老师端)。

参数类型说明
paramVodPlayParamVOD 播放参数(videoId 或 url 二选一)

返回值: Promise<TResult<void>>

示例:

typescript
const result = await classroom.startVod({ url: 'https://example.com/video.mp4' });
if (!result.ok) { console.error('VOD start failed:', result.message); }

stopMusic()

停止背景音乐(老师端,所有端同步停止)。

返回值: Promise<TResult<void>>


stopVod()

停止 VOD 播放(老师端)。停止后所有学生端关闭 VOD 播放器。

返回值: Promise<TResult<void>>