开放平台
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
  1. JS SDK
  • demo
  • JS SDK
    • 产品介绍
    • 快速接入
    • SDK 对接示例
    • 观看直播
    • 暖场视频
    • 房间消息说明
    • 互动连麦
    • 文档白板
    • 全局事件
    • 全局错误码
    • 版本更新记录
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-公告
      • 互动-商品
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-聊天
      • 互动-优惠券
      • 互动-点赞
    • 直播间拓展功能
      • 资料下载
      • 观看限制验证
      • 观看协议
      • 回放章节
  • 点播SDK
    • 点播上传SDK
    • 更新记录
  • iOS SDK
    • 整体介绍
    • 快速接入
    • SDK 登录
    • 暖场视频
    • 视频轮询
    • 直播彩排
    • 高级美颜
    • 云导播
    • 观看协议
    • 文档白板演示
    • 聊天功能
    • 视频直播
      • 发起视频直播
      • 观看视频直播
    • 互动直播
      • 观众互动
      • 推流摄像头
      • 互动直播API
      • 主播发起互动直播
      • 嘉宾加入互动直播
    • 无延迟直播
      • 主播发起无延迟直播
      • 观众观看无延迟直播
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-章节打点
      • 互动-公告
      • 互动-商品
      • 互动-计时器
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-优惠券
      • 互动-点赞
    • 直播间拓展能力
      • 直播间特色功能配置项
      • 文件下载
      • 修改角色昵称
      • 观看权限校验
      • 投屏
      • 虚拟人数
    • 观看回放
      • 观看回放
    • 防录屏
      • 跑马灯
    • 字段说明
      • 互动活动详情字段
      • 错误码说明
      • 常量定义
      • 活动详情字段说明
    • 版本更新说明
      • 版本更新信息
      • v2.3.0 到 v2.4.0 升级说明
      • v3.0.1 到 v3.2.0 升级说明
      • V2.9.0到v3.0.1升级说明
      • v6.3.0
      • v6.2.1
      • v3.2.0 到 v4.0.1
      • v2.7.0 到 v2.8.0、v2.9.0 升级说明
      • 6.5.0
      • v5.0.x 到 v6.0.0
      • v6.4.0
  • Adroid SDK
    • 整体介绍
    • 快速接入
    • SDK登录
    • 暖场视频
    • 视频轮巡功能
    • 直播彩排
    • 高级美颜
    • 云导播功能
    • 观看协议
    • 文档白板
    • 聊天功能
    • 房间消息
    • 信息采集说明
    • 视频直播
      • 发起视频直播
      • 观看视频直播
    • 互动直播
      • 互动直播API
      • 主播发起互动直播
      • 嘉宾加入互动直播
      • 观众观看互动直播
    • 无延迟直播
      • 主播发起无延迟直播
      • 观众观看无延迟直播
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-公告
      • 互动-商品
      • 互动-计时器
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-优惠券
      • 互动-点赞
    • 直播拓展功能
      • 修改角色名称
      • 文件下载
      • 投屏演示
      • 虚拟人数
      • 观看权限校验
      • 直播间特色功能配置项
    • 观看回放
      • 观看回放/点播
    • 防录屏
      • 直播水印
      • 跑马灯
    • 字段说明
      • 房间消息字段说明
      • 聊天消息字段说明
      • 活动详情字段说明
    • 版本更新说明
      • 更新记录
      • v6.4.0
      • v6.3.0
      • v6.2.3
      • v6.2.1
      • v6.2.0
      • v6.1.0
      • v6.0.0
      • v5.0.0
      • v4.1.0
      • v4.0.0
      • v3.3.0
  • APP嵌入支付说明
    • 支付调起说明
    • Scheme规则说明
  1. JS SDK

观看直播

调用方式#

在实例化,VhallSDK 之后, 用 vhallSDK 的实例句柄,下 player 模块进行调用访问。

API 列表#

