mgFace

licenseForNetwork initFace openVideoDetection closeVideoDetection switchCamera 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

uuid：

  • 类型：字符串类型
  • 描述：手机唯一序号。(有些设备会无法获取，导致授权失败，需要随机写一个值)

callback(ret, err)

ret：

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

err：

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

示例代码

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

可用性

iOS、Android系统

可提供的1.0.0及更高版本

initFace

初始化人脸检测器

initFace({params})

params

maxFaceCount：

  • 类型：数字
  • 描述：（可选项）一张图像中识别的最大人脸数，设置为1即为单脸跟踪
  • 默认：1

minFaceSize：

  • 类型：数字
  • 描述：（可选项）人脸大小,低于 100*100像素的⼈人脸将不不会被检测到
  • 默认：100

orientation：

  • 类型：数字
  • 描述：（可选项）旋转⻆角度，取值：0、90、180、270、360, 和视频帧的⽅方向保持一致
  • 默认：0

detectionMode：

  • 类型：数字
  • 描述：（可选项）检测类型
  • 默认：0
  • 取值范围：
    • 0：检测图⽚片
    • 3：检测视频流，速度较快
    • 4：检测视频流，精度较⾼

pixelFormatType：

  • 类型：数字
  • 描述：（可选项）视频流格式，注意要和你的视频流格式保持⼀致（仅iOS支持）
  • 默认：3
    • 0：GRAY
    • 1：BGR
    • 2：NV21
    • 3：RGBA
    • 4：RGB

faceConfidenceFilter：

  • 类型：数字
  • 描述：（可选项）置信度低于该值的人脸将会被忽略略, 防⽌止误检
  • 默认：80

callback(ret, err)（仅android支持）

ret：

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

示例代码

var mgFace= api.require('mgFace');
mgFace.initFace({
},function(ret, err) {
  console.log(JSON.stringify(ret))
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

openVideoDetection

打开视频检测页面

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

params

isAlign:

  • 类型：布尔串类型
  • 描述：（可选项）是否绘制脸部关键点
  • 默认：true

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
  status: true,      //布尔型；true||false；是否成功
  faces: [{       //json对象类型；人脸信息
    trackID:0,    //数字类型；tracking ID
    index:0,      //数字类型；在该张图片中人脸序号
    rect:{        //json对象类型；人脸的rect
      x:0,        //数字类型；x坐标
      y:0,        //数字类型；y坐标
      w:100,      //数字类型；宽
      h:100       //数字类型；高
    },
    points:[{     //json数组对象类型；人脸点坐标
      x:0,        //数字类型；x坐标
      y:0,        //数字类型；y坐标
    }],
    confidence:9  //数字类型；该张人脸质量
  }]
}

err：

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

示例代码

var mgFace= api.require('mgFace');
mgFace.openVideoDetection({
  isAlign:true
},function(ret, err) {
   console.log(JSON.stringify(ret))
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

closeVideoDetection

关闭视频检测页面

closeVideoDetection()

示例代码

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

可用性

iOS、Android系统

可提供的1.0.0及更高版本

switchCamera

切换摄像头，当前为前摄像头，切换为后摄像头，当前为后摄像头，切换为前摄像头

switchCamera()

示例代码

var mgFace = api.require('mgFace');
mgFace.switchCamera();

可用性

iOS、Android系统

可提供的1.0.0及更高版本

detectImage

检测图片

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

params

imagePath：

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

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
  faces: [{       //json对象类型；人脸信息
    trackID:0,    //数字类型；tracking ID
    index:0,      //数字类型；在该张图片中人脸序号
    rect:{        //json对象类型；人脸的rect
      x:0,        //数字类型；x坐标
      y:0,        //数字类型；y坐标
      w:100,      //数字类型；宽
      h:100       //数字类型；高
    },
    points:[{     //json数组对象类型；人脸点坐标
      x:0,        //数字类型；x坐标
      y:0,        //数字类型；y坐标
    }],
    confidence:9  //数字类型；该张人脸质量
  }]
}

示例代码

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

可用性

iOS、Android系统

可提供的1.0.0及更高版本

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