hikvision

论坛示例

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

概述

本插件已停止升级维护,请使用最新版本的插件。 /docs/Client-API/Open-SDK/ezOpen

萤石云简介

萤石云是一个视频云平台,萤石业务涵盖萤石云视频APP、萤石云视频服务平台、系列互联网产品(摄像机、硬盘录像机、视频盒子、报警盒子、云存储)等。

萤石云特色功能

  • 一站式VPaaS提供商:智能相机、萤石IOT云、高性能分发网络、全平台SDK、ALL in One。

  • 丰富的功能开放:包含实时视频、录像回放、双向语音、远程控制、消息推送、智能分析。

  • 极简应用集成:使用简单但强大的开发组件,即可轻松在您的应用中集成视频功能。

hikvision插件封装了萤石云的UI组件SDK,使用此插件可轻松把萤石云集成到自己的app内,可以实现播放实时监控画面,支持播放/暂停及回放。支持回放进度条的显示与隐藏

在集成此插件之前可先配置config文件,也可不配置config文件直接从前端js将appKey传入插件原生代码。

  • 名称:hikvision

  • 参数:appKey

  • 描述:appKey即是从萤石开放平台 开发者服务 我的应用中生成的appKey

  • 配置示例:

<feature name="hikvision"> 
<param name="appKey" value="163114c8-31b5-4424-bb85-617f81cf54d9" /> 
</feature> 

注意

  • Android 需要在升级环境下编译(在编译的时候勾选升级环境)
  • Android 固件版本为 4.3+
  • 本插件和gizWifiSDK插件不能一起使用
# **open**

打开实时监控

open(params)

params

appKey:

  • 参数:字符串类型
  • 描述:appKey即是从萤石开放平台 开发者服务 我的应用中生成的appKey,此参数也可在config文件中配置

accessToken:

  • 类型:字符串类型
  • 描述:AccessToken,即访问令牌。接口调用必备的公共参数之一,用于校验接口访问/调用是否有权限,有效期为7天,有效期内不需要重复申请,可以重复使用

url:

  • 类型:字符串类型
  • 描述:视频资源的URL

globalApiUrl:

  • 类型:字符串类型
  • 描述:对应区域服务器地址(不填写为国内版,填写为海外版,默认为国内版)

isProgress:

  • 类型:布尔
  • 描述:(可选项)是否显示回放进度条, 回放源地址本参数才会生效,否则回放进度条不显示
  • 默认值:true(显示回放进度条)

isBack:

  • 类型:布尔
  • 描述:(可选项)是否显示返回按钮;仅支持iOS
  • 默认值:false

rect:

  • 类型:JSON对象
  • 描述:(可选项)播放画面的位置及长宽
{
      x: 0,    //(可选项)数字类型;播放画面 x 坐标(相对于所属的 Window 或 Frame);默认值:0
      y: 0,    //(可选项)数字类型;播放画面 y 坐标(相对于所属的 Window 或 Frame);默认值:0
      w: 320,  //(可选项)数字类型;支持设置'auto';播放画面宽(相对于所属的 Window 或 Frame);默认值:屏幕宽度
      h: 300,  //(可选项)数字类型;支持设置'auto';播放画面高(相对于所属的 Window 或 Frame);默认值:300
}

autoLandFull:

  • 类型:布尔类型
  • 描述:(可选项)横屏时自动全屏
  • false

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)插件视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认:插件依附于当前 window

fixed:

  • 类型:布尔
  • 描述:(可选项)插件是否随所属 window 或 frame 滚动
  • 默认值:true(不随之滚动)

callback(ret, err)

ret:

  • 类型:JSON对象
  • 描述:播放结果;
  • 内部字段:
{
     status:true  //布尔类型;是否播放成功,true|false
}

err:

  • 类型:JSON对象
  • 描述:播放结果;
  • 内部字段:
{
     code: '',           //字符串类型;错误码
     msg: ''            //字符串类型;错误信息
}

示例代码

var hikvision = api.require('hikvision');
var params = {
        accessToken:'',
        url:'',
        rect:{
          x: 0,    //(可选项)数字类型;播放画面 x 坐标(相对于所属的 Window 或 Frame);默认值:0
          y: 0,    //(可选项)数字类型;播放画面 y 坐标(相对于所属的 Window 或 Frame);默认值:0
          w: 320,  //(可选项)数字类型;播放画面宽(相对于所属的 Window 或 Frame);默认值:屏幕宽度
          h: 300,  //(可选项)数字类型;播放画面高(相对于所属的 Window 或 Frame);默认值:300
        },
        isProgress:true
};
hikvision.open(params, function(ret, err) {
    if (ret.status) {
        api.alert({ msg:'播放成功'});
    } else {
        api.alert({ msg:JSON.stringify(err)});
    }
});

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

## **qrCode**

二维码扫描

qrCode();

callback(ret)

ret:

  • 类型:JSON对象
  • 描述:扫描结果;
  • 内部字段:
{
     status:true  //布尔类型;是否扫描成功,true|false
     data:{
         appKey: '',           //字符串类型;appKey
         accessToken: '',     //字符串类型;accessToken
         url: '',             //字符串类型;播放地址
         apiUrl: ''           //字符串类型;区域服务器地址
}
}

示例代码

var hikvision = api.require('hikvision');
hikvision.qrCode(function(ret) {
    if (ret.status) {
        api.alert({ msg:JSON.stringify(ret.data)});
    }
});

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

## **start**

开始播放实时监控画面

start();

params

示例代码

var hikvision = api.require('hikvision');
hikvision.start();

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

## **pause**

暂停播放实时监控画面

pause();

params

示例代码

var hikvision = api.require('hikvision');
hikvision.pause();

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

## **close**

关闭实时监控

close();

params

示例代码

var hikvision = api.require('hikvision');
hikvision.close();

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

## **show**

显示实时监控界面

show();

params

示例代码

var hikvision = api.require('hikvision');
hikvision.show();

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

## **hide**

隐藏实时监控界面

hide();

params

示例代码

var hikvision = api.require('hikvision');
hikvision.hide();

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

## **stop**

停止播放实时监控画面

stop();

params

示例代码

var hikvision = api.require('hikvision');
hikvision.stop();
是否仍需要帮助? 请保持联络!
最后更新于 2024/07/31