Appearance
初始化配置
注意
- uniappx项目中配置的属性名称为
configX - uniapp项目配置的属性名称为
config
配置方式
js
//组件配置
config: {
//相机属性,所有的参数都可以不传,不传则按默认的
camera: {
// 相机预览旋转角度
rotation: 270,
//相机模式,1.前置,0.后置(默认)
facing: 0,
// 摄像机预览圆角,默认:0
radius: 50,
//预览分辨率,默认:[1280,720]
size: [1280, 720],
//是否锁定屏幕启动方向,默认:true
screenLocked: true,
//是否回调预览数据,默认:false
isPreviewFrame: false,
//预览数据回调时间,单位:毫秒,为0不做限制,有数据就回调
previewTime: 0
},
// 视频检测配置,所有参数都可以不传,不传则按默认的
video: {
// 视频检测角度,可接收参数,0,90,180,270,360(默认)
orient: 360,
// 人脸框是否处于X反向状态,如果未设置该参数人脸框和人脸处于反向请将该参数设置为true
isContraryX: false,
// 人脸框是否处于Y反向状态,如果未设置该参数人脸框和人脸处于反向请将该参数设置为true
isContraryY: false,
// 识别阈值(默认:0.8)
similar: 0.9,
// 是否进行活体检测(默认为true)
liveness: true,
//识别是否展示面部信息(默认为true)
showFaceInfo: false,
//活体检测阈值设置
livenessParams: {
//可见光活体检测阈值,默认:0.5
rgb: 0.5,
//红外活体检测阈值,默认:0.7
ir: 0.7
},
//是否显示人脸上方识别状态提示,默认:true
showFaceResultNotice: true,
//人脸识别尺寸,超过该尺寸才识别,否则不识别,可根据识别成功后返回的人脸尺寸进行调整,默认:0,不做人脸尺寸识别
faceSize: 300,
//是否返回失败的人脸图片的base64数据,默认:false
isCompareImageBase64: true
}
}js
//组件初始化配置
const config = ref({
//相机属性,所有的参数都可以不传,不传则按默认的
camera: {
// 相机预览旋转角度
rotation: 270,
//相机模式,1.前置,0.后置(默认)
facing: 0,
// 摄像机预览圆角,默认:0
radius: 50,
//预览分辨率,默认:[1280,720]
size: [1280, 720],
//是否锁定屏幕启动方向,默认:true
screenLocked: true,
//是否回调预览数据,默认:false
isPreviewFrame: false,
//预览数据回调时间,单位:毫秒,为0不做限制,有数据就回调
previewTime: 0
},
// 视频检测配置,所有参数都可以不传,不传则按默认的
video: {
// 视频检测角度,可接收参数,0,90,180,270,360(默认)
orient: 360,
// 人脸框是否处于X反向状态,如果未设置该参数人脸框和人脸处于反向请将该参数设置为true
isContraryX: false,
// 人脸框是否处于Y反向状态,如果未设置该参数人脸框和人脸处于反向请将该参数设置为true
isContraryY: false,
// 识别阈值(默认:0.8)
similar: 0.9,
// 是否进行活体检测(默认为true)
liveness: true,
//识别是否展示面部信息(默认为true)
showFaceInfo: false,
//活体检测阈值设置
livenessParams: {
//可见光活体检测阈值,默认:0.5
rgb: 0.5,
//红外活体检测阈值,默认:0.7
ir: 0.7
},
//是否显示人脸上方识别状态提示,默认:true
showFaceResultNotice: true,
//人脸识别尺寸,超过该尺寸才识别,否则不识别,可根据识别成功后返回的人脸尺寸进行调整,默认:0,不做人脸尺寸识别
faceSize: 300,
//是否返回失败的人脸图片的base64数据,默认:false
isCompareImageBase64: true
}
})参数说明
| 参数名 | 参数类型 | 是否必填 | 默认值 | 参数描述 |
|---|---|---|---|---|
| camera | Object | 否 | 无 | 相机属性,所有的参数都可以不传,不传则按默认的 |
| camera.rotation | Integer | 否 | 无 | 相机旋转角度 |
| camera.facing | Integer | 否 | 0 | 相机模式,1.前置,0.后置 |
| camera.radius | Integer | 否 | 0 | 摄像机预览圆角 |
| camera.size | Integer[] | 否 | [1280, 720] | 预览分辨率 |
| camera.screenLocked | Boolean | 否 | true | 是否锁定屏幕启动方向 |
| camera.isPreviewFrame 1.1.0 | Boolean | 否 | false | 是否回调预览数据 |
| camera.previewTime 1.1.0 | Boolean | 否 | 0 | 预览数据回调时间,单位:毫秒,为0不做限制,有数据就回调 |
| camera.isHorizontalMirror 1.1.2 | Boolean | 否 | false | 是否水平镜像 |
| camera.irIsHorizontalMirror 1.1.4 | Boolean | 否 | false | 红外是否水平镜像 |
| camera.isShowIrPreview 1.1.5 | Boolean | 否 | true | 是否显示红外视图 |
| video | Object | 否 | 无 | 频检测配置,所有参数都可以不传,不传则按默认的 |
| video.orient | Integer | 否 | 360 | 视频检测角度,可接收参数,0,90,180,270,360 |
| video.isContraryX | Boolean | 否 | false | 人脸框是否处于X反向状态,如果未设置该参数人脸框和人脸处于反向请将该参数设置为true |
| video.isContraryY | Boolean | 否 | false | 脸框是否处于Y反向状态,如果未设置该参数人脸框和人脸处于反向请将该参数设置为true |
| video.similar | float | 否 | 0.8 | 识别阈值 |
| Boolean | 否 | true | 是否进行活体检测,已废弃,请参考livenessType配置 | |
| video.showFaceInfo | Boolean | 否 | true | 识别是否展示面部信息 |
| video.livenessParams | Object | 否 | 无 | 活体检测阈值设置 |
| video.livenessParams.rgb | float | 否 | 0.5 | 可见光活体检测阈值 |
| video.livenessParams.ir | float | 否 | 0.5 | 红外活体检测阈值 |
| video.showFaceResultNotice | Boolean | 否 | true | 是否显示人脸上方识别状态提示 |
| video.faceSize | Integer | 否 | 0 | 人脸识别尺寸,超过该尺寸才识别,否则不识别,可根据识别成功后返回的人脸尺寸进行调整,默认:0,不做人脸尺寸识别 |
| video.isKeepMaxFace 1.1.3 | Boolean | 否 | true | 是否单人脸识别,如果是多人脸识别将参数设置为false,同时设置maxDetectFaces参数 |
| video.maxDetectFaces 1.1.3 | Integer | 否 | 1 | 最大识别的人脸数量 |
| video.drawFaceBorder 1.1.3 | Boolean | 否 | true | 是否绘制人脸识别框 |
| video.compareImage 1.1.3 | Boolean | 否 | true | 识别成功后是否返回当前识别的图片Base64数据 |
| video.failImage 1.1.3 | Boolean | 否 | false | 识别失败是否返回当前识别的图片 |
| video.isOutRecognize 1.1.3 | Boolean | 否 | true | 人脸识别结束后是否需要移出识别区域才能再次识别 |
| video.continueTime 1.1.3 | Integer | 否 | 3 | 识别结束后再次识别时间间隔,单位:秒 |
| video.livenessType 1.1.4 | String | 否 | rgb | 活体类型,可选值rgb:可见光活体ir:双目活体disable:不启用活体 |
