playModule

来自于：开发者立即使用

init play playUrl pause start stop getDuration getCurrentPosition full unfull addEventListener isFullScreen seekTo setVolume hidePlayer showPlayer setSpeed cleanPlayers updateUrlDatas sendDanmu sendDanmuList getAudioTrack setAudioTrack setMute

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码供您参考。

概述

playModule 封装了视频播放，音频播放，音轨切换，边播边缓存，弹幕等功能。使用本模块时可把本模块当做一个 frame 添加在 window 或 frame 上。Android 平台上支持的的视频文件格式有：MP4、3GP、FLV、RTMP、M3U8；IOS 平台上支持的视频文件格式有：MOV、MP4、M4V、FLV、ACC、3GP、RTMP、M3U8等 ;如果仅需要音频播放，请传isPlayMusic参数为true。(注意：请自行监听网络状态的切换，当手机网络切换时，播放器会把当前缓存的播放完后就会触发playError异常，此时需要App自行提示用户并重新打开播放器)

使用有ui方案播放器，可以通过左右滑动调节视频进度，左边上下滑动调节音量，右边上下滑动调节亮度。

模块效果图

描述

固件要求

Android：4.0及以上 iOS：8.0及以上

模块接口

init

初始化视频播放配置

init({params}, callback(ret, err))

params

ttf：

  • 类型：字符串
  • 描述：（可选项）设置标题显示文字字体文件路径，仅支持widget://

logo：

  • 类型：字符串
  • 描述：（可选项）右上角设置logo(图片类型：png)；支持fs://,widget://

background：

  • 类型：字符串
  • 描述：（可选项）视频播放前的图片显示(图片类型：jpg,png,gif)；支持fs://,widget://

FullScreenViewIsFont：

  • 类型：布尔型
  • 描述：（可选项）全屏view是否显示最上层,true:是|false:否，仅ios有效（为fasle时可通过openframe自定义按钮在播放器上层；注意，未开启沉侵式的App请不要设置该参数。）
  • 默认值：true

isShowBottomBtn：

  • 类型：布尔型
  • 描述：（可选项）全屏时是否隐藏手机底部虚拟键，仅Android有效。
  • 默认值：false

isMultiWindow：

  • 类型：布尔型
  • 描述：（可选项）是否开启多窗口模式(true 开启 false 不开启)。
  • 默认值：false

loading：

  • 类型：字符串
  • 描述：（可选项）加载中的gif动画图片接口(图片类型：gif)；支持fs://,widget://

logoLeftTop：

  • 类型：字符串
  • 描述：（可选项）左上角设置logo(图片类型：png)；支持fs://,widget://

logoLeftBottom：

  • 类型：字符串
  • 描述：（可选项）左下角设置logo(图片类型：png)；支持fs://,widget://

logoRightBottom：

  • 类型：字符串
  • 描述：（可选项）右下角设置logo(图片类型：png)；支持fs://,widget://

placeholderText：

  • 类型：字符串
  • 描述：（可选项）发送弹幕输入框默认提示内容。
  • 默认值：我要吐槽…

isShowLock：

  • 类型：布尔型
  • 描述：（可选项）全屏下是否显示锁屏按钮(true 显示 false 不显示)。
  • 默认值：true

示例代码

  1. var playModule = api.require('playModule');
  2. playModule.init({
  3.     ttf: "widget://res/UKIJTor.ttf",
  4.     logo:"widget://res/cklogo.png",
  5. });

可用性

Android、iOS系统

可提供的3.0.0及更高版本

play

播放本地视频、网络视频、rtmp直播流等

play({params}, callback(ret, err))

params

rect：

  • 类型：JSON 对象
  • 描述：（必填项）模块的位置及尺寸
  • 备注：iOS,Android 必须传此参数。
  • 内部字段：
  1. {
  2.     x: 0,   //（必填项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
  3.     y: 0,   //（必填项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
  4.     w: 320, //（必填项）数字类型；模块的宽度；默认值：所属的 Window 或 Frame 的宽度
  5.     h: 250  //（必填项）数字类型；模块的高度；默认值：250
  6. }

fixedOn：

  • 类型：字符串
  • 描述：（可选项）模块所属 Frame 的名字，若不传则模块归属于当前 Window

