mgCard

licenseForNetwork openVideoDetection closeVideoDetection detectImage

概述

封装了Face++的身份证质量检测 SDK

注意：本插件 iOS 平台上最低适配系统版本为 iOS 8.0

licenseForNetwork

调用联网授权代码进行授权

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

params

key：

  • 类型：字符串类型
  • 描述：apiKey，访问 Face++官网，登录后在控制台生成对应的key

secret：

  • 类型：字符串类型
  • 描述：apiSecret，访问 Face++官网，登录后在控制台生成对应的secret

url：

duration：

  • 类型：字符串类型
  • 描述：（可选项）appKey有效期
  • 默认：1

callback(ret, err)

ret：

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

err：

  • 类型：JSON 对象
  • 内部字段：
{  
  msg:''         //错误原因
}

示例代码

var mgCard= api.require('mgCard');
mgCard.licenseForNetwork({
  key:'',
  secret:''
},function(ret, err) {
    if (ret.status) {
        alert('成功');
    }
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

openVideoDetection

打开视频检测页面

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

params

isCard:

  • 类型：数字类型
  • 描述：（可选项）是否为证件
  • 取值范围：0 - 1.0
  • 默认：0.9

inBound:

  • 类型：数字类型
  • 描述：（可选项）是否在引导框内
  • 取值范围：0 - 1.0
  • 默认：0.8

clear:

  • 类型：数字类型
  • 描述：（可选项）是否清晰
  • 取值范围：0 - 1.0
  • 默认：0.8

shadowAreaTh:

  • 类型：数字类型
  • 描述：（可选项）被判定为阴影的最小面积
  • 取值范围：0 - 256*160
  • 默认：300

faculaAreaTh:

  • 类型：数字类型
  • 描述：（可选项）被判定为光斑的最小面积
  • 默认：300

cardAreaTh:

  • 类型：数字类型
  • 描述：（可选项）被判定为身份证的最小面积
  • 默认：20

flareType:

  • 类型：布尔类型
  • 描述：（可选项）光斑检测是否过滤
  • 默认：true

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
  status: true,     //布尔型；true||false；是否成功
  cardInfo: {       //json对象类型；身份证信息
    isIdcard:0,     //数字类型；是否为证件
    inBound:0,      //数字类型；是否在引导框内
    clear:0,        //数字类型；是否清晰
    image:'',       //字符串类型；检测的图片，整图的base64字符串
    cardImage:'',   //字符串类型；只有身份证的区域图片的base64字符串
    detectRect:{    //json对象类型；图片的裁剪区域
      x:0,          //数字类型；x坐标
      y:0,          //数字类型；y坐标
      w:100,        //数字类型；宽
      h:100         //数字类型；高
    },
    cardPointArray:[{//json数组对象类型；身份证边框点的数组 
      x:0,          //数字类型；x坐标
      y:0,          //数字类型；y坐标
    }],
    shadowsArray:[{ //json数组对象类型；阴影框的数组  
      x:0,          //数字类型；x坐标
      y:0,          //数字类型；y坐标
    }],
    faculaeArray:[{ //json数组对象类型；光斑框的数组 
      x:0,          //数字类型；x坐标
      y:0,          //数字类型；y坐标
    }],
  }
}

err：

  • 类型：JSON 对象
  • 内部字段：
{  
  msg:''         //错误原因
}

示例代码

var mgCard= api.require('mgCard');
mgCard.openVideoDetection({
  isCard:0.9,
  flareType:true
},function(ret, err) {
   console.log(JSON.stringify(ret))
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

closeVideoDetection

关闭视频检测页面

closeVideoDetection()

示例代码

var mgCard= api.require('mgCard');
mgCard.closeVideoDetection();

可用性

iOS、Android系统

可提供的1.0.0及更高版本

detectImage

检测图片

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

params

imagePath：

  • 类型：字符串类型
  • 描述：检测图片路径，支持fs、widget、base64

isCard:

  • 类型：数字类型
  • 描述：（可选项）是否为证件
  • 取值范围：0 - 1.0
  • 默认：0.9

inBound:

  • 类型：数字类型
  • 描述：（可选项）是否在引导框内
  • 取值范围：0 - 1.0
  • 默认：0.8

clear:

  • 类型：数字类型
  • 描述：（可选项）是否清晰
  • 取值范围：0 - 1.0
  • 默认：0.8

shadowAreaTh:

  • 类型：数字类型
  • 描述：（可选项）被判定为阴影的最小面积
  • 取值范围：0 - 256*160
  • 默认：300

faculaAreaTh:

  • 类型：数字类型
  • 描述：（可选项）被判定为光斑的最小面积
  • 默认：300

cardAreaTh:

  • 类型：数字类型
  • 描述：（可选项）被判定为身份证的最小面积
  • 默认：20

flareType:

  • 类型：布尔类型
  • 描述：（可选项）光斑检测是否过滤
  • 默认：true

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
  status: true,     //布尔型；true||false；是否成功
  cardInfo: {       //json对象类型；身份证信息
    isIdcard:0,     //数字类型；是否为证件
    inBound:0,      //数字类型；是否在引导框内
    clear:0,        //数字类型；是否清晰
    image:'',       //字符串类型；检测的图片，整图的base64字符串
    cardImage:'',   //字符串类型；只有身份证的区域图片的base64字符串
    clear:0,        //数字类型；是否清晰
    detectRect:{    //json对象类型；图片的裁剪区域
      x:0,          //数字类型；x坐标
      y:0,          //数字类型；y坐标
      w:100,        //数字类型；宽
      h:100         //数字类型；高
    },
    cardPointArray:[{//json数组对象类型；身份证边框点的数组 
      x:0,          //数字类型；x坐标
      y:0,          //数字类型；y坐标
    }],
    shadowsArray:[{ //json数组对象类型；阴影框的数组  
      x:0,          //数字类型；x坐标
      y:0,          //数字类型；y坐标
    }],
    faculaeArray:[{ //json数组对象类型；光斑框的数组 
      x:0,          //数字类型；x坐标
      y:0,          //数字类型；y坐标
    }],
  }
}

示例代码

var mgCard= api.require('mgCard');
mgCard.detectImage({
  imagePath:'',
  isCard:0.9
},function(ret) {
  api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高本

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