观看直播
VhallSDK API 文档
调用方式 : 实例化 VhallSDK 后，使用 SDK 实例访问 player模块下所有 API
API 总览
| 序号 | API 名称 | 功能描述 | 备注 |
|---|---|---|---|
| 1 | play | 播放 | |
| 2 | pause | 暂停 | |
| 3 | getSpeedList | 获取当前可支持倍速列表 | 仅点播可用 |
| 4 | setSpeed | 设置播放器倍速 | 仅点播可用；参数为 getSpeedList 返回数组内的倍速值 |
| 5 | canPlayDefinitions | 获取清晰度列表 | 回调返回当前活动支持的清晰度列表；a=音频，same=原画 |
| 6 | setPlayerDefinition | 设置清晰度 | 参 数为 canPlayDefinitions 返回数组内清晰度；same=原画，a=音频 |
| 7 | setCurrentTime | 设置回放视频时间 | 仅点播可用；参数单位：秒 |
| 8 | openBarrage | 打开弹幕功能 | 开启后，调用【发送聊天】接口发送消息，会展示为弹幕 |
| 9 | sendBarrage | 发送本地弹幕 | 仅本地回显；业务互动弹幕请使用【发送聊天】接口 |
| 10 | closeBarrage | 关闭弹幕功能 | |
| 11 | setBarrageInfo | 设置弹幕全局样式 | 可配置弹幕位置、透明度、字号、颜色、滚动区域、速度等 |
| 12 | setLoop | 设置循环状态 | 仅点播可用；SDK 版本 ≥3.5.4 |
| 13 | getLoop | 获取循环状态 | 仅点播可用；SDK 版本 ≥3.5.4 |
| 14 | getDuration | 获取当前视频总时长 | 仅点播可用，单位：秒；SDK 版本 ≥3.5.4 |
| 15 | getCurrentTime | 获取当前视频播放时间 | 仅点播可用，单位：秒；SDK 版本 ≥3.5.4 |
| 16 | setLimitSeek | 设置 seek 拖拽限制 | 仅点播可用；SDK 版本 ≥3.5.4 |
| 17 | getLimitSeek | 获取当前 seek 限制信息 | 仅点播可用；SDK 版本 ≥3.5.4 |
| 18 | setMute | 设置静音 | SDK 版本 ≥3.5.4 |
| 19 | getVolume | 获取音量 | 返回范围 0~100；SDK 版本 ≥3.5.4 |
| 20 | videoScreenshot | 视频截图 | 返回 base64 png 图片；SDK 版本 ≥3.5.4 |
play - 播放视频
pause - 暂停视频
setMute - 设置静音
可用于实现浏览器静音自动播放
getSpeedList - 获取点播支持倍速列表
仅点播可用
setSpeed - 设置点播倍速
仅点播可用；参数必须是 getSpeedList返回列表中的值
canPlayDefinitions - 获取清晰度列表
setPlayerDefinition - 设置清晰度
参数取自 canPlayDefinitions返回列表中的清晰度标识
setCurrentTime - 设置点播播放进度
仅点播可用
openBarrage - 打开弹幕
closeBarrage - 关闭弹幕
sendBarrage - 发送本地弹幕
仅本地展示回显；业务互动弹幕请调用【发送聊天】接口
setBarrageInfo - 设置弹幕全局样式
setLoop - 设置点播循环播放
仅点播可用；SDK ≥3.5.4
getLoop - 获取点播循环状态
仅点播可用；SDK ≥3.5.4
getDuration - 获取点播总时长
仅点播可用，返回单位：秒；SDK ≥3.5.4
getCurrentTime - 获取点播当前播放时间
仅点播可用，返回单位：秒；SDK ≥3.5.4
setLimitSeek - 设置点播进度拖拽限制
仅点播可用；SDK ≥3.5.4
getLimitSeek - 获取点播seek限制信息
仅点播可用；SDK ≥3.5.4
getVolume - 获取音量
返回 0~100；SDK ≥3.5.4
videoScreenshot - 视频截图
返回 base64 格式 png 图片；SDK ≥3.5.4
修改于 2026-09-22 07:20:18