playRtsp

来自于:开发者立即使用

概述

playRtsp 封装了播放rtsp://格式直播流功能。使用本模块时可把本模块当做一个 frame 添加在 window 或 frame 上。

init

初始化设置

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

params

doubleClick:

  • 类型:布尔
  • 描述:(可选项)是否双击视频播放界面进行横屏切换。
  • 默认值:true

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

示例代码

var demo = api.require('playRtsp');
demo.init({
    doubleClick : false
}, function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

play

播放rtsp://格式直播流

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

params

pageType:

  • 类型:字符串
  • 描述:(必输项)播放器当前挂载的页面类型,openWin:'Window',openFrame:'Frame';(备注:在win和frame上面进行全屏控制实现不一样,win要流畅很多,frame全屏时会卡一下,请注意。);(仅安卓有效)
  • 默认值:Frame

x:

  • 类型:数字类型
  • 描述:(必填项)模块左上角的 x 坐标(相对于所属的 Window 或 Frame);
  • 默认值:0

y:

  • 类型:数字类型
  • 描述:(必填项)模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
  • 默认值:0

w:

  • 类型:数字类型
  • 描述:(可选项)模块的宽度;默认:所属的 Window 或 Frame 的宽度

h:

  • 类型:数字类型
  • 描述:(可选项)模块的高度;默认:所属的 Window 或 Frame 的高度
  • 默认值:300

fixedOn:

  • 类型:字符串
  • 描述:(可选项)模块所属 Frame 的名字,若不传则模块归属于当前 Window

fixed:

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

url:

  • 类型:字符串
  • 描述:(必填项)视频资源地址,仅支持rtsp://

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var demo = api.require('playRtsp');
demo.play({
    x: 0,
    y: 250,
    h: 300,
    fixedOn: api.frameName,
    url: "rtsp://192.168.200.233:8554/test-0"
},
function(ret, err) {
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

pause

暂停播放

pause(callback(ret, err))

示例代码

var obj = api.require('playRtsp');
obj.pause(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

start

暂停后开始播放

start(callback(ret, err))

示例代码

var obj = api.require('playRtsp');
obj.start(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

stop

停止播放

stop(callback(ret, err))

示例代码

var obj = api.require('playRtsp');
obj.stop(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

isFullScreen

获取是否全屏播放状态

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

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true|false   //布尔型;true:全屏 false:窗口
}

示例代码

var demo = api.require('playRtsp');
demo.isFullScreen(function(ret, err) {
    console.log(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

full

全屏播放

full(callback(ret, err))

示例代码

var demo = api.require('playRtsp');
demo.full(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

unfull

退出全屏

unfull(callback(ret, err))

示例代码

var demo = api.require('playRtsp');
demo.unfull(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setVolume

设置音量大小(iOS设置的是系统音量,请退出播放后,将音量进行恢复操作)

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

params

volume:

  • 类型:数字型
  • 描述:(必填项)设置音量(0-100)
  • 默认值:0

示例代码

var demo = api.require('playRtsp');
demo.setVolume({
    process : 50
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

Android、iOS系统

可提供的1.0.0及更高版本