fixed：

  • 类型：布尔
  • 描述：（（可选项）模块是否随所属 Window 或 Frame 滚动
  • 默认值：true（不随之滚动）

url：

  • 类型：字符串
  • 描述：（必填项）视频资源地址，支持fs://、widget://(在 android 平台上不支持 widget)、rtmp://、http://

title：

  • 类型：字符串
  • 描述：（可选项）不填时标题默认显示url地址

defaultBtn：

  • 类型：布尔
  • 描述：（可选项）设置本次播放是否显示默认自带的播放控制按钮
  • 默认值：true（显示）

enableFull：

  • 类型：布尔
  • 描述：（可选项）本次播放视频是否全屏播放，当为true时将直接全屏播放视频，x,y,w,h,fixedOn,fixed值不会生效。
  • 默认值：false（窗口播放）

enableFullAutoClose：

  • 类型：布尔
  • 描述：（可选项）默认全屏时播放时，返回按钮和退出全屏点击时是否关闭播放器(true:关闭 false:不关闭)
  • 默认值：true（关闭）

isTopView：

  • 类型：布尔
  • 描述：（可选项）是否显示顶部标题栏
  • 默认值：true（显示）

isFullBtn：

  • 类型：布尔
  • 描述：（可选项）小窗口是否显示进入全屏按钮
  • 默认值：true（显示）

isBackBtn：

  • 类型：布尔
  • 描述：（可选项）小窗口是否显示返回按钮
  • 默认值：false（不显示）

scalingMode：

  • 类型：布尔
  • 描述：（可选项）视频播放显示铺满模式（1:无缩放, 2:适应大小模式, 3:充满可视范围，可能会被裁剪, 4:缩放到充满视图）
  • 默认值：1（无缩放）

fullscreenMode：

  • 类型：字符串
  • 描述：（可选项）设置全屏按钮控制全屏显示模式是横屏还是竖屏 竖屏:PORTRAIT ; 横屏:LANDSCAPE
  • 默认值：LANDSCAPE（横屏）

isShowProcessView：

  • 类型：布尔型
  • 描述：（可选项）是否显示进度条 (显示:true ; 不显示:false)【备注:直播流自动默认为false】
  • 默认值：true

isShowTimeLable：

  • 类型：布尔型
  • 描述：（可选项）是否显示播放时间 (显示:true ; 不显示:false)
  • 默认值：true

isLive：

  • 类型：布尔型
  • 描述：（可选项）是否直播视频源 （直播：true；点播：false）
  • 默认值：直播:rtmp://开头|rtsp://开头|.m3u8结尾;其余为非直播

isSmallOpenGesture：

  • 类型：布尔型
  • 描述：（可选项）窗口播放时是否开启手势控制音量，亮度和进度 （开启：true；不开启：false）
  • 默认值：false

isOpenGesture：

  • 类型：布尔型
  • 描述：（可选项）全屏时是否开启手势控制音量，亮度和进度 （开启：true；不开启：false）
  • 默认值：true

process：

  • 类型：数字型
  • 描述：（必填项）设置视频需要播放的时长
  • 默认值：0

isAutoPlay：

  • 类型：布尔型
  • 描述：（可选项）是否自动播放 (自动播放:true ; 不自动播放:false)
  • 默认值：true

isPlayMusic：

  • 类型：布尔型
  • 描述：（可选项）是否仅播放音频 (仅播放音频:true ; 视频播放:false)
  • 默认值：false

isLoop：

  • 类型：布尔型
  • 描述：（可选项）是否循环播放 (循环播放:true ; 禁止循环播放:false)
  • 默认值：false

urlDatas：

  • 类型：数组对象
  • 描述：（可选项）清晰度按钮的自定义(数组内容大于1条记录，清晰度切换按钮才会显示，不支持直播链接的组装切换，不能和url接口参数同时存在)。
  • 内部字段：
  1. [{
  2.     name: '',   //（必填项）清晰度名称
  3.     url: '',   //（必填项）视频资源地址，支持fs://、widget://(在 android 平台上不支持 widget)、http://
  4. }]

isSmallShowQxd：

  • 类型：布尔型
  • 描述：（可选项）是否窗口时显示清晰度选择按钮 (数组内容大于1条记录，清晰度切换按钮才会显示；显示:true ; 不显示:false)
  • 默认值：false

