tencentVodPlayer
来自于: 厦门软云网络科技有限公司
常用方法
基本控制
播放器事件
高级控制
下载管理
论坛示例
该论坛提供了模块使用示例和问题反馈的入口，你可以在论坛中找到使用的Demo，以及问题反馈
概述
点播播放器简介
基于腾讯云强大的后台能力与 AI 技术，为客户提供视频点播能力的强大播放载体。播放器 SDK 深度融合腾讯云点播服务，拥有流畅稳定的播放性能，集广告植入、数据监测等功能于一身，覆盖多类应用场景，满足客户多样需求，让客户轻松聚焦于业务发展本身，畅享极速高清播放新体验。
为了获取更好的产品功能及播放性能体验，建议结合腾讯云点播使用
播放器特性
- 高性能播放 支持首屏秒开、清晰度无缝切换、码率自适应以及低卡顿率等功能特性
- 多样化播放方式 提供镜像播放、倍数播放等多样化播放方式
- 版权保护 支持视频加密，提供视频试看功能，全面保护您的视频版权
- 多种互动样式 播放器 SDK 提供弹幕功能及各类互动浮窗，提高用户互动率，助力业务生态建设
- 基础功能优化 播放器 SDK 包含进度条打点、进度条缩略图、直播时移及终端手势操作等基础功能，全面优化功能使用体验
- AI 智能结合 播放器 SDK 将腾讯云强大的 AI 技术智能结合，提供视频鉴黄、智能审核、智能字幕及片源修复等功能
- 数据实时监测 播放器 SDK 支持视频播放次数、播放热度分度等数据的实时监测，并提供详细的统计结果
- 支持 H.265 解码 播放器 SDK 支持 H.265 全新视频解码方式，提升压缩转码效率，减少播放时延，以更少的带宽观看更高清的视频
- 支持下载 播放器支持下载功能
模块接口
init
初始化播放器
init({params})
params
maxCacheItems:
- 类型: 数字
- 描述: (可选项)最多缓存文件个数
cacheFolderPath:
- 类型: 字符串类型
- 描述: (可选项)视频缓存目录, 点播MP4、HLS有效
- 注意: 缓存目录应该是单独的目录，模块可能会清掉其中的文件
connectRetry:
- 类型: JSON对象
- 描述: (可选项)重连配置
- 内部字段
{
count: 3 // 整数类型, 可选项, 播放器连接重试次数; 默认值3, 最小值为1,
// 最大值为10
interval: 3 // 整数类型, 可选值, 播放器连接重试间隔, 单位秒; 默认值3, 最小值3,
// 最大值30
}
timeout:
- 类型: 整数类型
- 描述: (可选项)超时时间, 单位秒
- 默认值: 10s
playerType:
类型: 整数类型 描述: (可选项)播放器类型 取值范围:
- 0: FFPLAY类型播放器
- 1: AVPLAYER类型播放器
headers:
类型: JSON对象 描述: (可选项)设置自定义http headers
enableAccurateSeek:
类型: 布尔类型 描述: (可选项)设置是否精确seek, 开启精确后seek，seek的时间平均多出200ms 默认值: true
autoRotate:
类型: 布尔类型 描述: (可选项)播放mp4文件时，若设为true则根据文件中的旋转角度自动旋转。旋转角度可在changeRotationEvt事件中获得 默认值: true
smoothSwitchBitrate:
类型: 布尔类型 描述: (可选项)平滑切换多码率HLS. 设为false时，可提高多码率地址打开速度; 设为true，在IDR对齐时可平滑切换码率 默认值: false
progressInterval:
类型: 整数类型 描述: (可选项)设置进度回调间隔; 间隔时间，单位毫秒 默认值: 0.5秒
maxBufferSize:
类型: 整数类型 描述: (可选项)最大预加载大小, 单位 MB; 此设x置会影响playableDuration, 设置越大, 提前缓存的越多
示例代码
var player = api.require("tencentVodPlayer");
player.init({
maxCacheItem: 3
});
可用性
iOS系统，Android系统
可提供1.0.0及更高版本
start
开始播放
start({params}, function(ret, err))
params
url:
- 类型: 字符串类型
- 描述: (必填项)从指定的URL播放
- 注意: 用户url模式播放和fileId模式播放，必须选择一种
fileId:
- 类型: 字符串类型
- 描述: (可选项)文件id, 文件上传转码后会生成唯一的fileId
appId:
- 类型: 整数类型
- 描述: (可选项)引用appId，如果才有fileId模式播放，appId为必填项
rect:
- 类型: JSON对象
- 描述: (可选项)播放器的位置以及尺寸
- 内部字段:
{
x: 0,
y: 0,
w: api.winWidth,
h: api.winWidth * 9 / 16
}
rect:
- 类型: JSON对象
- 描述: (可选项)播放器的位置以及尺寸
- 内部字段:
{
x: 0,
y: 0,
w: api.winWidth,
h: api.winWidth * 9 / 16
}
字段详情:
x:
- 类型: 整数类型
- 描述: (可选项)界面左上角x坐标(相对于所属的Window或Frame)
默认值: 0
y:
- 类型: 整数类型
- 描述: (可选项)界面左上角y坐标(相对于所属的window或frame)
默认值: 0
w:
- 类型: 整数类型
- 描述: (可选项)界面的宽度
默认值: 屏幕宽度
h:
- 类型: 整数类型
- 描述: (可选项)界面的高度
- 默认值: 屏幕的高度
fixedOn：
- 类型: 字符串类型
- 描述: (可选项)模块添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认: 模块依附于当前 window
fixed:
- 类型: 布尔
- 描述: (可选项)模块是否随所属 window 或 frame 滚动
- 默认值: true(不随之滚动)
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true
}
字段详情
status:
- 类型: 布尔类型
- 描述: true表示操作成功
err:
- 类型: JSON对象
- 内部字段:
{
code: -1
msg: '播放失败'
}
字段详情:
code:
- 类型: 整数类型
描述: 错误码
msg:
- 类型: 字符串类型
- 描述: 错误信息
示例代码
player.start({
rect: {
x: 0,
y: 500,
w: api.winWidth,
h: api.winWidth * 9 / 16
},
url: 'http://1251049911.vod2.myqcloud.com/8ac00de0vo/xxx.mp4'
});
可用性
iOS系统，Android系统
可提供1.0.0及更高版本
pause
暂停播放
pause()
示例代码
var player = api.require("tencentVodPlayer");
player.pause();
可用性
iOS系统，Android系统
可提供1.0.0及更高版本
resume
继续播放
resume()
示例代码
player.resume();
可用性
iOS系统，Android系统
可提供1.0.0及更高版本
show
显示播放器界面
show()
示例代码
player.show();
可用性
iOS系统，Android系统
可提供1.0.0及更高版本
hide
隐藏播放器界面
hide()
示例代码
player.hide();
可用性
iOS系统，Android系统
可提供1.0.0及更高版本
resize
重置播放器窗口大小
resize({params})
params
rect:
- 类型: JSON对象
- 描述: (可选项)播放器的位置以及尺寸
- 内部字段:
{
x: 0,
y: 0,
w: api.winWidth,
h: api.winWidth * 9 / 16
}
内部字段:
x:
- 类型: 整数类型
- 描述: (可选项)界面左上角x坐标(相对于所属的Window或Frame)
默认值: 0
y:
- 类型: 整数类型
- 描述: (可选项)界面左上角y坐标(相对于所属的window或frame)
默认值: 0
w:
- 类型: 整数类型
- 描述: (可选项)界面的宽度
默认值: 屏幕宽度
h:
- 类型: 整数类型
- 描述: (可选项)界面的高度
- 默认值: 屏幕的高度
示例代码
player.resize({
x: 0,
y: 0,
w: api.winWidth / 2,
h: api.winHeight / 2
});
可用性
iOS系统，Android系统
可提供1.0.0及更高版本
stop
停止播放
stopPlayer({}, function(ret, err))
callback(ret, err)
ret:
- 类型: JSON对象
- 内部字段
{
status: true
}
字段详情
true:
- 类型: 布尔类型
- 描述: true表示操作成功
err:
- 类型: JSON对象
- 内部字段:
{
code: 0
msg: "停止播放失败"
}
字段详情:
code:
- 类型: 整数类型
描述: 错误码
msg:
- 类型: 字符串类型
- 描述: 错误信息
示例代码
player.stop({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
destroy
销毁播放器
destroy()
示例代码
player.destroy();
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setPlayerEventListener
添加事件监听
setPlayerEventListener({}, function(ret))
callback
- 类型: JSON对象
- 描述: 内部字段
{
eventType: 'onPlayProgressEvt',
playable: 35000,
progress: 300,
duration: 500000
}
字段详情:
eventType:
- 类型: 字符串类型
- 描述: 事件名称
取值范围:
- onVodPlayPreparedEvt: 播放器已准备完成，可以播放
- onRcvFirstIFrameEvt: 网络接收到首个可渲染的视频数据包（IDR）
- onPlayBeginEvt: 视频播放开始，如果有加载动画这个时候可以停止了
- onPlayProgressEvt: 视频播放进度，会通知当前播放进度、加载进度和总体时长
- onPlayLoadingEvt: 视频播放 loading，如果能够恢复，之后会有 onVodLoadingEndEvt 事件
- onVodLoadingEndEvt: 视频播放 loading 结束，视频继续播放
- onPlayEndEvt: 视频播放结束
- onNetDisconnectErr: 网络断连，且经多次重连亦不能恢复，更多重试请自行重启播放
- onHlsKeyErr: HLS 解密 key 获取失败
- onVideoDecodeFailEvt: 当前视频帧解码失败
- onAudioDecodeFailEvt: 当前音频帧解码失败
- onReconnectWarn: 网络断连，已启动自动重连; 超过3次重连， onNetDisconnectErr事件
- onHwAccelerationFailWarn: 硬解启动失败，采用软解
- onChangeResolutionEvt: 视频分辨率改变
- oChangeRotationEvt: MP4 视频旋转角度
playable:
- 类型: 整数类型
描述: 加载进度, 单位毫秒
progress:
- 类型: 整数类型
描述: 播放进度, 单位毫秒
duration:
- 类型: 整数类型
- 描述: 视频总时长, 单位毫秒
示例代码
player.setPlayerEventListener({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
removePlayerEventListener
移除事件监听
removePlayerEventListener()
示例代码
player.removePlayerEventListener();
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setStartTime
设置开始播放时间 在start之前设置，修改开始播放的起始位置
setStartTime({params})
params
pos:
- 类型: 浮点类型
- 描述: (必填项)要开始播放的起始位置, 小数点后为毫秒
示例代码
player.setStartTime({
pos: 6
});
可用性
iOS系统，Android系统
可提供1.0.0及更高版本
isPlaying
是否正在播放
isPlaying({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true
}
字段详情:
status:
- 类型: 布尔类型
- 描述: 是否正在播放; true表示正在播放, false表示没有播放
示例代码
player.isPlaying({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
})
可用性
iOS系统，Android系统
可提供1.0.0及更高版本
setGesture
设置手势
setGesture({params}, function(ret))
params
isTap:
- 类型: 布尔类型
- 描述: (可选项)是否监听单击和双击手势
isLongPress:
- 类型: 布尔类型
- 描述: (可选项)是否监听长按手势
isSwipe:
- 类型: 布尔类型
- 描述: (可选项)是否监听滑动手势
isPan:
- 类型: 布尔类型
- 描述: (可选项)是否监听平移手势
- 注意: 如果监听平移手势，不建议同时监听滑动手势
callback
ret:
- 类型: JSON对象
- 内部字段
{
eventType: "pan",
direction: "horizontal",
x: 10,
y: 30,
distance: 15
}
字段详情:
eventType:
- 类型: 字符串类型
- 描述: 事件类型
取值范围:
- singleTap: 单击手势
- doubleTap: 双击手势
- swipe: 滑动手势
- pan: 平移手势
direction:
- 类型: 字符串类型
- 描述: 手势方向
取值范围:
- horizontal: 水平平移, 主要用于pan手势
- vertical: 垂直平移, 主要用于pan手势
- left: 向左滑动
- right: 向右滑动
- up: 向上滑动
- down: 向下滑动
x:
- 类型: 浮点数类型
描述: 平移的x坐标
y:
- 类型: 浮点数类型
描述: 平移的y坐标
distance:
- 类型: 浮点数类型
- 描述: 平移的距离
示例代码
player.addGesture({
isTap: true,
isLongPress: true,
isPan: true
}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
removeGesture
移除所有手势监听
removeGesture()
示例代码
player.removeGesture();
可用性
iOS, Android系统
可提供的1.0.0及更高版本
getBrightness
获取屏幕亮度
getBrightness({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段
{
value: 0.3
}
字段详情:
value:
- 类型: 浮点数类型
- 描述: 当前屏幕亮度
- 取值范围: 0-1
示例代码
player.getBrightness({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setBrightness
设置屏幕亮度
setBrightness({params})
params
value:
- 类型: 浮点数类型
- 描述: (必填项)屏幕亮度值
示例代码
var player = api.require("tencentVodPlayer");
player.setBrightness({
value: 0.6
})
可用性
iOS, Android系统
可提供的1.0.0及更高版本
getVolume
获取当前音量
getVolume({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段
{
value: 0.8
}
字段详情:
value:
- 类型: 浮点数类型
- 描述: 当前的音量值
示例代码
player.getVolume({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
})
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setVolume
设置音量
setVolume({params})
params
value:
- 类型: 浮点数类型
- 描述: (必填项)设置音量值
- 取值范围: 0-1
示例代码
player.setVolume({
value: 0.8
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
seek
跳转到某个时间播放
seek({params}, function(ret, err))
params
value:
- 类型: 浮点类型
- 描述: (必填项)要跳转的时间，单位秒
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true
}
字段详情:
status:
- 类型: 布尔类型
- 描述: true表示操作成功
err:
- 类型: JSON对象
- 内部字段:
{
code: 0
msg: "调整播放进度失败"
}
字段详情:
code:
- 类型: 整数类型
描述: 错误码
msg:
- 类型: 字符串类型
- 描述: 错误信息
示例代码
player.seek({
value: 5.6
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
getCurrentPlaybackTime
获取当前播放时间
getCurrentPlaybackTime({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
time: 10.5 // 浮点类型, 当前播放进度
}
字段详情:
time:
- 类型: 浮点数类型
- 描述: 当前播放进度
示例代码
player.getCurrentPlaybackTime({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
getDuration
获取视频总时长
getDuration({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
time: 335
}
字段详情
time:
- 类型: 浮点数类型
- 描述: 视频总时长
示例代码
player.getDuration({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
getPlayableDuration
getPlayableDuration({}, function(ret))
获取可播放时长
callback
ret:
- 类型: JSON对象
- 内部字段:
{
time: 335
}
字段详情
time:
- 类型: 浮点数类型
- 描述: 可播放时长
示例代码
player.getPlayableDuration({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
getWidth
获取视频宽度
getWidth({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
width: 350
}
字段详情
width:
- 类型: 整数类型
- 描述: 表示视频宽度
示例代码
player.getWidth({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
getHeight
获取视频高度
getHeight({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
height: 400
}
字段详情
height:
- 类型: 整数类型
- 描述: 视频高度
示例代码
player.getHeight({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setRenderMode
设置画面的裁剪模式, 自适应或铺满
setRenderMode({params})
params
mode:
- 类型: 整数类型
- 描述: (必填项)画面裁剪的模式
- 取值范围:
- 0: RENDER_MODE_FILL_EDGE, 将图像等比例缩放，适配最长边，缩放后的宽和高都不会超过显示区域，居中显示，画面可能会留有黑边
- 1: RENDER_MODE_FILL_SCREEN, 将图像等比例铺满整个屏幕，多余部分裁剪掉，此模式下画面不会留黑边，但可能因为部分区域被裁剪而显示不全
示例代码
player.setRenderMode({
mode: 0
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setRenderRotation
设置画面方向
setRenderRotation({params})
params
rotatoin:
- 类型: 整数类型
- 描述: (必填项)画面的方向
- 取值范围:
- 0: HOME_ORIENTATION_DOWN, home 在下面
- 1: HOME_ORIENTATION_RIGHT, home 在右边
- 2: HOME_ORIENTATION_UP, home 在上面
- 3: HOME_ORIENTATION_LEFT, home 在左边
示例代码
player.setRenderRotation({
rotation: 0
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setMute
设置是否静音
setMute({params})
params
isMute:
- 类型: 布尔类型
- 描述: (必填项)是否静音
- 默认值: true
示例代码
player.setMute({
isMute: true
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
snapShot
屏幕截图; 此功能只会截取当前视频流的视频画面，如果您需要截取当前的整个 UI 界面，请调用其他的模块来实现
snapShot({params}, function(ret))
params
path:
- 类型: 字符串类型
- 描述: (必填项)截图保存的路径
callback
ret:
- 类型: JSON类型
- 内部字段:
{
status: true
path: xxxxxx
}
字段详情:
status: 类型: 布尔类型 描述: 操作结果; true表示操作成功, false表示操作失败
path: 类型: 字符串类型 描述: 生成的截图图片路径
示例代码
player.snapshot:({
path: xxxxxxx
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setRate
设置播放速率
setRate({param})
params
rate:
- 类型: 浮点类型
- 描述: (必填项)rate 正常速度为1.0；小于为慢速；大于为快速。最大建议不超过2.0
- 默认值: 1.0
示例代码
player.setRate({
rate: 1.0
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
getSupportedBitrates
当播放地址为master playlist，返回支持的码率（清晰度）
getSupportedBitrates({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true
bitrateList: []
}
字段详情:
status:
- 类型: 布尔类型
描述: 操作是否成功; true表示获取成功, false表示获取失败
bitrateList:
- 类型: 数组类型
- 描述: 表示支持的码率列表
示例代码
player.getSupportedBitrates:({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
getBitrateIndex
获取当前正在播放的码率索引
getBitrateIndex({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段
{
status: true
index: 1
}
字段详情:
status:
- 类型: 布尔类型
描述: true表示操作成功
index:
- 类型: 整数类型
- 描述: 当前正在播放的视频的码率索引
示例代码
player.getBitrateIndex({}, function(ret, err) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setBitrateIndex
设置当前正在播放的码率索引，无缝切换清晰度 清晰度切换可能需要等待一小段时间; 腾讯云支持多码率HLS分片对齐，保证最佳体验
setBitrateIndex({params})
params
index:
- 类型: 整数类型
- 描述: (必填项)码率索引
示例代码
player.setBitrateIndex({
index: 1
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setMirror
设置镜像
setMirror({params})
params
isMirror:
- 类型: 布尔类型
- 描述: (必填项)是否设置镜像
示例代码
player.setMirror({
isMirror: true
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setHwAcc
是否开启硬件加速, 播放前设置有效
setHwAcc({params}, function(ret))
params
isHwAcc:
- 类型: 布尔类型
- 描述: (必填项)是否开启硬件加速
示例代码
player.setHwAcc({
isHwAcc: true
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
isHwAcc
是否开启硬件加速
isHwAcc({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true
}
字段详情
status:
- 类型: 布尔类型
- 描述: 是否开启硬件加速; true表示开启, false表示关闭
示例代码
player.isHwAcc({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS系统
可提供的1.0.0及更高版本
setAutoPlay
设置自动播放
setAutoPlay({params})
params
isAutoPlay:
- 类型: 布尔类型
- 描述: (必填项)是否自动播放
示例代码
player.setAutoPlay({
isAutoPlay: true
});
可用性
iOS系统
可提供的1.0.0及更高版本
isAutoPlay
获取当前是否自动播放
isAutoPlay({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true
}
字段详情:
status:
- 类型: 布尔类型
- 描述: 当前是否自动播放; ture表示自动播放, false表示不自动播放
示例代码
player.isAutoPlay({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setToken
设置加密HLS的token 设置此值后，播放器自动在URL中的文件名之前增加 voddrm.token.TOKEN
setToken({params})
params
token:
- 类型: 字符串类型
- 描述: (必填项)加密的token
示例代码
player.setToken({
token: 'fdafdfldjlfdsa'
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
getToken
获取加密HLS的token
getToken({}, function(ret))
params
token:
- 类型: 字符串类型
- 描述: (必填项)加密的token
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true
token: 'fkajfldajfd'
}
字段详情:
status:
- 类型: 布尔类型
描述: 表示操作是否成功; true表示操作成功, false表示操作失败
token:
- 类型: 字符串类型
- 描述: HSL加密token的值
示例代码
player.getToken({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS系统
可提供的1.0.0及更高版本
setLoop
设置是否循环播放
setLoop({params})
params
isLoop:
- 类型: 布尔类型
- 描述: (可选项)是否循环
示例代码
player.setLoop({
isLoop: true
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
isLoop
是否循环播放
setLoop({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段:
{
status: true
}
字段详情
status:
- 类型: 布尔类型
- 描述: 表示是否循环播放; true表示循环播放, false表示播放一次就停止
示例代码
player.setLoop({
isLoop: true
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
initDownload
初始化下载
initDownload({})
示例代码
player.initDownload();
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setDownloadEventListener
设置下载监听器
setDownloadEventListener({}, function(ret))
callback
ret:
- 类型: JSON对象
- 内部字段
{
eventType: "onDownloadProgress",
mediaInfo:
{
size: 13532432432,
downloadSize: 134312,
progress: 13.5
}
}
字段详情:
eventType:
- 类型: 字符串类型
- 描述: 事件类型
取值范围:
- onDownloadStart: 开始下载事件
- onDownloadProgress: 正在下载
- onDownloadStop: 停止下载
- onDownloadFinish: 下载完成
mediaInfo:
- 类型: JSON对象
内部字段
size:
- 类型: 整数类型
描述: 文件大小
downloadSize:
- 类型: 整数类型
描述: 已下载文件大小
progress:
- 类型: 浮点数类型
- 描述: 表示下载进度
示例代码
player.setDownloadEventListener({}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
})
可用性
iOS, Android系统
可提供的1.0.0及更高版本
removeDownloadEventListener
移除下载监听
removeDownloadEventListener()
示例代码
player.removeDownloadEventListener();
可用性
iOS, Android系统
可提供的1.0.0及更高版本
setDownloadPath
设置下载文件的根目录
setDownloadPath({params})
params
path:
- 类型: 字符串类型
- 描述: (必填项)下载文件的根目录
示例代码
player.setDownloadPath({
path: 'fs://widget/download'
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
startDownload
开始下载，url和fileId模式二选一
startDownload({params}, function(ret, err))
params
url:
- 类型: 字符串类型
- 描述: (必填项)下载地址
fileId:
- 类型: 字符创类型
- 描述: (可选项)指定文件的fileId, 需要同时指定appId
appId:
- 类型: 整数类型
- 描述: (可选项)应用id
示例代码
player.startDownload({
url: 'http://1253131631.vod2.myqcloud.com/2131631/f4bdff7990043041/playlist.m3u8'
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本
stopDownload
停止下载
stopDownload()
示例代码
player.stopDownload();
可用性
iOS, Android系统
可提供的1.0.0及更高版本
deleteDownloadFile
停止下载
deleteDownloadFile({path})
params
path:
- 类型: 字符串类型
- 描述: (必填项)要删除的下载文件路径
示例代码
player.stopDownload({
path: 'widget://video/abc.mp4'
});
可用性
iOS, Android系统
可提供的1.0.0及更高版本