You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-10Lines changed: 22 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Acuant JavaScript Web SDK v11.6.4
1
+
# Acuant JavaScript Web SDK v11.7.0
2
2
3
-
**May 2022**
3
+
**July 2022**
4
4
5
5
See [https://github.com/Acuant/JavascriptWebSDKV11/releases](https://github.com/Acuant/JavascriptWebSDKV11/releases) for release notes.
6
6
@@ -232,7 +232,7 @@ For other browsers that do not support WebRTC, the device's camera app (manual c
232
232
**Prerequisite**: Initialize the SDK (see [Initialize and Start the SDK](#initialize-and-start-the-sdk))
233
233
234
234
- This code is used for live capture; live detection, frame analysis, and auto capture of documents. After capture, it also processes the image.
235
-
- AcuantCameraUI is the default implementation of the UI and uses AcuantCamera to access the device’s native camera via WebRTC.
235
+
- AcuantCameraUI is the default implementation of the UI and uses AcuantCamera to access the device’s native camera via WebRTC.
236
236
237
237
### Start Live Capture
238
238
@@ -250,6 +250,7 @@ For other browsers that do not support WebRTC, the device's camera app (manual c
250
250
text:{
251
251
NONE: "ALIGN",
252
252
SMALL_DOCUMENT: "MOVE CLOSER",
253
+
BIG_DOCUMENT: "TOO CLOSE",
253
254
GOOD_DOCUMENT: null,//if let null will show a countdown
254
255
CAPTURING: "CAPTURING",
255
256
TAP_TO_CAPTURE: "TAP TO CAPTURE"
@@ -284,7 +285,8 @@ For other browsers that do not support WebRTC, the device's camera app (manual c
284
285
state: Number => {
285
286
NO_DOCUMENT: 0,
286
287
SMALL_DOCUMENT: 1,
287
-
GOOD_DOCUMENT: 2
288
+
BIG_DOCUMENT: 2,
289
+
GOOD_DOCUMENT: 3
288
290
}
289
291
}
290
292
}
@@ -389,7 +391,8 @@ The general flow of a custom camera ui is as follows:
389
391
const DOCUMENT_STATE = {
390
392
NO_DOCUMENT: 0,
391
393
SMALL_DOCUMENT: 1,
392
-
GOOD_DOCUMENT: 2
394
+
BIG_DOCUMENT: 2,
395
+
GOOD_DOCUMENT: 3
393
396
};
394
397
395
398
const ACUANT_DOCUMENT_TYPE = {
@@ -491,7 +494,11 @@ The following may significantly increase errors or false results:
491
494
492
495
### Start face capture and send Passive Liveness request
493
496
494
-
**Important:** Do not use this module for face capture if you are not using the Acuant FaceID API.
497
+
**Important:** Do not use this module for face capture if you are not using the Acuant FaceID API. You can do either of the following:
498
+
499
+
- Include the subscription, with face enabled, in the call to get a result.
500
+
501
+
- Exclude the subscription to get only the captured image and process that image through an alternate orchestration layer.
495
502
496
503
1. Add an HTML element to show face capture preview:
497
504
@@ -518,6 +525,11 @@ The following may significantly increase errors or false results:
518
525
519
526
```
520
527
var faceCaptureCallback = {
528
+
onDetectorInitialized: () => {
529
+
//This callback is triggered when the face detector is ready.
530
+
//Until then, no actions are executed and the user sees only the camera stream.
531
+
//You can opt to display an alert before the callback is triggered.
532
+
},
521
533
onDetection: (text) => {
522
534
//Triggered when the face does not pass the scan. The UI element
523
535
//should be updated here to provide guidence to the user
@@ -656,7 +668,7 @@ Web Workers/WASM and CDNs can be used together with workarounds. The following c
656
668
#$1=file directory
657
669
#$2=absolute url up to file location on CDN including trailing slash (ie https://company.example/files/ but not https://company.example/files/file.wasm or https://company.example/files)
- If the script doesn't provide the desired outcome, or if you prefer to manually edit the files, you will need to change the following fields to their absolute equivalent in the following files.
662
674
@@ -687,7 +699,7 @@ Starting and stopping Workers is a very slow operation, so you will see performa
687
699
688
700
1. iOS 15 has multiple issues that manifest themselves as GPU Highwater failures (ie system daemon used too much memory).
689
701
690
-
We have done what we can to delay/prevent the occurrence of the issues and will continue monitoring/investigating further improvements. However, at this moment we believe the root cause to be on Apple's/Safari's side. The issue is more prevalent on older iOS 15 devices and is less likely to occur on newer devices. Currently, the issue should be detected successfully by the camera and reported to the implementer as a code: AcuantJavascriptWebSdk.SEQUENCE\_BREAK\_CODE. The GPU failure will render the live capture unusable, forcing users to go to Manual Capture as an alternative.
702
+
The reduced resolution of the camera in the latest version of the SDK has mitigated the issue. Unfortunately, because this is an iOS issue, we can’t provide a better solution other than reducing the capture resolution. This issue will be revisited in the next major iOS release to determine which changes have been made in that version.
691
703
692
704
1. The camera preview has a low/throttled frame rate (as low as 10-15fps).
693
705
@@ -709,7 +721,7 @@ Starting and stopping Workers is a very slow operation, so you will see performa
709
721
710
722
You can ignore these warnings. If you want to prevent the warnings, set the file type for the .wasm files to application/wasm in your server/cdn configuration.
711
723
712
-
1. When using Passive Liveness camera on Google Chrome for Android, the camera defaults to the back-facing instead of the front-facing camera.
724
+
1. When using Manual Passive Liveness camera on Google Chrome for Android, the camera defaults to the back-facing instead of the front-facing camera.
713
725
714
726
Users can tap to switch to the front-facing camera. This is a Chrome issue and unfortunately, we cannot provide a workaround at this time.
715
727
@@ -771,7 +783,7 @@ Starting and stopping Workers is a very slow operation, so you will see performa
771
783
772
784
----------
773
785
774
-
**Copyright 2021 Acuant Inc. All rights reserved.**
786
+
**Copyright 2022 Acuant Inc. All rights reserved.**
775
787
776
788
This document contains proprietary and confidential information and creative works owned by Acuant and its respective licensors, if any. Any use, copying, publication, distribution, display, modification, or transmission of such technology, in whole or in part, in any form or by any means, without the prior express written permission of Acuant is strictly prohibited. Except where expressly provided by Acuant in writing, possession of this information shall not be construed to confer any license or rights under any Acuant intellectual property rights, whether by estoppel, implication, or otherwise.
0 commit comments