组件properties
- apiId:String类型,应用的apiId。
- apiSecret:String类型,应用的apiSecret。
- action:Number类型,活体检测的动作。如果silent设置为true,则该选项无效。
- silent:Boolean类型,是否是静默活体,默认为false。
- autoError:Boolean类型,是否自动处理错误,默认为true。会通过微信原生弹窗显示错误消息。
- duration:Number类型,视频录制的时间,默认为5s,设置的值不可超过5s,否则以5s录制。
- uploadMsg:String类型,视频上传中的消息提醒,默认为"检测中..."。
组件事件
start事件
开始上传服务器检测之前会触发该事件
返参说明
- videoPath: 视频文件的本地临时目录。
success事件
活体检测结果返回成功后的回调函数
返参说明
- liveness_request_id:活体检测的请求id,主要用于排错。
- hack_request_id:防hack的请求id,主要用于排错。
- result:其存在一个motions属性,数组类型,保存着动作是否通过以及相应的分数。
- passed:动作检测结果的判定结果,通过为true,不通过为false
- feature_image_id:从活体视频中提取的一张特征照片,请调用liveness/liveness_image接口获取图片, 服务器仅保留该图片一小时,请及时保存图片。
- imagePath:下载image的远程url。
- hackPassed:是否通过防hack
- hackScore:防hack的分数
error事件
活体检测出错后的回调函数
返参说明
- errorCode:出错码
- errorMsg:出错的文字消息
- liveness_request_id:活体检测的请求id,主要用于排错。
- hack_request_id:防hack的请求id,主要用于排错。
end事件
活体检测成功或失败后,都会调用的回调函数
返参说明
无
liveness组件示例
建议用户将liveness组件放入一个单独的页面引入,然后通过路由的方式跳转到该页面。
页面中的json文件:
"usingComponents": {
"liveness": ”组件路径"
}
页面中的wxml文件:
<liveness api-id="xxxx" api-secret="yyyy" bindsuccess="requestSuccess" bindstart="start" binderror="error" bindend="end"/>
页面中的js文件:
Page({
start(e) {
console.log('start');
console.log(e)
},
error(e) {
console.log('error');
console.log(e);
},
end(e) {
console.log('end');
console.log(e);
},
requestSuccess(result) {
console.log('success');
console.log(result);
wx.navigateBack({
delta: 1
});
}
})