isMute：

  • 类型：布尔型
  • 描述：（可选项）是否静音播放 (开启静音:true ; 关闭静音:false)
  • 默认值：false

isShowDanmu：

  • 类型：布尔型
  • 描述：（可选项）是否开启弹幕功能 (开启:true ; 不开启:false)
  • 默认值：false

isLocalCache：

  • 类型：布尔型
  • 描述：（可选项）是否本地缓存视频,音频;直播类不能缓存,开发者自行控制;(备注:缓存文件在cache://文件目录下,如果直播乱开启改参数会导致播放异常). (开启:true ; 不开启:false)
  • 默认值：false

isShowFenxiang：

  • 类型：布尔型
  • 描述：（可选项）全屏是否显示分享按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isShowMore：

  • 类型：布尔型
  • 描述：（可选项）全屏是否显示更多按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isShowTouping：

  • 类型：布尔型
  • 描述：（可选项）全屏是否显示投屏按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isShowXuanji：

  • 类型：布尔型
  • 描述：（可选项）是否显示选集按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isShowNext：

  • 类型：布尔型
  • 描述：（可选项）是否显示下一集按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isShowPre：

  • 类型：布尔型
  • 描述：（可选项）是否显示上一集按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isSmallImmerse：

  • 类型：布尔型
  • 描述：（可选项）窗口播放顶部控制栏是否沉侵式 (显示:true ; 隐藏:false)
  • 默认值：false

isLongShowBackBtn：

  • 类型：布尔型
  • 描述：（可选项）窗口模式下是否长时间显示返回按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isSmallShowFenxiang：

  • 类型：布尔型
  • 描述：（可选项）窗口是否显示分享按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isSmallShowMore：

  • 类型：布尔型
  • 描述：（可选项）窗口是否显示更多按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isSmallShowTouping：

  • 类型：布尔型
  • 描述：（可选项）窗口是否显示投屏按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isOpenDanmu：

  • 类型：布尔型
  • 描述：（可选项）是否打开弹幕功能 (打开:true ; 关闭:false)
  • 默认值：true

singlePageModule：

  • 类型：布尔型
  • 描述：（可选项）是否打开单页面播放模式。（当设置为true时，本页面播放器的接口只能在当前页面调用，不能跨页面；同时本页面开启多窗口模式无效）
  • 默认值：false

isShowNetworkSpeed：

  • 类型：布尔型
  • 描述：（可选项）是否在缓冲的时候显示网速
  • 默认值：true

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3.     index : 0, //播放器序号
  4. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.play({
  3.     rect:
  4.     {    x: 0,
  5.         y : 0,
  6.         w : 320,
  7.         h: 250
  8.     },
  9.     fixedOn: api.frameName,
  10.     title: 'test',
  11.     url: 'http://resource.apicloud.com/video/apicloud3.mp4',
  12.     defaultBtn: true,
  13.     enableFull : false,
  14.      isTopView : false
  15. }, function(ret, err) {
  17. });

可用性

iOS、Android系统

可提供的3.0.0及更高版本

playUrl

同一个页面，已经调用play接口后，切换视频地址时调用（前提条件，同一界面已经调用过play接口）。

playUrl({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

url：

  • 类型：字符串
  • 描述：（必填项）视频资源地址，支持fs://、widget://(在 android 平台上不支持 widget)、rtmp://、http://

title：

  • 类型：字符串
  • 描述：（可选项）不填时标题默认显示url播放文件名

defaultBtn：

  • 类型：布尔
  • 描述：（可选项）设置本次播放是否显示默认自带的播放控制按钮
  • 默认值：true（显示）

isLive：

  • 类型：布尔型
  • 描述：（可选项）是否直播视频源 （直播：true；点播：false）
  • 默认值：直播:rtmp://开头|rtsp://开头|.m3u8结尾;其余为非直播

isSmallOpenGesture：

  • 类型：布尔型
  • 描述：（可选项）窗口播放时是否开启手势控制音量，亮度和进度 （开启：true；不开启：false）
  • 默认值：false

isOpenGesture：

  • 类型：布尔型
  • 描述：（可选项）全屏时是否开启手势控制音量，亮度和进度 （开启：true；不开启：false）
  • 默认值：true

process：

  • 类型：数字型
  • 描述：（必填项）设置视频需要播放的时长
  • 默认值：0

isAutoPlay：

  • 类型：布尔型
  • 描述：（可选项）是否自动播放 (自动播放:true ; 不自动播放:false)
  • 默认值：true

isLoop：

  • 类型：布尔型
  • 描述：（可选项）是否循环播放 (循环播放:true ; 禁止循环播放:false)
  • 默认值：false

isShowProcessView：

  • 类型：布尔型
  • 描述：（可选项）是否显示进度条 (显示:true ; 不显示:false)【备注:直播流自动默认为false】
  • 默认值：true

isShowTimeLable：

  • 类型：布尔型
  • 描述：（可选项）是否显示播放时间 (显示:true ; 不显示:false)
  • 默认值：true

urlDatas：

  • 类型：数组对象
  • 描述：（可选项）清晰度按钮的自定义(数组内容大于1条记录，清晰度切换按钮才会显示，不支持直播链接的组装切换，不能和url接口参数同时存在)。
  • 内部字段：
  1. [{
  2.     name: '',   //（必填项）清晰度名称
  3.     url: '',   //（必填项）视频资源地址，支持fs://、widget://(在 android 平台上不支持 widget)、http://
  4. }]

isSmallShowQxd：

  • 类型：布尔型
  • 描述：（可选项）是否窗口时显示清晰度选择按钮 (数组内容大于1条记录，清晰度切换按钮才会显示；显示:true ; 不显示:false)
  • 默认值：false

isMute：

  • 类型：布尔型
  • 描述：（可选项）是否静音播放 (开启静音:true ; 关闭静音:false)
  • 默认值：false

isShowDanmu：

  • 类型：布尔型
  • 描述：（可选项）是否开启弹幕功能 (开启:true ; 不开启:false)
  • 默认值：false

isLocalCache：

  • 类型：布尔型
  • 描述：（可选项）是否本地缓存视频,音频;直播类不能缓存,开发者自行控制;(备注:缓存文件在cache://文件目录下,如果直播乱开启改参数会导致播放异常). (开启:true ; 不开启:false)
  • 默认值：false

isShowFenxiang：

  • 类型：布尔型
  • 描述：（可选项）全屏是否显示分享按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isShowMore：

  • 类型：布尔型
  • 描述：（可选项）全屏是否显示更多按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isShowTouping：

  • 类型：布尔型
  • 描述：（可选项）全屏是否显示投屏按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isShowXuanji：

  • 类型：布尔型
  • 描述：（可选项）是否显示选集按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isShowNext：

  • 类型：布尔型
  • 描述：（可选项）是否显示下一集按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isShowPre：

  • 类型：布尔型
  • 描述：（可选项）是否显示上一集按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isSmallImmerse：

  • 类型：布尔型
  • 描述：（可选项）窗口播放顶部控制栏是否沉侵式 (显示:true ; 隐藏:false)
  • 默认值：false

isLongShowBackBtn：

  • 类型：布尔型
  • 描述：（可选项）窗口模式下是否长时间显示返回按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isSmallShowFenxiang：

  • 类型：布尔型
  • 描述：（可选项）窗口是否显示分享按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isSmallShowMore：

  • 类型：布尔型
  • 描述：（可选项）窗口是否显示更多按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isSmallShowTouping：

  • 类型：布尔型
  • 描述：（可选项）窗口是否显示投屏按钮 (显示:true ; 隐藏:false)
  • 默认值：false

isOpenDanmu：

  • 类型：布尔型
  • 描述：（可选项）是否打开弹幕功能 (打开:true ; 关闭:false)
  • 默认值：true

isShowNetworkSpeed：

  • 类型：布尔型
  • 描述：（可选项）是否在缓冲的时候显示网速
  • 默认值：true

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.playUrl({
  3.     title: 'test',
  4.     url: 'http://resource.apicloud.com/video/apicloud3.mp4',
  5.     defaultBtn: true
  6. }, function(ret, err) {
  8. });

可用性

iOS、Android系统

可提供的3.0.0及更高版本

pause

暂停播放

pause({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.pause(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS、Android系统

可提供的3.0.0及更高版本

start

暂停后开始播放

start({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.start(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS、Android系统

可提供的3.0.0及更高版本

stop

停止播放

stop({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.stop(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS、Android系统

可提供的3.0.0及更高版本

getDuration

获取视频的时长

getDuration({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3.     duration : 1221122//视频的总时长
  4. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.getDuration(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS、Android系统

可提供的3.0.0及更高版本

getCurrentPosition

获取已经播放的时长

getCurrentPosition({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3.     currentPosition : 2221//已经播放的时长
  4. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.getCurrentPosition(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS、Android系统

可提供的3.0.0及更高版本

full

全屏播放

full({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.full(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS、Android系统

可提供的3.0.0及更高版本

unfull

退出全屏

unfull({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.unfull(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS、Android系统

可提供的3.0.0及更高版本

addEventListener

视频播放完监听事件

addEventListener({params}, callback(ret, err))

params

name：

  • 类型：字符串
  • 描述：监听事件名称,可以设置的播放界面监听类型有：playEnd(播放结束),playError(播放异常),pause(暂停),play(播放),backBtn(小窗口返回按钮),full(进入全屏按钮),unfull(退出全屏按钮),click(视频区域点击监听),bufferingStart(缓冲开始),bufferingEnd(缓冲结束), onPrepared(视频准备完成),onChangeQxd(清晰度改变), fenxiangClick(分析按钮), moreClick(更多按钮), toupingClick(透明按钮), xuanjiClick(选集按钮), nextClick(下一集按钮), preClick(上一级按钮), sendDanmuMessage(发送弹幕输入框发送内容),danmuClick(弹幕开关按钮点击)

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2. status: true,   //布尔型；true
  3. index : 0, //播放器序号
  4. key : 0,//返回选择清晰度数组中序号
  5. currentPosition : 0,//返回当前选择清晰度时已经播放时长
  6. isOpenDanmu : true //当前弹幕是开或者关
  7. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.addEventListener({
  3.     name: 'playEnd'
  4. }, function(ret, err) {
  5.     console.log("addEventListener>>>>" + JSON.stringify(ret));
  6. });

可用性

iOS、Android系统

可提供的3.0.0及更高版本

isFullScreen

获取是否全屏播放状态

isFullScreen({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true|false   //布尔型；true:全屏 false:窗口
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var playModule = api.require('playModule');
  2. playModule.isFullScreen(function(ret, err) {
  3.     console.log("addEventListener>>>>" + JSON.stringify(ret));
  4. });

可用性

iOS、Android系统

可提供的3.0.0及更高版本

seekTo

设置播放进度位置(请根据视频最大时长进行参数控制传入)

seekTo({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

process：

  • 类型：数字型
  • 描述：（必填项）设置视频需要播放的时长
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var playModule = api.require('playModule');
  2. playModule.seekTo({
  3.     process : 402334
  4. },function(ret, err) {
  5.     alert(JSON.stringify(ret));
  6. });

可用性

Android、iOS系统

可提供的3.0.0及更高版本

setVolume

设置播音量

setVolume({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

volume：

  • 类型：数字型
  • 描述：（必填项）0-100
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var playModule = api.require('playModule');
  2. playModule.setVolume({
  3.     volume : 50
  4. },function(ret, err) {
  5.     alert(JSON.stringify(ret));
  6. });

可用性

Android、iOS系统

可提供的3.0.0及更高版本

hidePlayer

隐藏播放器

hidePlayer({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var playModule = api.require('playModule');
  2. playModule.hidePlayer(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android、iOS系统

可提供的3.0.0及更高版本

showPlayer

显示播放器

showPlayer({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var playModule = api.require('playModule');
  2. playModule.showPlayer(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android、iOS系统

可提供的3.0.0及更高版本

setSpeed

倍速播放

setSpeed({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

speed：

  • 类型：数字型
  • 描述：（必填项）设置视频播放倍速(取值范围 0.1-1.9)
  • 默认值：1.0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var playModule = api.require('playModule');
  2. playModule.setSpeed({
  3.     speed : 1.9
  4. },function(ret, err) {
  5.     alert(JSON.stringify(ret));
  6. });

可用性

Android、iOS系统

可提供的3.0.0及更高版本

cleanPlayers

清除页面所有打开的播放器接口(执行该接口后，返回index会归零)

cleanPlayers(callback(ret))

callback(ret)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true
  3. }

示例代码

  1. var playModule = api.require('playModule');
  2. playModule.cleanPlayers(function(ret, err) {
  3.     alert(JSON.stringify(ret));
  4. });

可用性

Android、iOS系统

可提供的3.0.0及更高版本

updateUrlDatas

更新清晰度选择列表地址(必须和play或者playUrl接口传的数组长度一致)。

updateUrlDatas({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

urlDatas：

  • 类型：数组对象
  • 描述：（可选项）清晰度按钮的自定义(数组内容大于1条记录，清晰度切换按钮才会显示，不支持直播链接的组装切换，不能和url接口参数同时存在)。
  • 内部字段：
  1. [{
  2.     name: '',   //（必填项）清晰度名称
  3.     url: '',   //（必填项）视频资源地址，支持fs://、widget://(在 android 平台上不支持 widget)、http://
  4. }]

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.updateUrlDatas({
  3.     urlDatas : [{
  4.         name : '标清',
  5.         url : 'http://www.nanchong.gov.cn/video/c21.flv'
  6.     },{
  7.         name : '高清',
  8.         url : 'http://www.nanchong.gov.cn/video/c22.flv',
  9.     },{
  10.         name : '普通',
  11.         url : 'http://www.nanchong.gov.cn/video/c23.flv',
  12.     }],
  13. }, function(ret, err) {
  15. });

可用性

iOS、Android系统

可提供的3.0.9及更高版本

sendDanmu

发送一条弹幕信息

sendDanmu({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

text：

  • 类型：字符串
  • 描述：（必填项）弹幕文字内容

color：

  • 类型：字符串
  • 描述：（可选项）弹幕文字显示颜色代码
  • 默认值：#FFFAFA

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var demo = api.require('playModule');
  2. demo.sendDanmu({
  3.     text : '测试2测试2测试2测试2',
  4.     color : '#FF7F24'
  5. },function(ret,err){
  6. });

可用性

iOS、Android系统

可提供的3.1.6及更高版本

sendDanmuList

发送多条弹幕信息。

sendDanmuList({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

isLoop：

  • 类型：布尔型
  • 描述：（可选项）天际的全部数据是否循环播放(循环:true，不循环:false)
  • 默认值：false

data：

  • 类型：数组对象
  • 描述：（必填项）多条弹幕信息记录。
  • 内部字段：
  1. [{
  2.     text: '',   //（必填项）弹幕文字内容
  3.     color: '',   //（可选项）弹幕文字显示颜色代码[默认值:#FFFAFA]
  4. }]

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.sendDanmuList({
  3.     data : [{
  4.             text : '测试1',
  5.             color : '#FF7F24'
  6.         },{
  7.             text : '测试2测试2测试2测试2',
  8.             color : '#FF7F24'
  9.         }],
  10. }, function(ret, err) {
  11. });

可用性

iOS、Android系统

可提供的3.1.6及更高版本

getAudioTrack

获取音轨数量。

getAudioTrack({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3.     tracksNum : 1.  //音轨数量
  4. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.getAudioTrack(function(ret, err) {
  3. });

可用性

iOS、Android系统

可提供的3.1.8及更高版本

setAudioTrack

设置音轨(原音|伴音)[仅对多音轨有效]

setAudioTrack({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

trackId：

  • 类型：数字型
  • 描述：（可选项）音轨序号(双音轨>1:原音 2伴音)
  • 默认值：0(无效)

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.setAudioTrack({
  3.     trackId : 1
  4. }, function(ret, err) {
  5. });

可用性

iOS、Android系统

可提供的3.1.8及更高版本

setMute

静音开关切换

setMute({params}, callback(ret, err))

params

index：

  • 类型：数字型
  • 描述：（可选项）播放器序号
  • 默认值：0

isMute：

  • 类型：布尔型
  • 描述：（可选项）是否静音(开启静音:true 关闭静音:false)
  • 默认值：false

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     msg: ""
  3. }

示例代码

  1. var obj = api.require('playModule');
  2. obj.setMute({
  3.    isMute : true
  4. }, function(ret, err) {
  5. });

可用性

iOS、Android系统

可提供的3.1.8及更高版本