tencentPlayer
来自于:开发者
open play pause resume stop close show hide seekTo setRect getCurrent getDuration clearCache
概述
注意:本模块是封装的腾讯视频播放器开放SDK,腾讯视频已经废弃该 SDK。所以本模块已停止更新
tencentPlayer 封装了腾讯视频直播播放器。该播放器是对视频播放功能的高度封装,界面布局都不可自定义,使用本模块时可把本模块当做一个 frame 添加在 window 或 frame 上。用户上下拖动播放区域的右边可改变音量大小,上下拖动播放区域的左边可调节屏幕亮度。左右轻扫,可快进/快退视频播放进度。
open
打开一个视频播放器
open({params}, callback(ret, err))
params
rect:
- 类型:JSON 对象
- 描述:(可选项)模块的位置及尺寸
- 内部字段:
{
x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认:0
y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
w: 320, //(可选项)数字类型;模块的宽度;默认:所属的 Window 或 Frame 的宽度
h: 300 //(可选项)数字类型;模块的高度;默认:w的3/4
}
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 描述:(可选项)模块是否随所属 window 或 frame 滚动
- 默认值:true(不随之滚动)
callback(ret, err)
ret:
- 类型:JSON 对象
- 内部字段:
{
eventType: //字符串类型;交互事件类型,取值范围:
//show(打开成功并显示)
//playing(开始播放)
//failed(播放失败)
//complete(播放完成)
//pause(暂停)
//stop(停止)
}
示例代码
var tencentPlayer = api.require('tencentPlayer');
tencentPlayer.open({
rect: {
x: 0,
y: 0,
w: 400,
h: 300
},
fixedOn: api.frameName,
fixed: true
}, function(ret, err) {
if (ret.status) {
alert(JSON.stringify(ret));
} else {
alert(JSON.stringify(err));
}
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
play
开始播放
play()
params
path:
- 类型:字符串
- 描述:(可选项)文档的路径,支持网络和本地(fs://)路径,在 android 平台上不支持 widget
示例代码
var tencentPlayer = api.require('tencentPlayer');
tencentPlayer.play({
path: 'http://7o50kb.com2.z0.glb.qiniucdn.com/c1.1.mp4'
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
pause
暂停播放
pause()
示例代码
var tencentPlayer = api.require('tencentPlayer');
tencentPlayer.pause();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
resume
恢复已暂停的播放
resume()
示例代码
var tencentPlayer = api.require('tencentPlayer');
tencentPlayer.resume();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
stop
停止播放
stop()
示例代码
var tencentPlayer = api.require('tencentPlayer');
tencentPlayer.stop();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
close
关闭播放器
close()
示例代码
var tencentPlayer = api.require('tencentPlayer');
tencentPlayer.close();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
show
显示视频播放视图
show()
示例代码
var tencentPlayer= api.require('tencentPlayer');
tencentPlayer.show();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
hide
隐藏视频播放视图
hide()
示例代码
var tencentPlayer= api.require('tencentPlayer');
tencentPlayer.hide();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
seekTo
跳转到指定播放位置
seekTo({params})
params
seconds:
- 类型:数字
- 描述:跳转到音视频播放的秒数,取值范围:大于0,小于视频总长度
示例代码
var tencentPlayer = api.require('tencentPlayer');
tencentPlayer.seekTo({
seconds: 20
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
setRect
设置视频播放器位置、尺寸,以及是否全屏
setRect({params}, callback(ret, err))
params
rect:
- 类型:JSON 对象
- 描述:(可选项)模块的位置及尺寸
- 内部字段:
{
x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认:0
y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
w: 'auto', //(可选项)数字类型;模块的宽度;当w为'auto'时,w为所属的 Window 或 Frame 的宽度,默认:open中设置的宽度
h: 300 //(可选项)数字类型;模块的高度;当h为'auto'时,h为所属的 Window 或 Frame 的高度,默认:open中设置的高度
}
animation:
- 类型:布尔
- 描述:(可选项)改变播放器大小时是否带动画效果
- 默认值:false
fullscreen:
- 类型:布尔
- 描述:(可选项)模块的位置及尺寸是否全屏(不显示状态栏)
- 默认值:false(不随全屏)
示例代码
var tencentPlayer = api.require('tencentPlayer');
tencentPlayer.setRect({
rect: {
x: 0,
y: 0,
w: '320',
h: '260'
},
animation: true,
fullscreen: false
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
getCurrent
获取当前播放时间
getCurrent(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
current: //数字类型;当前播放位置,单位为妙(s)
}
示例代码
var tencentPlayer = api.require('tencentPlayer');
tencentPlayer.getCurrent(function(ret) {
alert(JSON.stringify(ret));
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
getDuration
获取视频总时长,单位为妙(s)
getDuration(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
duration: //数字类型;当前播放视频总时长,单位为妙(s)
}
示例代码
var tencentPlayer = api.require('tencentPlayer');
tencentPlayer.getDuration(function(ret) {
alert(JSON.stringify(ret));
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
clearCache
清除视频缓存,仅支持 iOS 平台(android平台无缓存)
clearCache()
示例代码
var tencentPlayer= api.require('tencentPlayer');
tencentPlayer.clearCache();
可用性
iOS系统
可提供的1.0.0及更高版本