arcFaceFree
模块使用攻略
- 获取软虹授权信息后，config.xml(可选)配置信息如下：
<feature name="arcFaceFree">
<param name="appId_Android" value=""/>
<param name="sdkKey_Android" value=""/>
<param name="appId_iOS" value=""/>
<param name="sdkKey_iOS" value=""/>
</feature>
- 需要相机、存储、获取手机号码|IMEI权限
api.requestPermission({
list: ['camera', 'storage', 'phone-r'],
}, function(ret, err) {
api.alert({
msg: JSON.stringify(ret)
});
});
接口
active
在线激活引擎
active({params}, callback(ret, err))
params
appId_Android：
- 类型：字符串
- 描述：(可选项) 这里不填则config.xml必填。
sdkKey_Android：
- 类型：字符串
- 描述：(可选项) 这里不填则config.xml必填。
appId_iOS：
- 类型：字符串
- 描述：(可选项) 这里不填则config.xml必填。
sdkKey_iOS：
- 类型：字符串
- 描述：(可选项) 这里不填则config.xml必填。
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code: -1, //错误码
msg : '' //错误描述信息
}
示例代码
var obj = api.require('arcFaceFree');
obj.active(function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
activeOnline
在线激活引擎
activeOnline({params}, callback(ret, err))
params
appId_Android：
- 类型：字符串
- 描述：(可选项) 这里不填则config.xml必填。
sdkKey_Android：
- 类型：字符串
- 描述：(可选项) 这里不填则config.xml必填。
appId_iOS：
- 类型：字符串
- 描述：(可选项) 这里不填则config.xml必填。
sdkKey_iOS：
- 类型：字符串
- 描述：(可选项) 这里不填则config.xml必填。
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code: -1, //错误码
msg : '' //错误描述信息
}
示例代码
var obj = api.require('arcFaceFree');
obj.activeOnline(function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
isActivated
是否激活引擎
isActivated()
##ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var obj = api.require('arcFaceFree');
var ret = obj.isActivated();
alert(JSON.stringify(ret));
可用性
Android系统
可提供的1.0.0及更高版本
addUser
在本地注册用户
addUser({params}, callback(ret, err))
params
id：
- 类型：字符串
- 描述：(必填项) 用户唯一的id，用来区分每个用户的相关信息和存放位置，必须保证唯一。
name：
- 类型：字符串
- 描述：(可选项) 用户姓名。
gender：
- 类型：字符串
- 描述：(可选项) 用户性别。
ext：
- 类型：字符串
- 描述：(可选项) 扩展信息。
faceImage：
- 类型：字符串
- 描述：(必填项) 注册人员图片，(支持fs:// http://)。
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code: -1, //错误码
msg : '' //错误描述信息
}
示例代码
var obj = api.require('arcFaceFree');
obj.addUser({
id : '12222222',
faceImage : 'http://a06b9b3423f3cd5b8bee.qiniucdn.apicloud-system.com/apicloud/699f1793405ddd92167c6c94d005371d.jpg'
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
countUser
获取本地注册用户数
countUser(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
count : 0 //
}
示例代码
var obj = api.require('arcFaceFree');
obj.countUser(function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
clearAllUser
清空所有本地注册用户
clearAllUser(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var obj = api.require('arcFaceFree');
obj.clearAllUser(function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
removeUser
移除指定的本地注册用户
removeUser({params}, callback(ret, err))
params
userId：
- 类型：字符串
- 描述：(必填项)需要删除用户的用户id
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code: -1, //错误码
msg : '' //错误描述信息
}
示例代码
var obj = api.require('arcFaceFree');
obj.removeUser({
userId : '12222222'
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
getUser
获取指定的本地注册用户信息
getUser({params}, callback(ret, err))
params
userId：
- 类型：字符串
- 描述：(必填项)需要查询用户信息的用户id
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
id : '', //用户id
name : '', //姓名
gender : '', //性别
ext : '', //扩展
faceImage : '', //人脸图片
faceFeature : '' //特征信息
}
err：
- 类型：JSON对象
- 内部字段：
{
code: -1, //错误码
msg : '' //错误信息
}
示例代码
var obj = api.require('arcFaceFree');
obj.getUser({
userId : '12222222'
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
listUser
获取本地所有注册用户信息
listUser(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
list : [{
id : '', //用户id
name : '', //姓名
gender : '', //性别
ext : '', //扩展
faceImage : '', //人脸图片
faceFeature : '' //特征信息
}]
}
示例代码
var obj = api.require('arcFaceFree');
obj.listUser(function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
saveAllUser
批量保存所有注册用户信息
saveAllUser({params},callback(ret, err))
params
dataList：
- 类型：数组
- 描述：（必填项）需要导入数据数组
[{
id : '', //用户id
name : '', //姓名
gender : '', //性别
ext : '', //扩展
faceImage : '', //人脸图片
faceFeature : '' //特征信息
}]
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var obj = api.require('arcFaceFree');
obj.saveAllUser({
dataList : [{...}]
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
openCompare
打开自定义人脸对比界面
openCompare({params}, callback(ret, err))
params
rect：
- 类型：JSON 对象
- 默认值：见内部字段
- 描述：（可选项）浏览器窗口的位置和大小，设置margin后，在不同手机上面会保持与父页面的各方向边距一致，而中间区域会自动扩充。建议使用margin布局，可以完美适配带smartBar的手机。**(注意：当fixed设置false时，margin界面布局会异常)**
- 内部字段：
{
x:0, //左上角x坐标，默认0
y:0, //左上角y坐标，默认0
w:320, //宽度，默认'auto'，页面从x位置开始自动充满父页面宽度
h:480 //高度，默认'auto'，页面从y位置开始自动充满父页面高度
marginLeft:0, //相对父页面左外边距的距离，默认0
marginTop:0, //相对父页面上外边距的距离，默认0
marginBottom:0, //相对父页面下外边距的距离，默认0
marginRight:0 //相对父页面右外边距的距离，默认0
}
fixedOn：
- 类型：字符串
- 描述：（可选项）模块所属 Frame 的名字，若不传则模块归属于当前 Window
fixed：
- 类型：布尔
- 描述：（可选项）模块是否随所属 Window 或 Frame 滚动
- 默认值：true（不随之滚动）
cameraId：
- 类型：数字型
- 描述：（可选项）摄像头id (0是后置摄像头，1是前置摄像头)
- 默认值：1(前置摄像头)
rotate：
- 类型：数字型
- 描述：（可选项）人脸优先检测方向 ( 0： 90度，1：180度，2：0度，3：270度，4：360度)
- 默认值：安卓：3｜iOS：0
rotation：
- 类型：数字型
- 描述：（可选项）旋转角度ID (-1:getRotation()的值，0： 90度，1：180度，2：0度，3：270度，4：360度)[安卓有效]
- 默认值：-1
additionalRotation：
- 类型：数字型
- 描述：（可选项）额外的旋转角度（用于适配一些定制设备） (0： 0度，90：90度，180：180度，270：270度)[安卓有效]
- 默认值：0
mirrorHorizontal：
- 类型：布尔
- 描述：（可选项）mirrorHorizontal[安卓有效]
- 默认值：false
mirrorVertical：
- 类型：布尔
- 描述：（可选项）mirrorVertical[安卓有效]
- 默认值：false
rgbThreshold：
- 类型：浮点型
- 描述：（可选项）可见光活体检测阈值[安卓有效]
- 默认值：0.75
irThreshold：
- 类型：浮点型
- 描述：（可选项）红外活体检测阈值[安卓有效]
- 默认值：0.7
fqThreshold：
- 类型：浮点型
- 描述：（可选项）活体 FQ 检测阈值[安卓有效]
- 默认值：0.7
isKeepMaxFace：
- 类型：布尔
- 描述：（可选项）是否多人脸识别(true:单人 false:多人)[安卓有效]
- 默认值：true
similarThreshold：
- 类型：浮点型
- 描述：（可选项）活体检测阈值
- 默认值：0.8
maxDetectNum：
- 类型：数字型
- 描述：（可选项）最大人脸检测数量
- 默认值：10
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
err：
- 类型：JSON对象
- 内部字段：
{
code: -1, //错误码
msg : '' //错误信息
}
示例代码
var demo = api.require('arcFaceFree');
demo.openCompare({
rect: {
marginTop:45,
marginBottom:50
},
fixedOn : api.frameName,
fixed : true,
}, function(ret, err) {
alert(JSON.stringify(ret)+" "+JSON.stringify(err));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
closeCompare
关闭自定义人脸对比界面
closeCompare(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true //布尔型；true||false
}
示例代码
var demo = api.require('arcFaceFree');
demo.closeCompare(function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setRectView
设置人脸描绘框
setRectView({params}, callback(ret, err))
params
box：
- 类型：JSON串
- 描述：(可选项)人脸识别到时提示框配置
- 内部字段：
{
width: 2.0, //（可选项）数字类型；提示框边框粗细；默认：2.0
color: '#ADFF2F',//（可选项）字符串类型；提示框边框颜色，支持rgb、rgba、#；默认：#ADFF2F
}
textSize ：
- 类型： 数字型
- 描述：(可选项)字体大小
- 默认值：30
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var obj = api.require('arcFaceFree');
obj.setRectView({
box : {
width : 3,
color : '#ADFF2F'
}
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
setLivenessDetect
开启/关闭活体识别
setLivenessDetect({params}, callback(ret, err))
params
enable ：
- 类型： 布尔型
- 描述：(可选项)开启或者关闭活体检测 (true 开启 fasle 关闭)
- 默认值：true
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
}
示例代码
var obj = api.require('arcFaceFree');
obj.setLivenessDetect({
enable: false
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
takePhoto
抓拍图片
takePhoto({params}, callback(ret, err))
params
qualityValue ：
- 类型： 数字型
- 描述：(可选项)所拍照片质量 (1-100)
- 默认值：100
path ：
- 类型： 字符串型
- 描述：(可选项)图片保存路径，要求本地路径（fs://）
- 默认值：fs://
album ：
- 类型： 布尔型
- 描述：(可选项)拍照成功后是否将所拍图片存入系统相册
- 默认值：false
rotateDegree ：
- 类型： 数字型
- 描述：(可选项)处理图片旋转角度 (0,90,180,270)
- 默认值：270
format ：
- 类型： 字符串型
- 描述：(可选项)图片类型(jpeg png)
- 默认值：jpeg
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
imagePath : '' //照片路径
}
示例代码
var obj = api.require('arcFaceFree');
obj.takePhoto(function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
addFacepassListener
设置人脸对比通过结果监听
addFacepassListener(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
id : '', //用户id
similar : 0.9123
}
err：
- 类型：JSON对象
- 内部字段：
{
'code': -1, //错误code. -1 活体检测值低于阀值,活体验证失败!
//-2 未进行本地注册的用户!
//-3 人脸识别比对失败!
//-4 活体检测失败!
//-5 FR验证失败!
'msg' : '' //错误信息
}
示例代码
var obj = api.require('arcFaceFree');
obj.addFacepassListener(function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
iOS、Android系统
可提供的1.0.0及更高版本
removeFacepassListener
移除人脸对比通过结果监听
removeFacepassListener(callback(ret, err))
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true,
}
示例代码
var obj = api.require('arcFaceFree');
obj.removeFacepassListener();
可用性
iOS、Android系统
可提供的1.0.0及更高版本
processImage
图片本地对比识别
processImage({params}, callback(ret, err))
params
faceImage：
- 类型：字符串
- 描述：(必填项) 待识别人员图片，(支持fs:// http://)。
isKeepMaxFace：
- 类型：布尔
- 描述：（可选项）是否多人脸识别[安卓有效]
- 默认值：true
callback(ret, err)
ret：
- 类型：JSON对象
- 内部字段：
{
status: true, //布尔型；true||false
id : '', //用户id
similar : 0.9123
}
err：
- 类型：JSON对象
- 内部字段：
{
'code': -1, //错误code. -1 活体检测值低于阀值,活体验证失败!
//-2 未进行本地注册的用户!
//-3 人脸识别比对失败!
//-4 活体检测失败!
//-5 FR验证失败!
'msg' : '' //错误信息
}
示例代码
var obj = api.require('arcFaceFree');
obj.processImage({
faceImage : 'http://a06b9b3423f3cd5b8bee.qiniucdn.apicloud-system.com/apicloud/699f1793405ddd92167c6c94d005371d.jpg'
},function(ret, err) {
alert(JSON.stringify(ret));
});
可用性
Android系统
可提供的1.0.0及更高版本