baiduFaceLive

setLicense

initCollect

uninitCollect

setActions

setQualityLevel

openFaceLiveness

概述

baiduFaceLive 模块概述

本模块封装了百度开放平台的人脸识别离线采集客户端SDK(活体检测)，可以在客户端方便快捷的接入人脸识别功能。

模块使用攻略

使用之前须从百度开放平台申请开发者账号并完成企业认证，获取 LicenseID和 LicenseFileName。百度开发平台控制台

使用此模块之前建议先配置config.xml文件，配置完毕，需通过云端编译生效，配置方法如下：

  • 名称：baiduFaceLive
  • 参数：LicenseID_iOS、LicenseFileName_iOS、LicenseID_Android、LicenseFileName_Android
  • 配置示例:
<feature name="baiduFaceLive">
    <param name="LicenseID_iOS" value="test-zhaofei-face-ios"/>
    <param name="LicenseFileName_iOS" value="idl-license.face-ios"/>
    <param name="LicenseID_Android" value="test-zhaofei-face-android"/>
    <param name="LicenseFileName_Android" value="idl-license.face-android"/>
</feature>

**License文件打包模块包需注意事项请参考License打包模块包注意事项**，然后将制作好的授权模块包上传到自定义模块，添加到自己的App进行使用。

模块接口

setLicense

设置授权

setLicense({params}, callback(ret))

params

LicenseID_iOS：

  • 类型：字符串型
  • 描述：（必填项）iOS License ID

LicenseFileName_iOS：

  • 类型：字符串型
  • 描述：（必填项）iOS 授权文件（对应配套授权模块文件名称）

LicenseID_Android：

  • 类型：字符串型
  • 描述：（必填项）安卓 License ID

LicenseFileName_Android：

  • 类型：字符串型
  • 描述：（必填项）Android 授权文件（对应配套授权模块文件名称）

callback(ret)

ret：

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

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code : '',
    msg : ''
}

示例代码

var demo = api.require('baiduFaceLive');
demo.setLicense({
    LicenseID_Android: 'test-new-2020-face-android',
    LicenseFileName_Android: 'idl-license.face-android',
    LicenseID_iOS: 'test-new-2020-face-ios',
    LicenseFileName_iOS: 'idl-license.face-ios',
}, function (ret, err) {
    alert(JSON.stringify(ret) + "  " + JSON.stringify(err));
});

可用性

iOS系统，Android系统

可提供的1.1.0及更高版本

initCollect

初始化采集功能

initCollect({params}, callback(ret))

params

secType：

  • 类型：数字型
  • 描述：（可选项）设置图片加密类型，type=0 基于base64 加密；type=1 基于百度安全算法加密(当为1时，需要把加密文件打包到授权插件包里面idl-key.face-ios、idl-key.face-android)
  • 默认值：0

minFaceSize：

  • 类型：数字型
  • 描述：（可选项）设置最小检测人脸阈值 （在图片人脸能够被检测到最小值）80-200， 越小越耗性能，推荐120-200
  • 默认值：200

cropFaceWidth：

  • 类型：数字型
  • 描述：（可选项）设置截取人脸图片宽度大小
  • 默认值：480

cropFaceHeight：

  • 类型：数字型
  • 描述：（可选项）设置截取人脸图片高度大小
  • 默认值：640

notFace：

  • 类型：浮点型
  • 描述：（可选项）设置人脸检测精度阀值(0-1)
  • 默认值：0.6

occlusion：

  • 类型：浮点型
  • 描述：（可选项）设置人脸遮挡阀值（0-1） 推荐小于0.5
  • 默认值：0.5

callback(ret)

ret：

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

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code : '',
    msg : ''
}

示例代码

var demo = api.require('baiduFaceLive');
demo.initCollect(function(ret, err){
    api.toast({ msg : JSON.stringify(ret) +"  "+JSON.stringify(err)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

uninitCollect

卸载采集功能

uninitCollect({params}, callback(ret))

callback(ret)

ret：

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

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code : '',
    msg : ''
}

示例代码

var demo = api.require('baiduFaceLive');
demo.uninitCollect(function(ret, err){
    api.toast({ msg : JSON.stringify(ret) +"  "+JSON.stringify(err)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setActions

配置动作

setActions({params}, callback(ret))

params

actions：

  • 类型：数组型
  • 描述：（可选项）自定义动作
['Eye','Mouth','HeadUp','HeadDown','HeadLeft','HeadRight']

faceActionSum：

  • 类型：数字型
  • 描述：（可选项）人脸采集动作个数（最大5个动作,当设置actions参数时该参数无效）
  • 默认值：3

callback(ret)

ret：

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

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code : '',
    msg : ''
}

示例代码

var demo = api.require('baiduFaceLive');
demo.setActions(function(ret, err){
    api.toast({ msg : JSON.stringify(ret) +"  "+JSON.stringify(err)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setQualityLevel

配置质量等级

setQualityLevel({params}, callback(ret))

params

qualityLevel：

  • 类型：数字型
  • 描述：（可选项）质量等级（0：正常、1：宽松、2：严格）
  • 默认值：1

callback(ret)

ret：

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

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code : '',
    msg : ''
}

示例代码

var demo = api.require('baiduFaceLive');
demo.setQualityLevel(function(ret, err){
    api.toast({ msg : JSON.stringify(ret) +"  "+JSON.stringify(err)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openFaceLiveness

打开人脸识别界面(活体)

openFaceLiveness(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status: true,   //布尔型；true||false
    data : {    //base64图片 //success 有值 
        bestImage : '', //裁剪图片
        srcImage : '', //原图
        bestSecBase64 : '',//加密裁剪图片
        srcSecBase64 : '',//加密原图
    }
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code : '',
    msg : ''
}

示例代码

var demo = api.require('baiduFaceLive');
demo.openFaceLiveness(function(ret, err){
    api.toast({ msg : JSON.stringify(ret) +"  "+JSON.stringify(err)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2023/09/22