playRtsp

init

play

pause

start

stop

isFullScreen

full

unfull

setVolume

playUrl

saveSnap

addEventListener

hide

show

概述

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

插件接口

init

初始化设置

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

params

doubleClick：

  • 类型：布尔
  • 描述：（可选项）是否双机视频播放界面进行横屏切换。
  • 默认值：true

isLocked：

  • 类型：布尔
  • 描述：（可选项）是否锁住屏幕，锁住屏幕后，执行全屏和退出全屏接口会无效。
  • 默认值：false

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

rect：

  • 类型：JSON 对象
  • 描述：（必填项）悬浮窗口UI播放的位置及尺寸
  • 内部字段：
{
    x: 0,   //（必填项）数字类型；插件左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
    y: 0,   //（必填项）数字类型；插件左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
    w: 320, //（必填项）数字类型；插件的宽度；默认值：手机屏幕的宽度
    h: 60  //（必填项）数字类型；插件的高度；默认值：手机屏幕的高度
}

fixedOn：

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

fixed：

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

url：

  • 类型：字符串
  • 描述：（必填项）视频资源地址，仅支持rtsp://

options：

  • 类型：数组
  • 描述：（可选项）vlc配置(请自行根据vlc配置规则配置安卓和iOS的参数)

callback(ret, err)

ret：

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

err：

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

示例代码

var demo = api.require('playRtsp');
demo.play({
    rect : {
        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

设置音量大小（1、ios设置的是系统音量，请退出播放后，将音量进行恢复操作。2、安卓设置的是视频音量，和安卓系统的本身音量大小有关。）

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及更高版本

playUrl

切换视频播放地址

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

params

url：

  • 类型：字符串
  • 描述：（必填项）视频资源地址，仅支持rtsp://

callback(ret, err)

ret：

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

err：

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

示例代码

var demo = api.require('playRtsp');
demo.playUrl({
   url: "rtsp://192.168.200.233:8554/test-0"
},
function(ret, err) {
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

saveSnap

截图

saveSnap(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
    path : '',//图片路径
}

err：

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

示例代码

var demo = api.require('playRtsp');
demo.saveSnap(function(ret, err) {
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addEventListener

播放器事件监听

addEventListener(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
{
    status: true,   //布尔型；true
    evenType : '',// playStop 播放器已经停止
                //buffering 流正在缓冲
                //playEnd 流已经结束
                //playError 播放器产生了错误
                //isPlaying 流正在播放
                //isPaused 流被暂停了
    buffing : 82,//缓冲进度（仅Android有值）
}

示例代码

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

可用性

iOS、Android系统

可提供的1.0.0及更高版本

hide

隐藏播放器

hide(callback(ret, err))

示例代码

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

可用性

iOS、Android系统

可提供的1.0.0及更高版本

show

隐藏后显示播放器

show(callback(ret, err))

示例代码

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

可用性

iOS、Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24