@yidun/livedetect-sdk-h5 2.3.3 → 2.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -21,7 +21,7 @@ pc 浏览器需内置 chromium 内核且保证版本符合如下要求：
|
|
|
21
21
|
|
|
22
22
|
| 浏览器 | 最低版本 |
|
|
23
23
|
| ---------------------- | -------- |
|
|
24
|
-
| Safari in iOS | 14.3
|
|
24
|
+
| Safari in iOS | 14.3 |
|
|
25
25
|
| Android Browser | 99 |
|
|
26
26
|
| Opera Mobile | 64 |
|
|
27
27
|
| Chrome for Android | 99 |
|
|
@@ -30,7 +30,7 @@ pc 浏览器需内置 chromium 内核且保证版本符合如下要求：
|
|
|
30
30
|
| Samsung Internet | 6.2 |
|
|
31
31
|
| QQ Browser | 10.4 |
|
|
32
32
|
| Opera Mini | 不支持 |
|
|
33
|
-
|
|
33
|
+
|
|
34
34
|
浏览器不支持时，会自动降级方式到视频活体，若不需要自动降级，可设置 `fallback` 为 `false`。
|
|
35
35
|
|
|
36
36
|
## 快速上手
|
|
@@ -134,18 +134,51 @@ import '@yidun/livedetect-sdk-h5/dist/es/NELiveDetection.css';
|
|
|
134
134
|
|
|
135
135
|
在初始化实例时，可以传入以下配置：
|
|
136
136
|
|
|
137
|
-
| 参数
|
|
138
|
-
|
|
|
139
|
-
| businessKey
|
|
140
|
-
| container
|
|
141
|
-
| diameter
|
|
142
|
-
| audio
|
|
143
|
-
| footerTip
|
|
144
|
-
| lang
|
|
145
|
-
| fallback
|
|
146
|
-
| preload
|
|
147
|
-
|
|
|
148
|
-
|
|
|
137
|
+
| 参数 | 类型 | 默认值 | 描述 | 版本 | 是否必填 |
|
|
138
|
+
| ----------------- | --------------------- | ------- | ------------------------------------------------ | ------- | -------- |
|
|
139
|
+
| businessKey | String | - | 从易盾申请的 `bussinessKey` | | 是 |
|
|
140
|
+
| container | String \| HTMLElement | - | SDK 挂载的容器 | | 是 |
|
|
141
|
+
| diameter | Number | `220` | 图像显示区域大小，单位为 `px` | | 否 |
|
|
142
|
+
| audio | Boolean | `false` | 摄像头唤起时是否开启声音录制 | | 否 |
|
|
143
|
+
| footerTip | Boolean | `true` | 是否显示底部图像和文字提示 | | 否 |
|
|
144
|
+
| lang | String | `zh-CN` | 语言，支持列表见下方语言支持列表 | | 否 |
|
|
145
|
+
| fallback | Boolean | `true` | 是否降级到视频录制上传 | `2.1.0` | 否 |
|
|
146
|
+
| preload | Boolean | `false` | 初始化是否开启预加载，开启后模型会提前加载和解析 | `2.3.0` | 否 |
|
|
147
|
+
| isSupport | `(ua: UA) => boolean` | - | 自定义浏览器兼容性判断函数，详见下方说明 | `2.3.3` | 否 |
|
|
148
|
+
| useBuiltinSupport | Boolean | `true` | 是否使用内置浏览器兼容性检测，详见下方说明 | `2.4.0` | 否 |
|
|
149
|
+
| thresholdOptions | ThresholdOptions | - | 阈值相关配置，详见下方说明 | `2.4.2` | 否 |
|
|
150
|
+
| onMount | Function | - | 初始化实例挂载完成回调 | | 否 |
|
|
151
|
+
| onReady | Function | - | 活体检测前的准备工作已完成回调 | | 否 |
|
|
152
|
+
|
|
153
|
+
### 浏览器兼容性配置
|
|
154
|
+
|
|
155
|
+
`useBuiltinSupport` 和 `isSupport` 用于控制浏览器兼容性检测逻辑：
|
|
156
|
+
|
|
157
|
+
- 当 `useBuiltinSupport` 为 `true`（默认）时，SDK 会使用内置的兼容性检测逻辑判断当前浏览器是否支持活体检测；设为 `false` 可跳过内置检测。
|
|
158
|
+
- `isSupport` 允许传入一个自定义函数，接收 `ua` 参数（包含 `os` 和 `browser` 信息），返回 `boolean` 来额外判断浏览器是否支持。当内置检测通过后，会继续调用此函数进行判断；返回 `false` 将触发降级或报错。
|
|
159
|
+
|
|
160
|
+
```js
|
|
161
|
+
const neLiveDetection = new NELiveDetection({
|
|
162
|
+
businessKey: 'your-business-key',
|
|
163
|
+
container: '#NELiveDetection',
|
|
164
|
+
useBuiltinSupport: true,
|
|
165
|
+
isSupport: (ua) => {
|
|
166
|
+
// ua.os: { name: string, version: string }
|
|
167
|
+
// ua.browser: { name: string, version: string }
|
|
168
|
+
// 返回 false 将判定为不支持
|
|
169
|
+
return true;
|
|
170
|
+
},
|
|
171
|
+
});
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### ThresholdOptions 阈值配置
|
|
175
|
+
|
|
176
|
+
| 参数 | 类型 | 默认值 | 描述 |
|
|
177
|
+
| ------------- | ------ | ------ | -------------------------------------- |
|
|
178
|
+
| minBrightness | Number | `0.1` | 光线最低阈值，低于此值提示环境太暗 |
|
|
179
|
+
| maxBrightness | Number | `0.8` | 光线最高阈值，高于此值提示环境太亮 |
|
|
180
|
+
| minFaceRatio | Number | `0.2` | 人脸面积最小比例，低于此值提示距离太远 |
|
|
181
|
+
| maxFaceRatio | Number | `0.8` | 人脸面积最大比例，高于此值提示距离太近 |
|
|
149
182
|
|
|
150
183
|
<md-attention>
|
|
151
184
|
|
|
@@ -244,21 +277,21 @@ instance.on('error', (err) => {
|
|
|
244
277
|
|
|
245
278
|
## 错误码
|
|
246
279
|
|
|
247
|
-
| 错误码 | 错误信息
|
|
248
|
-
| ------ |
|
|
249
|
-
| 10000 | 校验不通过
|
|
250
|
-
| 10001 | 校验接口网络错误
|
|
251
|
-
| 11000 | 获取相机权限失败
|
|
252
|
-
| 11001 | 鉴权不通过
|
|
280
|
+
| 错误码 | 错误信息 |
|
|
281
|
+
| ------ | ---------------------------------------------------------------------------------- |
|
|
282
|
+
| 10000 | 校验不通过 |
|
|
283
|
+
| 10001 | 校验接口网络错误 |
|
|
284
|
+
| 11000 | 获取相机权限失败 |
|
|
285
|
+
| 11001 | 鉴权不通过 |
|
|
253
286
|
| 11002 | 浏览器不支持，默认降级到视频活体，如不需要，可以将初始化参数 fallback 设置为 false |
|
|
254
|
-
| 11003 | 用户拒绝相机权限授权
|
|
255
|
-
| 11004 | 找不到摄像头
|
|
256
|
-
| 11005 | 异常硬件导致无法读取摄像头
|
|
257
|
-
| 11006 | 摄像头分辨率过低
|
|
258
|
-
| 11007 | 未知问题导致摄像头无法被使用
|
|
259
|
-
| 11008 | 炫瞳检测失败
|
|
260
|
-
| 12000 | 获取配置接口网络错误
|
|
261
|
-
| 12001 | 获取配置失败，请检查接入配置是否正确
|
|
287
|
+
| 11003 | 用户拒绝相机权限授权 |
|
|
288
|
+
| 11004 | 找不到摄像头 |
|
|
289
|
+
| 11005 | 异常硬件导致无法读取摄像头 |
|
|
290
|
+
| 11006 | 摄像头分辨率过低 |
|
|
291
|
+
| 11007 | 未知问题导致摄像头无法被使用 |
|
|
292
|
+
| 11008 | 炫瞳检测失败 |
|
|
293
|
+
| 12000 | 获取配置接口网络错误 |
|
|
294
|
+
| 12001 | 获取配置失败，请检查接入配置是否正确 |
|
|
262
295
|
|
|
263
296
|
## 常⻅问题
|
|
264
297
|
|