序号API 名称功能描述备注
1play播放
2pause暂停
3getSpeedList获取当前可支持倍速列表(仅点播可用)仅点播可用
4setSpeed设置播放器倍速(仅点播可用)参数为 getSpeedList 方法中返回数组的倍速值。仅点播可用
5canPlayDefinitions获取清晰度列表回调返回当前活动可支持清晰度列表。 备注: (a:音频,same:原画)
6setPlayerDefinition设置清晰度参数为 canPlayDefinitions 方法中返回数组中的清晰度, same:代表原画, a: 代表音频
7setCurrentTime设置回放视频时间 (仅点播可用)参数为设置的秒数,仅点播可用
8openBarrage打开弹幕功能打开后使用发送聊天接口即可发送弹幕,收到聊天信息也会显示为弹幕
9sendBarrage发送弹幕此发送弹幕功能仅生效本地发送回显,实现互动弹幕使用发送聊天接口
10closeBarrage关闭弹幕功能
11setBarrageInfo设置弹幕相关信息opt 示例: opt={ position: 0, alpha: 0.1, fontsize: 15 , color: ‘#ffffff’} position:位置 0 上, 1 中, 2 下, 3 全屏 ,alpha:透明度 0-1,fontsize: 字体大小 (number) ,color: 字体颜色
12setLoop设置循环状态(仅点播可用)3.5.4 及以上
13getLoop获取循环状态(仅点播可用)3.5.4 及以上
14getDuration获取当前视频总时长(仅点播可用)3.5.4 及以上
15getCurrentTime获取当前视频播放时间(仅点播可用)3.5.4 及以上
16setLimitSeek设置 seek 限制(仅点播可用)3.5.4 及以上
17getLimitSeek获取当前 seek 限制信息(仅点播可用)3.5.4 及以上
18enterFullScreen进入全屏3.5.4 及以上
19exitFullScreen退出全屏3.5.4 及以上
20setMute设置静音3.5.4 及以上
21getVolume获取音量3.5.4 及以上
22videoScreenshot视频截图3.5.4 及以上

播放#

方法:play
示例:
//自助操作 播放视频

静音播放(实现自动播放)#

目前主流的浏览器中已经禁止带声音的媒体自动播放,但是支持静音自动播放,sdk 实现静音自动播放直接调用 sdk 的 play() 方法即可,代码如下:

暂停#

方法:pause
示例:

获取当前可支持倍速列表#

方法:getSpeedList
示例:

设置倍速#

方法:setSpeed
示例:

获取清晰度列表#

方法:canPlayDefinitions
示例:

设置清晰度#

方法:setPlayerDefinition
示例:

设置回放视频时间#

方法:setCurrentTime
示例:

打开弹幕#

方法:openBarrage
示例:

关闭弹幕#

方法:closeBarrage
示例:

发送弹幕#

方法:sendBarrage
示例:
参数:

设置弹幕相关信息#

方法:setBarrageInfo
示例:

设置循环状态#

方法:setLoop
示例:

获取循环状态#

方法:getLoop
示例:

获取当前视频总时长#

方法:getDuration
示例:

获取当前视频播放时间#

方法:getCurrentTime
示例:

设置 seek 限制#

方法:setLimitSeek
示例:

获取当前 seek 限制信息#

方法:getLimitSeek
示例:

进入全屏#

方法:enterFullScreen
示例:

退出全屏#

方法:exitFullScreen
示例:

设置静音#

方法:setMute
示例:

获取音量#

方法:getVolume
示例:

视频截图#

方法:videoScreenshot
示例:

常见问题#

1、是否支持自动播放视频?

答:支持直播播放视频,但是自动播放依赖于第三方浏览器的信任机制,即:同一个域名下,用户进入的时候,浏览器认为直接自动播放视频会干扰用户。因此需要当前用户观看时,播放的时间越长,看的次数越多,媒体信任指数就越高,才会实现自动播放(媒体信任指数仅保存在本地,更换浏览器或电脑都会影响自动播放),如下为建议示例:
修改于 2025-05-27 12:18:50
上一页
SDK 对接示例
下一页
暖场视频
Built with