视频观看模块 功能API 说明
###调用方式: 在实例化,VhallSDK 之后, 用vhallSDK的实例句柄,下 player 模块进行调用访问。
API 列表
API 名称 | 功能描述 | 参数 | 返回值 | 备注 | |
---|---|---|---|---|---|
play | 自助操作 播放 | null | null | ||
pause | 自助操作 暂停 | null | null | ||
getSpeedList | 自助操作 获取当前可支持倍速列表 | callBack, 类型: Function | null | ||
setSpeed | 自助操作 设置播放器倍速 | speed, 类型: String | null | 参数为 getSpeedList 方法中返回数组的倍速值。 | |
canPlayDefinitions | 自助操作 获取清晰度列表 | callback, 类型:Function | data, 类型:Array | 回调返回当前活动可支持清晰度列表。 备注: (a:音频,same:原画) | |
setPlayerDefinition | 自助操作 设置清晰度 | definition, 类型: String | null | 参数为 canPlayDefinitions 方法中返回数组中的清晰度, same:代表原画, a: 代表音频 | |
setCurrentTime | 自助操作 设置回放视频时间 | s, 类型:Number | null | 参数为设置的秒数,仅可用于回放。 | |
setPlayerLine | 设置播放线路 | 2.5.0 之前的API 已废止 | |||
openBarrage | 自助操作 打开弹幕功能 | null | null | 不支持Flash类型活动 | |
sendBarrage | 自助操作 发送播放器弹幕 | text, 类型:String | null | 不支持Flash类型活动 | |
closeBarrage | 自助操作 关闭弹幕功能 | null | null | 不支持Flash类型活动 | |
setBarrageInfo | 自助操作 设置弹幕相关信息 | opt, 类型: Object | null | opt 示例: opt={ position: 0, alpha: 0.1, fontsize: 15 , color: ‘#ffffff’} position:位置 0上, 1中, 2下, 3全屏 ,alpha:透明度 0-1,fontsize: 字体大小 (number) ,color: 字体颜色 |
代码示例
var vhallSDKInstance = new VhallSDK({
... // 微吼SDK 初始化参数
})
// 自助操作 播放
vhallSDKInstance.player.play()
// 自助操作 暂停
vhallSDKInstance.player.pause()
// 自助操作 获取当前可支持倍速列表
vhallSDKInstance.player.getSpeedList((data) => {
// data = [0.5, 1, 2]
})
// 自助操作 设置倍速
vhallSDKInstance.player.setSpeed(speed)
// 自助操作 获取清晰度列表
vhallSDKInstance.player.canPlayDefinitions(callback)
// 自助操作 设置清晰度
vhallSDKInstance.player.setPlayerDefinition(definition)
// 自助操作 设置回放视频时间
vhallSDKInstance.player.setCurrentTime(s)
// 自助操作 打开弹幕
vhallSDKInstance.player.openBarrage()
// 自助操作 关闭弹幕
vhallSDKInstance.player.closeBarrage()
// 自助操作 发送弹幕
vhallSDKInstance.player.sendBarrage(text)
// 自助操作 设置弹幕样式
vhallSDKInstance.player.setBarrageInfo(opt)