更新记录
1.0.0(2023-12-14)
第一次提交,请先测试 未做各安卓版本测试,仅测试了几部手机
平台兼容性
Android | Android CPU类型 | iOS |
---|---|---|
适用版本区间:4.4 - 14.0 | armeabi-v7a:未测试,arm64-v8a:未测试,x86:未测试 | × |
原生插件通用使用流程:
- 购买插件,选择该插件绑定的项目。
- 在HBuilderX里找到项目,在manifest的app原生插件配置中勾选模块,如需要填写参数则参考插件作者的文档添加。
- 根据插件作者的提供的文档开发代码,在代码中引用插件,调用插件功能。
- 打包自定义基座,选择插件,得到自定义基座,然后运行时选择自定义基座,进行log输出测试。
- 开发完毕后正式云打包
付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios
注意事项:使用HBuilderX2.7.14以下版本,如果同一插件且同一appid下购买并绑定了多个包名,提交云打包界面提示包名绑定不一致时,需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择
百度官方文档 https://cloud.baidu.com/doc/FACE/s/pkd3xtfgn
const bdface = uni.requireNativePlugin('fun-bdface');
1.检查申请权限 checkRequestPermissions
checkRequestPermissions(result => {})
2.初始化 init
init({},result => {})
示例
let config = {
licenseFileName: 'idl-license.face-android', // 选填,默认值 idl-license.face-android
licenseId: '2019test01-face-android' //必填,在百度申请时填写的licenseId
}
bdface.init(config, result => {
})
3.设置 setFaceConfig or setFaceConfigSync
setFaceConfig({},result => {})
let result = setFaceConfigSync({})
示例
let config = {}
bdface.setFaceConfig(config, result => {
modal.toast({
message: "setFaceConfig:: " + JSON.stringify(result),
duration: 2
});
})
//或者
// let result = bdface.setFaceConfigSync(config);
// modal.toast({
// message: "setFaceConfig:: " + JSON.stringify(result),
// duration: 2
// });
设置参数
参数 | 名称 | 默认值 | 取值范围 |
---|---|---|---|
blurnessValue | 图像模糊阈值 | 0.7 | 0~1.0f |
brightnessValue | 图片最小光照阈值 | 82 | 0-255f |
brightnessMaxValue | 图片最大光照阈值 | 200 | 0-255f |
occlusionLeftEyeValue | 左眼遮挡阈值 | 0.5 | 0~1.0f |
occlusionRightEyeValue | 右眼遮挡阈值 | 0.5 | 0~1.0f |
occlusionNoseValue | 鼻子遮挡阈值 | 0.5 | 0~1.0f |
occlusionMouthValue | 嘴巴遮挡阈值 | 0.5 | 0~1.0f |
occlusionLeftContourValue | 左脸颊遮挡阈值 | 0.5 | 0~1.0f |
occlusionRightContourValue | 右脸颊遮挡阈值 | 0.5 | 0~1.0f |
occlusionChinValue | 下巴遮挡阈值 | 0.5 | 0~1.0f |
headPitchValue | 低头抬头角度 | 8 | 0~45 |
headYawValue | 左右摇头角度 | 8 | 0~45 |
headRollValue | 偏头角度 | 8 | 0~45 |
minFaceSize | 最小人脸阈值 | 200 | |
notFaceValue | 非人脸阈值 | 0.6f | 0~1.0f |
eyeClosedValue | 闭眼阈值 | 0.7f | 0~1.0f |
cacheImageNum | 图片缓存数量 | 3 | 建议3~6 |
openMask | 口罩模式采集 | true | |
maskValue | 口罩模式参数 | 0.7f | |
livenessList | 活体动作 | 全部 | 见下方 |
livenessRandom | 动作活体是否随机 | true | |
openSound | 开启提示音 | true | |
scale | 原图缩放系数 | 1.0f | |
cropHeight | 抠图宽高建议比例4:3 | 640 | |
cropWidth | 抠图宽高建议比例4:3 | 480 | |
enlargeRatio | 抠图人脸框与背景比例 | 1.5f | |
faceFarRatio | 检测超时设置 | 0.4f | |
faceClosedRatio | 检测框远近比率 | 1.0f | |
frontOrBack | 前后摄 1前摄 2后摄 | 1 | |
frontOrBackImage | 镜像 倒过来才可识别时开启 | false | |
bottomText | 底部文字 | ||
hasBottomText | 底部文字显示 | true | |
bottomTextColor | 底部文字颜色 | #000000 | |
hasBottomImg | 底部图片显示 | true | |
topTextColor | 顶部大字颜色 | #000000 | |
topSecondTextColor | 顶部第二行小字颜色 | #666666 | |
colorBg | 背景色 | #FFFFFF | |
colorCircleLine | 进度条线条初始颜色 | #CCCCCC | |
colorCircleSelectLine | 进度条线条完成颜色 | #00BAF2 |
//动作如下 Eye, Mouth, HeadRight, HeadLeft, HeadUp, HeadDown;
4.采集 faceDetect
faceDetect({},result => {})
示例
let config = {}
bdface.faceDetect(config, result => {})
设置参数
参数 | 名称 | 默认值 | 取值范围 |
---|---|---|---|
openMask | 口罩模式采集 | true | |
maskValue | 口罩模式参数 | 0.7f | |
openSound | 开启提示音 | true |
5.活体 faceLiveness
faceLiveness({},result => {})
示例
let config = {}
bdface.faceLiveness(config, result => {})
设置参数
参数 | 名称 | 默认值 | 取值范围 |
---|---|---|---|
livenessList | 活体动作 | 全部 | 见下方 |
livenessRandom | 动作活体是否随机 | true | |
openSound | 开启提示音 | true |
返回值 result.code
int OK = 0;// ok
int UNI_SDK_ERROR = 1;//
int EXCEPTION= 2; //插件处理出现异常,出现原因多种,如传入参数错误导致
int PERMISSION_DENY= 3; //拒绝权限Deny permission
int INIT_ERROR= 4; //插件SDK初始化失败
int UNINIT_ERROR= 5; //w未初始化
int RETRY_DIALOG= 12; //重试框弹出时
int RETRY= 13; //重试
int CANCEL= 14; //取消
int TIMEOUT= 20; //超时。
int DETECT_TIMEOUT= 21; //检测超时。
int INPUT_ILLEGAL= 40; //非法输入Illegal input
示例代码
<template>
<view class="content">
<image v-for="(img,i) in imgs" :key="i" class="logo" :src="img"></image><!-- 'data:image/png;base64,'+ -->
<view>
<button @click="checkRequestPermissions()">申请权限</button>
<button @click="init()">SDK初始化</button>
<button @click="setFaceConfig()">初始设置参数</button>
<button @click="faceLiveness()">活体检测[修剪]</button>
<button @click="faceDetect()">人脸图像采集</button>
</view>
<scroll-view scroll-y="true">
{{msg}}
<!-- <view class="msg" v-html="msg">
</view> -->
</scroll-view>
</view>
</template>
<script>
const bdface = uni.requireNativePlugin('fun-bdface');
const modal = uni.requireNativePlugin('modal');
var _this;
export default {
data() {
return {
title: 'Hello',
msg: '',
imgs: ['/static/logo.png'],
}
},
onLoad() {
_this = this;
},
methods: {
checkRequestPermissions() {
bdface.checkRequestPermissions(result => {
modal.toast({
message: "checkRequestPermissions:: " + JSON.stringify(result),
duration: 2
});
})
},
init() {
let config = {
licenseFileName: 'idl-license.face-android', // 选填,默认值 idl-license.face-android
licenseId: 'dyqs2019test01-face-android' //必填,在百度申请时填写的licenseId
}
bdface.init(config, result => {
modal.toast({
message: "init:: " + JSON.stringify(result),
duration: 2
});
})
},
setFaceConfig() {
let config = {
}
bdface.setFaceConfig(config, result => {
modal.toast({
message: "setFaceConfig:: " + JSON.stringify(result),
duration: 2
});
})
},
faceLiveness() {
let config = {}
bdface.faceLiveness(config, result => {
modal.toast({
message: "faceLiveness:: " + JSON.stringify(result.code),
duration: 2
});
if (result.code == 0) {
_this.imgs = [];
//直接显示
if (result.base64Image) {
_this.imgs.push('data:image/png;base64,' + result.base64Image);
}
_this.msg = result.base64Image;
if (result.base64ImageCrop) {
_this.imgs.push('data:image/png;base64,' + result.base64ImageCrop);
}
}
})
},
faceDetect() {
let config = {}
bdface.faceDetect(config, result => {
modal.toast({
message: "faceDetect:: " + JSON.stringify(result.code),
duration: 2
});
if (result.code == 0) {
_this.imgs = [];
//直接显示
if (result.base64Image) {
_this.imgs.push('data:image/png;base64,' + result.base64Image);
}
_this.msg = result.base64Image;
if (result.base64ImageCrop) {
_this.imgs.push('data:image/png;base64,' + result.base64ImageCrop);
}
}
})
},
inter(inx) {
_this = this;
let config = {
licenseName: 'idl-license',
licenseSuffix: 'face-android',
licenseId: 'XXXXXXXXXX-face-android',
liveActionArray: [], //liveActionArray比random优先级高。都不设置,默认3个。
random: 1, //取值1-6
bgColor: '#56445D', //选填
textColor: '#C5E99B' //选填
}
if (inx == 1) {
config['clipImg'] = false;
config['quality'] = 100;
funBaiduFace.faceLiveness(config, result => {
_this.msg = new Date().getHours() + ':' + new Date().getMinutes() + ':' + new Date()
.getSeconds() + ' ' +
JSON.stringify(result) + '<br/>' + _this.msg;
if (result.result == 'OK') {
_this.saveImgs(result.base64ImageMap);
} else {
console.log('失败:' + JSON.stringify(result));
}
});
} else if (inx == 6) {
config['clipImg'] = true;
config['quality'] = 80;
funBaiduFace.faceLiveness(config, result => {
_this.msg = new Date().getHours() + ':' + new Date().getMinutes() + ':' + new Date()
.getSeconds() + ' ' +
JSON.stringify(result) + '<br/>' + _this.msg;
if (result.result == 'OK') {
_this.saveImgs(result.base64ImageMap);
} else {
console.log('失败:' + JSON.stringify(result));
}
});
} else if (inx == 2) {
funBaiduFace.faceDetect(config, result => {
_this.msg = new Date().getHours() + ':' + new Date().getMinutes() + ':' + new Date()
.getSeconds() + ' ' +
JSON.stringify(result) + '<br/>' + _this.msg;
if (result.result == 'OK') {
_this.saveImgs(result.base64ImageMap);
} else {
console.log('失败:' + JSON.stringify(result));
}
});
}
},
saveImgs(imgsObj) {
let _this = this;
_this.imgs = [];
for (let key in imgsObj) {
var base64data = imgsObj[key];
//直接显示
_this.imgs.push('data:image/png;base64,' + base64data);
console.log('图片大小:::' + base64data.length);
//保存照片
// _this.saveImg(base64data);
}
},
saveImg(base64data) {
let _this = this;
var bitmap = new plus.nativeObj.Bitmap();
// console.log('--===:' + base64data);
bitmap.loadBase64Data(base64data, function() {
bitmap.save('_doc/baidu_head' + new Date().getTime() + '.png', {}, function(e) {
_this.imgs.push(e.target);
});
}, function() {
console.log('加载Base64图片,失败:' + JSON.stringify(e));
});
}
}
}
</script>
<style>
.content {
text-align: center;
height: 400upx;
}
.logo {
height: 200upx;
width: 200upx;
margin-top: 50upx;
}
.title {
font-size: 36upx;
color: #8f8f94;
}
.msg {
text-align: left;
padding: 40rpx;
font-size: 25rpx;
color: #F0AD4E;
}
</style>
其他
/////////////参数 默认值
String bottomText = "— 百度大脑技术支持 —";
String bottomTextColor = "#000000";
boolean hasBottomText = true;
boolean hasBottomImg = true;
String topSecondTextColor = "#666666";
String topTextColor = "#000000";
Color COLOR_BG = "#FFFFFF";
Color COLOR_CIRCLE_LINE = "#CCCCCC");
Color COLOR_CIRCLE_SELECT_LINE = "#00BAF2";
///////////////////参数 默认值 end
///////////////////初始化参数 开始
String licenseId;
String licenseFileName;
///////////////////初始化参数 end
///////////////////参数
// 设置模糊度阈值
Float blurnessValue";
// 设置最小光照阈值(范围0-255)
Float "brightnessValue";
// 设置最大光照阈值(范围0-255)
Float "brightnessMaxValue";
// 设置左眼遮挡阈值
Float "occlusionLeftEyeValue";
// 设置右眼遮挡阈值
Float "occlusionRightEyeValue";
// 设置鼻子遮挡阈值
Float "occlusionNoseValue";
// 设置嘴巴遮挡阈值
Float "occlusionMouthValue";
// 设置左脸颊遮挡阈值
Float "occlusionLeftContourValue";
// 设置右脸颊遮挡阈值
Float "occlusionRightContourValue";
// 设置下巴遮挡阈值
Float "occlusionChinValue";
// 设置人脸姿态角阈值
Int "headPitchValue";
Int "headYawValue";
Int "headRollValue";
///////////////
// 设置口罩模式
Boolean "openMask";
// 设置口罩阈值
String "maskValue";
// 设置可检测的最小人脸阈值
String "minFaceSize";
// 设置可检测到人脸的阈值
String "notFaceValue";
// 设置闭眼阈值
String "eyeClosedValue";
// 设置图片缓存数量
Int "cacheImageNum";
// 设置活体动作,数组,LivenessTypeEunm.Eye, LivenessTypeEunm.Mouth,
// LivenessTypeEunm.HeadUp, LivenessTypeEunm.HeadDown, LivenessTypeEunm.HeadLeft,
// LivenessTypeEunm.HeadRight
list<String> "livenessList";
// 设置动作活体是否随机
Boolean "livenessRandom";
//String FIELD_livenessRandomNum = "livenessRandomNum";
Boolean "ivenessRandomCount";
// 设置开启提示音
String "openSound";
// 原图缩放系数
Float "scale";
// 抠图宽高的设定,为了保证好的抠图效果,建议高宽比是4:3
Int "cropHeight";
// 抠图宽高的设定,为了保证好的抠图效果,建议高宽比是4:3
Int "cropWidth";
// 抠图人脸框与背景比例
String "enlargeRatio";
// 检测超时设置
Long "timeDetectModule";
//////// 个性化
// 设置前后摄 1前摄 2后摄
int "frontOrBack";
// 设置是否镜像 默认false, 需要上下颠倒才可识别时使用
Boolean "frontOrBackImage";
// 底部文字
String "bottomText";
String "bottomTextColor";
// 底部文字显示
Boolean "hasBottomText";
// 底部图片显示
Boolean "hasBottomImg";
// 顶部大字颜色
String "topTextColor";
// 顶部第二行小字颜色
String "topSecondTextColor";
// 背景颜色
String "colorBg";
// 进度条线条初始颜色
String "colorCircleLine";
// 进度条线条完成颜色
String "colorCircleSelectLine";
///////////////////参数
官方文档
https://ai.baidu.com/ai-doc/FACE/pkd3xtfgn
质量校验设置
参数 | 名称 | 默认值 | 取值范围 |
---|---|---|---|
minFaceSize | 最小人脸阈值 | 200 | |
notFaceValue | 非人脸阈值 | 0.6f | 0~1.0f |
brightnessValue | 图片最小光照阈值 | 宽松:30、正常:40、严格:60 | 0-255f |
brightnessMaxValue | 图片最大光照阈值 | 宽松:240、正常:220、严格:200 | 0-255f |
blurnessValue | 图像模糊阈值 | 宽松:0.8f、正常:0.6f、严格:0.4f | 0~1.0f |
occlusionLeftEyeValue | 左眼遮挡阈值 | 宽松:0.95f、正常:0.8f、严格:0.4f | 0~1.0f |
occlusionRightEyeValue | 右眼遮挡阈值 | 宽松:0.95f、正常:0.8f、严格:0.4f | 0~1.0f |
occlusionNoseValue | 鼻子遮挡阈值 | 宽松:0.95f、正常:0.8f、严格:0.4f | 0~1.0f |
occlusionMouthValue | 嘴巴遮挡阈值 | 宽松:0.95f、正常:0.8f、严格:0.4f | 0~1.0f |
occlusionLeftContourValue | 左脸颊遮挡阈值 | 宽松:0.95f、正常:0.8f、严格:0.4f | 0~1.0f |
occlusionRightContourValue | 右脸颊遮挡阈值 | 宽松:0.95f、正常:0.8f、严格:0.4f | 0~1.0f |
occlusionChinValue | 下巴遮挡阈值 | 宽松:0.95f、正常:0.8f、严格:0.4f | 0~1.0f |
headPitchValue | 低头抬头角度 | 宽松:30、正常:20、严格:15 | 0~45 |
headYawValue | 左右摇头角度 | 宽松:18、正常:18、严格:15 | 0~45 |
headRollValue | 偏头角度 | 宽松:30、正常:20、严格:15 | 0~45 |
eyeClosedValue | 闭眼阈值 | 0.7f | 0~1.0f |
cacheImageNum | 图片缓存数量 | 3 | 建议3~6 |
常见问题
(1)license文件有什么用,该放在什么地方?
license文件需要申请,目的是作为sdk校验开发者的使用合法性,license文件放置位置不对或未放置license文件会导致没法使用sdk,一般应先申请license文件,并把申请得到的license文件,放置在assets目录下面。 授权延期后要重新替换到SDK中,否则会因为授权过期导致无法使用。
(2)鉴权初始化的错误码对应的信息
ErrorCode | 常量值 | 说明 |
---|---|---|
SUCCESS | 0 | 成功 |
LICENSE_NOT_INIT_ERROR | 1 | license未初始化 |
LICENSE_DECRYPT_ERROR | 2 | license数据解密失败 |
LICENSE_INFO_FORMAT_ERROR | 3 | license数据格式错误 |
LICENSE_KEY_CHECK_ERROR | 4 | license-key(api-key)校验错误 |
LICENSE_ALGORITHM_CHECK_ERROR | 5 | 算法ID校验错误 |
LICENSE_MD5_CHECK_ERROR | 6 | MD5校验错误 |
LICENSE_DEVICE_ID_CHECK_ERROR | 7 | 设备ID校验错误 |
LICENSE_PACKAGE_NAME_CHECK_ERROR | 8 | 包名(应用名)校验错误 |
LICENSE_EXPIRED_TIME_CHECK_ERROR | 9 | 过期时间不正确 |
LICENSE_FUNCTION_CHECK_ERROR | 10 | 功能未授权 |
LICENSE_TIME_EXPIRED | 11 | 授权已过期 |
LICENSE_LOCAL_FILE_ERROR | 12 | 本地文件读取失败 |
LICENSE_REMOTE_DATA_ERROR | 13 | 远程数据拉取失败 |
LICENSE_LOCAL_TIME_ERROR | 14 | 本地时间校验错误 |
OTHER_ERROR | 0xff | 其他错误 |
(3)FaceSDK-LicenseLICENSE_INFO_CHECK_ERROR =license id
licenseID为您申请时填appname+“_face_android”。如下图demo-turnstile-face-android为license里面的licenseID, demo-turnstile-face-android1为app运行时Config.licenseID,两者必须一致
(4)FaceSDK-LicenseLICENSE_INFO_CHECK_ERROR =signature md5
md5不一致错误,签名的为license里面的md5,后面的为app运行时获取的签名文件的md5,这两个md5必须一致且区分大小写。
(5)FaceSDK-License LICENSE_INFO_CHECK_ERROR =package name
PackageName不一致错误。License里面的packagename为申请license时填的,需要保证和app里面的packagename一致。
(6)活体检测常见有那些动作?是否可配置?
常见有6个动作,眨眼,张大嘴,向上抬头,向下低头,向左摇头,向右摇头等。 sdk提供FaceConfig参数设置类,如活体检测角度、光线,检测动作,检测动作数量等设置。
(7)使用sdk一般会用到活体检测拍照等功能,有什么需要注意?
Android 6.0+,需要注意相机拍摄权限问题。如没申请权限,可能导致没法调起相机。
(8)在有些机型上出现特别卡或出现无响应?
SDK在armeabi上性能非常差,建议删掉其他so只留下armeabi-v7a,包括使用的其他第三方so。因为如果其他so有armeabi,根据android系统查找so的逻辑,在armeabi的机型上只会去该目录下查找so,而人脸SDK没有,就会出现找不到so。
(9)license 文件失效了,不能用了怎么办?
license文件申请时候有期限,如过期会导致校验失效,需要在后台申请延期。