txPlayer
来自于:开发者立即使用
open close puase resume setPath setRect replay seek getCurrent getDuration setRate getRate fullscreen cancelFullscreen getVol setVol getBrightness setBrightness pauseInBackground
论坛示例
为帮助用户更好更快的使用模块,论坛维护了一个示例,示例中包含示例代码、知识点讲解、注意事项等,供您参考。
概述
txPlayer 封装了腾讯播放器sdk(支持倍速播放,支持后台播放)。使用本模块时可把本模块当做一个 frame 添加在 window 或 frame 上。Android 平台上支持的的视频文件格式有:MP4、3GP、FLV、RTMP、M3U8;IOS 平台上支持的视频文件格式有:MOV、MP4、M4V、FLV、ACC、3GP、RTMP、M3U8等 ;
open
打开一个直播或点播
open({params},function(ret,err))
params
url
- 类型:字符串
- 描述:(必填项)视频资源地址,支持fs://、widget://(在 android 平台上不支持 widget)、rtmp://、http://
title
- 类型:字符串
- 描述:(可选项)不填时标题默认显示url地址
pos
- 类型:数值型
- 描述:视频播放开始地址,单位:秒。
pauseInBackground
- 类型:布尔型
- 描述:后台播放开关,false App在后台继续播放;true App在后台暂停播放,默认为true。
rect
- 类型:JSON 对象
- 描述:(可选项)视频区域的位置及尺寸
- 内部字段:
- {
- x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认:0
- y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
- w: 320, //(可选项)数字类型;模块的宽度;默认:所属的 Window 或 Frame 的宽度
- h: 300 //(可选项)数字类型;模块的高度;默认:w的3/4 }
callback(ret, err)
ret:
- 类型:JSON对象
- 内部字段:
{
cmd:"", //playing 播放回调,可以获取到当前播放的位置
//close close的回调;
//setPath setPath的回调;
//replay replay的回调;
//seek seek的回调;
//setRate setRate的回调;
//fullscreen fullscreen的回调;
//cancelFullscreen cancelFullscreen的回调;
//setVol setVol的回调;
//setRect setRect的回调;
//playerStatus 初始化视频返回的状态;当status==statusReady,会返回来一个视频时长duration
status:1,//statusReady视频准备好了可以播放;statusUnknown未知错误;statusFailed视频播放失败;
time:12//当cmd=='playing'时,返回来视频播放时间
}
示例代码
var txPlayer = api.require('txPlayer');
txPlayer.open({
url:'http://200024424.vod.myqcloud.com/200024424_709ae516bdf811e6ad39991f76a4df69.f20.mp4',
title:'title',
pos:10,
pauseInBackground:true,
frame:{x:0,y:0,w:200,h:200},
},function(ret, err){
if(ret.cmd=='playing'){
}else if(ret.cmd=='playerStatus'){
switch(ret.status){
case 'statusReady':
duration=ret.duration;//单位,秒。
console.log('视频准备好了')
break;
case 'statusUnknown':
console.log('未知错误')
break;
case 'statusFailed':
console.log('视频播放失败')
break;
}
}
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
close
关闭播放器并释放内存
close()
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.close()
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
pause
暂停播放
pause()
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.pause()
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
resume
继续播放
resume()
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.resume()
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
setPath
设置视频地址及标题,开始播放位置
params
url
- 类型:字符串
- 描述:(必填项)视频资源地址,支持fs://、widget://(在 android 平台上不支持 widget)、rtmp://、http://
title
- 类型:字符串
- 描述:(必填项)不填时标题默认显示url地址
pos
- 类型:数值型
- 描述:视频播放开始地址,单位:秒。
setPath({params},function(ret,err))
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.setPath({
url:'pauseInBackground',
title:'title',
pos:100,
})
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
setRect
设置视频区域大小。
setRect({params},function(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 }
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.setRect({rect: {x:0,y:0,w:200,h:200}})
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
replay
重播
replay()
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.replay()
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
seek
设置视频播放位置
seek({params})
params
pos
- 类型:数值型
- 描述:(可选项)视频播放开始位置,单位:秒。
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.seek({
pos:100
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
getCurrent
获取视频播放的位置
getCurrent()
callback(ret, err)
ret:
- 类型:JSON对象
- 内部字段:
{
cmd:"getCurrent",
data:99//当前视频播放时间,单位:秒。
}
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.getCurrent(function(ret,err){
alert(JSON.stringify(ret));
})
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
getDuration
获取视频总时长
getDuration()
callback(ret, err)
ret:
- 类型:JSON对象
- 内部字段:
{
cmd:"getDuration",
data:655//视频总时长,单位:秒。
}
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.getCurrent(function(ret,err){
alert(JSON.stringify(ret));
})
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
setRate
设置视频播放倍数
setRate()
params
speed
- 类型:数值型
- 描述:(可选项)设置视频播放倍速,范围0.5-2.0。
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.setRate({
speed:1.8,
})
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
getRate
获取视频播放的倍速
getRate()
callback(ret, err)
ret:
- 类型:JSON对象
- 内部字段:
{
cmd:"getRate",
data:1.8//当前视频播放倍数。
}
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.getRate(function(ret,err){
alert(JSON.stringify(ret));
})
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
fullscreen
全屏显示
fullscreen()
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.fullscreen()
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
cancelFullscreen
取消全屏显示
cancelFullscreen()
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.cancelFullscreen()
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
getVol
获取音量
getVol()
callback(ret, err)
ret:
- 类型:JSON对象
- 内部字段:
{
cmd:"getVol",
data:0.5//当前视频声音。
}
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.getVol(function(ret,err){
alert(JSON.stringify(ret));
})
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
setVol
设置音量
setVol()
params
value
- 类型:数值型
- 描述:设置声音,范围0-1.0。
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.setVol({
value:0.5,
})
可用性
iOS系统,Android系统 可提供的1.0.0及更高版本
getBrightness
获取亮度
getVol()
callback(ret, err)
ret:
- 类型:JSON对象
- 内部字段:
{
cmd:"getBrightness",
data:0.5//当前视频声音。
}
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.getBrightness(function(ret,err){
alert(JSON.stringify(ret));
})
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
setBrightness
设置亮度
setBrightness()
params
value
- 类型:数值型
- 描述:设置亮度,范围0-1.0。
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.setBrightness({
value:0.5,
})
可用性
iOS系统,Android系统 可提供的1.0.0及更高版本
pauseInBackground
设置是否在后台播放
pauseInBackground()
params
pauseInBackground
- 类型:布尔型
- 描述:后台播放开关,false App在后台继续播放;true App在后台暂停播放。
示例代码
var txPlayer=api.require('txPlayer');
txPlayer.pauseInBackground({
pauseInBackground:true,
})
可用性
iOS系统,Android系统 可提供的1.0.0及更高版本