XYLink

来自于:开发者立即使用

概述

此模块封装了小鱼易连的监控SDK,可以通过此模块来远程监控摄像头的监控内容,由于小鱼易连SDK付费,使用之前需要和小鱼易连的销售联系,开通SDK,并注册应用;

使用此模块之前需先在 config.xml文件配置基础环境属性,方法如下

  • 名称:XYLink
  • 参数:extID

  • 配置示例

<feature name="XYLink">
        <param name="extID" value="70a9d79ad03b0ef40968783d21ee9bde75ec9693"/>
  </feature>
  • 字段描述:

    extID:企业ID;用户开通SDK后,小鱼易连分配的enterpriseId(AINEMO_EXT_ID)

android编译说明

  • 使用升级环境编译
  • 最低支持的版本为android4.4(API 19)

login

登录小鱼易连

login(params, callback(ret))

params

displayName

  • 类型:字符串
  • 描述:(必选项)用户的显示名;
  • 注:不支持如下字段
    ‘;' ‘:' ‘,' ‘=' ‘-' ‘(' ‘)' ‘[' ‘]' ‘{' ‘}' ‘@' ‘#' ‘*' '\' '\r’ '\n’ '\t'
    

externalUserId:

  • 类型:字符串
  • 描述:(必选项)唯一用户标示,需保证唯一,建议使用自己业务系统的UserID

callback(ret)

ret:

  • 类型:JSON对象
  • 描述:登录成功的状态
  • 内部字段:
status: true     //布尔类型;登录是否成功
number:‘12345678’ //字符串;登录成功后用户id;当status为true时此参数有值;link接口需要用到此参数;
username:''       //字符串;登录成功后的用户名;当status为true时此参数有值;link接口需要用到此参数;

示例代码

var XYLink = api.require('XYLink');
var params = {displayName:'apicloud', externalUserId:'1234567890'};
XYLink.login(params, function(ret){
    alert(JSON.stringify(ret));
})

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

link

连接终端设备

link(params)

params

deviceId:

  • 类型:字符串
  • 描述:(必选项) 终端设备id

password:

  • 类型:字符串
  • 描述:(可选项) 设备密码
  • 默认值:无

number:

  • 类型:字符串
  • 描述:(必选项) 用户id

username:

  • 类型:字符串
  • 描述:(可选项)用户名

示例代码

var XYLink = api.require('XYLink');
var params = {deviceId:'12345678', number:'1234567890'};
XYLink.login(params)

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本