Merge branch 'main' into preview

a362758199 · web-flow · commit 1b211f75c01e · 2024-06-21T15:29:44.000+08:00
diff --git a/programming/javascript/faq/add-remove-beep-sound.md b/programming/javascript/faq/add-remove-beep-sound.md
@@ -10,6 +10,18 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## Version 10
+This feature is controlled by the `Dynamsoft Camera Enhancer` module. 
+
+```javascript
+Dynamsoft.DCE.Feedback.beep();
+```
+**_NOTE:_** - Check the class [Feedback](https://www.dynamsoft.com/camera-enhancer/docs/web/programming/javascript/api-reference/feedback.html#beep) for more details.
+
+
+<details>
+<summary><b> Version 9</b></summary>
 This feature is controlled using the [whenToPlaySoundforSuccessfulRead](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interface/ScanSettings.html?ver=latest) property. To enable the feature, set the property to either **frame** or **unique**. To disable the feature, set it to **never**.
 
 > This feature is disabled by default.
+</details>
diff --git a/programming/javascript/faq/assets/domain_binding.jpg b/programming/javascript/faq/assets/domain_binding.jpg
diff --git a/programming/javascript/faq/avoid-incorrect-barcode-results.md b/programming/javascript/faq/avoid-incorrect-barcode-results.md
@@ -10,5 +10,18 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## Version 10
+- One method is to raise the value of [minResultConfidence](../api-reference/interfaces/simplified-barcode-reader-settings.md) of the `SimplifiedCaptureVisionSettings` interface of the capture vision router module.  It is set to `30` by default.
+
+- If the issue has to do with the length of the text result, you can try setting a minimum length for the barcode text(s) that are returned by the SDK. By setting the [minBarcodeTextLength](../api-reference/interfaces/simplified-barcode-reader-settings.md) property of the `SimplifiedCaptureVisionSettings` interface of the capture vision router module, the SDK can ignore results that are consistently coming out shorter than expected. It is set to `0` by default.
+
+```javascript
+  let settings = await router.getSimplifiedSettings('ReadSingleBarcode');
+  settings.barcodeSettings.minResultConfidence = 40; //setting confidence
+  settings.barcodeSettings.minBarcodeTextLength = 5; //setting barcodeTextLength
+  await router.updateSettings('ReadSingleBarcode', settings);
+```
+
+## Version 9
 - One method is to raise the value of [minResultConfidence](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interface/RuntimeSettings.html#minresultconfidence) of the `RuntimeSettings` to a value of 50 or higher. It is set to 30 by default.
 - If the issue has to do with the length of the text result, you can try setting a minimum length for the barcode text(s) that are returned by the SDK. By setting the [minBarcodeTextLength](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interface/RuntimeSettings.html#minbarcodetextlength) property of the `RuntimeSettings`, the SDK can ignore results that are consistently coming out shorter than expected.
diff --git a/programming/javascript/faq/call-loadWasm-proactively.md b/programming/javascript/faq/call-loadWasm-proactively.md
@@ -10,4 +10,15 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## Version 10
+Preload `BarcodeReader` or other specified module proactively to save time on the initial decoding by skipping the module loading at the time of instance creation.
+
+```javascript
+await Dynamsoft.Core.CoreModule.loadWasm(["cvr", "dbr"]);
+if(Dynamsoft.Core.CoreModule.isModuleLoaded("cvr")){
+    console.log("cvr module is loaded!").
+}
+```
+
+## Version 9
 No, the method is internally called when `createInstance` is called so there is no need to explicitly call it. However, if you would like to save some time during the instance creation, you can choose to manually call the method as soon as the page is loaded rather than letting it load on the instance creation. This can help avoid unnecessary waiting time when the library is invoked.
diff --git a/programming/javascript/faq/change-domain-binding-of-product-key.md b/programming/javascript/faq/change-domain-binding-of-product-key.md
@@ -11,8 +11,8 @@ needAutoGenerateSidebar: false
 [<< Back to FAQ index](index.md)
 
 In order to change the domain binding of the handshake code that includes the license item in question please follow the below steps -
-  1. You will first need to log into the [customer portal](https://www.dynamsoft.com/customer/index).
-  2. After login, please navigate go to [projects link](https://www.dynamsoft.com/lts/index.html#/handshakeCodes)
+  1. You will first need to log into the [portal](https://www.dynamsoft.com/lts/index.html#/handshakeCodes).
+  2. Once logged in, navigate to the "Projects" section in the left-hand tree menu.
   3. Find the project that you want to change the domain binding.
   4. Click on the "Configure" button.
   5. Scroll down and find "Optional Settings" -> edit "Bind Website Domain" field to change your domain binding.
diff --git a/programming/javascript/faq/check-camera.md b/programming/javascript/faq/check-camera.md
@@ -10,9 +10,15 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
-Starting from version 9.6.10+, you can utilize the [testCameraAccess](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/BarcodeScanner.html#testcameraaccess) method to check the camera status programmatically.
+## version 10 or recent
+In version 10, use the `dynamsoft camera enhancer` to utilize the [testCameraAccess](https://www.dynamsoft.com/camera-enhancer/docs/web/programming/javascript/api-reference/camera-control.html#testCameraAccess) method to check the camera status programmatically.
 
-For versions older than 9.6.10, you can check the status using a try-catch block as shown below:
+
+## version 9.6.10 till version 10
+ you can utilize the [testCameraAccess](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/BarcodeScanner.html#testcameraaccess) method to check the camera status programmatically.
+
+## version older than 9.6.10
+ you can check the status using a try-catch block as shown below:
 
 ```javascript
 try {
diff --git a/programming/javascript/faq/check-current-version.md b/programming/javascript/faq/check-current-version.md
@@ -10,6 +10,19 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## For version 10
+- Check the version of Barcode Reader module
+```javascript
+Dynamsoft.DBR.BarcodeReaderModule.getVersion()
+```
+- If you are using the library via npm or yarn, then you can check the version of the package via
+```bash
+npm show dynamsoft-barcode-reader version
+```
+- If you are including the library via the CDN link, then the version number should be mentioned in that reference link.
+
+
+## For version 9
 There are multiple ways to check the version currently being used -
 
 - The first way is to use the [version API](https://www.dynamsoft.com/barcode-reader/programming/javascript/api-reference/InitializationControl.html?ver=latest#version). Using this API in the browser console should print out the version of the library being used by the web app.
diff --git a/programming/javascript/faq/delay-when-open-camera.md b/programming/javascript/faq/delay-when-open-camera.md
@@ -10,14 +10,37 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## Version 10
+### 1. Invoke loadWasm
+Preload `BarcodeReader` or other specified module proactively to save time on the initial decoding by skipping the module loading at the time of instance creation.
 
-## 1. Invoke loadWasm in advance
+```javascript
+await Dynamsoft.Core.CoreModule.loadWasm(["DBR"]);
+```
+### 2. skip camera inspection
+You can bypass the camera selection[ifSkipCameraInspection](https://www.dynamsoft.com/camera-enhancer/docs/web/programming/javascript/api-reference/camera-control.html#ifskipcamerainspection)
+```javascript
+	cameraEnhancer.ifSkipCameraInspection
+```
+
+### 3. Pre-open camera in advance
+Run the following code before calling `createInstance`.
+```
+navigator.mediaDevices.getUserMedia({video: true}).then(mediaStream=>{
+  mediaStream.getTracks().forEach((track) => {
+    track.stop();
+  });
+}, err=>{});
+```
+
+## Version 9
+### 1. Invoke loadWasm in advance
 
 ```javascript
 Dynamsoft.DBR.BarcodeReader.loadWasm();
 ```
 
-## 2. Pre-open the camera in advance
+### 2. Pre-open the camera in advance
 
 Run the following code before calling `createInstance`.
 ```
@@ -28,7 +51,7 @@ navigator.mediaDevices.getUserMedia({video: true}).then(mediaStream=>{
 }, err=>{});
 ```
 
-## 3. Skip Camera inspection(use default camera)
+### 3. Skip Camera inspection(use default camera)
 
 ```javascript
 scanner.ifSkipCameraInspection = true;
diff --git a/programming/javascript/faq/difference-between-barcodeReader-and-barcodeScanner.md b/programming/javascript/faq/difference-between-barcodeReader-and-barcodeScanner.md
@@ -9,7 +9,7 @@ needAutoGenerateSidebar: false
 # What is the difference between the BarcodeReader class and the BarcodeScanner class? Can they be used interchangeably?
 
 [<< Back to FAQ index](index.md)
-
+**_NOTE:_** - This  is for version 9 or lower of barcode reader sdk
 No, as each offers a different functionality than the other. The `BarcodeReader` class is used to decode static images (via one of the [decode\*](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/BarcodeReader.html#decode-barcodes) methods) and does not have the ability to open the camera stream and decode barcodes directly from the video stream. 
 
 The `BarcodeScanner` class on the other hand has the ability to decode barcodes directly from a video input, but it can also capture a still image using the camera when `singleFrameMode` is toggled.
diff --git a/programming/javascript/faq/different-ways-to-customize-ui.md b/programming/javascript/faq/different-ways-to-customize-ui.md
@@ -10,6 +10,11 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## Version 10 and above
+The UI is part of the `Dynamsoft Camera Enhancer` module, read more on how to
+[customize the UI](https://www.dynamsoft.com/camera-enhancer/docs/web/programming/javascript/user-guide/index.html#customize-the-ui)
+
+## Version 9
 There are three different ways to customize the UI -
 
 - The first is to modify the file `dist/dbr.ui.html` directly. However, this means that the resource files should be hosted on your own server, rather than using the CDN.
diff --git a/programming/javascript/faq/formats-supported-for-existing-files.md b/programming/javascript/faq/formats-supported-for-existing-files.md
@@ -10,5 +10,9 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## Version 10 and above
+The supported formats include .jpg,.jpeg,.icon,.gif,.svg,.webp,.png,.bmp.
+
+## Version 9
 - The supported image formats include png, jpeg, bmp, gif and a few others (some browsers support webp, tif).
 - PDF files are currently not supported.
diff --git a/programming/javascript/faq/get-intermediate-result-images.md b/programming/javascript/faq/get-intermediate-result-images.md
@@ -10,6 +10,11 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## Version 10
+The intermeddiate results can be retrieved using the [IntermediateResultManager]({{ site.dcv_js_api }}capture-vision-router/intermediate-result-manager.html)
+
+
+## Version 9
 The intermediate result images can be retrieved using the `getIntermediateCanvas` method, as explained in the [Advanced Usage guide](https://www.dynamsoft.com/barcode-reader/programming/javascript/user-guide/advanced-usage.html?ver=latest#display-images-in-different-stages-of-the-reading-process).
 
 Should you need any more help with intermediate results, do not hesitate to [contact us](https://www.dynamsoft.com/contact/).
diff --git a/programming/javascript/faq/get-sdk-logs.md b/programming/javascript/faq/get-sdk-logs.md
@@ -10,6 +10,13 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## Version 10
+The SDK can provide logs via the `Core` module.
+```javascript
+Dynamsoft.Core.CoreModule.onLog = console.log;
+```
+
+## Version 9
 The SDK can provide logs via the browser console. Logging can be activated by the `_onLog` property.
 
 ```javascript
diff --git a/programming/javascript/faq/hide-laser-message-ui.md b/programming/javascript/faq/hide-laser-message-ui.md
@@ -8,6 +8,17 @@ needAutoGenerateSidebar: false
 
 # How can I hide the laser bar and Dynamsoft message in the default UI of the BarcodeScanner?
 
+## Version 10
+To change the UI, you will need to use the CamerView from the `Camera Enhancer Module`
+for laser there is a direct api which you can reference, for other changes you need to either access via class or [customize your own ui](https://www.dynamsoft.com/camera-enhancer/docs/web/programming/javascript/user-guide/index.html#customize-the-ui).
+
+```javascript
+cameraView.setScanLaserVisible(false); //sets laser off, needs to be called after StartCapturing
+//needs to either target the shadowRoot element like this or implement your own UI
+document.getElementById('div-ui-container').children[0].shadowRoot.querySelector('.dce-msg-poweredby').style.display='none'
+```
+
+## Version 9 
 In order to show or hide these specific UI elements, all you need to do is access them individually via their class names and setting the corresponding display property.
 
 By default, these elements will be shown. In order to hide them, an edited Hello World code snippet can be found below that will get the job done. Please note that the elements must be hidden after `scanner.show()` is called since that is when the elements are created.
diff --git a/programming/javascript/faq/index.md b/programming/javascript/faq/index.md
@@ -79,4 +79,8 @@ noTitleIndex: true
 
 35. [How to check the camera permissions programmatically in Dynamsoft Barcode Reader JavaScript SDK?](check-camera.html)
 
-36. [How do I resolve the issue of the Barcode Reader not recognizing any barcodes via video in iOS 16.7 or 17?](ios-17-readability.html)
+36. [How do I resolve the issue of the Barcode Reader not recognizing any barcodes via video in iOS 16.7 or 17?](ios-17-readability.html)
+
+37. [How to Reduce Duplicate Scans and Optimize Scan Usage?](remove-duplicates.html)
+
+38. [?](.html)
diff --git a/programming/javascript/faq/read-inverted-image.md b/programming/javascript/faq/read-inverted-image.md
@@ -10,6 +10,16 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## Version 10
+this can be achieved by setting the value of the `grayscaleTransformationModes` array of `furtherModes` to use `GTM_INVERTED` 
+
+```javascript
+let settings = await router.getSimplifiedSettings("ReadSingleBarcode");
+settings.barcodeSettings.grayscaleTransformationModes[0] = Dynamsoft.Core.EnumGrayscaleTransformationMode.GTM_INVERTED;
+await router.updateSettings("ReadSingleBarcode", settings);
+
+```
+## Version 9
 Typically, normal barcode images include a dark barcode on a light background. An inverted image in this case would have a light barcode on a dark background instead. In order to read those types of barcodes, the `grayscaleTransformationModes` array of `furtherModes` must prioritize `GTM_INVERTED` like shown in the below example.
 
 ```javascript
diff --git a/programming/javascript/faq/remove-duplicates.md b/programming/javascript/faq/remove-duplicates.md
@@ -0,0 +1,65 @@
+---
+layout: default-layout
+title: How to Reduce Duplicate Scans and Optimize Scan Usage
+keywords: Dynamsoft Barcode Reader, FAQ, JavaScript, tech basic, scans, duplicate, re-reads
+description: How to Reduce Duplicate Scans and Optimize Scan Usage
+needAutoGenerateSidebar: false
+---
+
+# How to Reduce Duplicate Scans and Optimize Scan Usage?
+
+[<< Back to FAQ index](index.md)
+
+## Version 10
+If you're experiencing more scans usage than expected with the barcode reading SDK, use the below strategies to address this issue effectively:
+
+### 1. Donot count identical Result
+With version 10 and above of the DBR SDK, the `enableResultDeduplication` is set to forget a result 3 seconds after it is first received. During this time frame, if an identical result appears, it is ignored. If you want to forget the identical result for more duration you can use the setDuplicateForgetTime function as well with `enableResultDeduplication`. 
+
+```javascript
+// Filter out unchecked and duplicate results.
+const filter = new MultiFrameResultCrossFilter();
+// Filter out unchecked barcodes 
+filter.enableResultCrossVerification(
+    EnumCapturedResultItemType.CRIT_BARCODE,
+    true
+);  
+// Filter out duplicate barcodes within 3 seconds by default.
+filter.enableResultDeduplication(
+    EnumCapturedResultItemType.CRIT_BARCODE,
+    true
+); 
+// Filter out duplicate barcodes within 5 seconds.
+filter.setDuplicateForgetTime(
+    EnumCapturedResultItemType.CRIT_BARCODE,
+    5000
+);
+await router.addResultFilter(filter);
+```
+**_NOTE:_** - setSuplicateForgetTime can be set upto 10 seconds.
+
+### 2. Limit Barcode Formats: 
+If you're specifically scanning a particular barcode format, consider limiting the barcode format options to prevent other formats from being decoded and counted unnecessarily.
+
+you can limit the barcode formats in two ways:
+
+- set the barcode format using the `getSimplifiedSettings`
+```javascript
+let settings = await router.getSimplifiedSettings("ReadSingleBarcode");
+settings.barcodeSettings.barcodeFormatIds =
+  Dynamsoft.DBR.EnumBarcodeFormat.BF_ONED |
+  Dynamsoft.DBR.EnumBarcodeFormat.BF_QR_CODE ;
+await router.updateSettings("ReadSingleBarcode", settings);
+```
+
+- to set the barcode format using the template check out the [template section]({{site.dcv_js_api}}capture-vision-router/settings.html)
+
+
+Implementing these steps can help streamline your barcode scanning process, reduce unnecessary scans, and optimize resource usage effectively.
+
+
+
+
+
+
+
diff --git a/programming/javascript/faq/server-requirements-for-dbr-js-deployment.md b/programming/javascript/faq/server-requirements-for-dbr-js-deployment.md
@@ -12,17 +12,17 @@ needAutoGenerateSidebar: false
 
 To deploy DBR-JS to the server, you need to
 
- 1. Set the MIME type for `.wasm` as `application/wasm` on your webserver.
+<span>1.</span> Set the MIME type for `.wasm` as `application/wasm` on your webserver. <br/>
   
-  The goal is to configure your server to send the correct Content-Type header for the wasm file so that it is processed correctly by the browser.
+  The goal is to configure your server to send the correct Content-Type header for the wasm file so that it is processed correctly by the browser. 
 
   Different types of webservers are configured differently, for example:
 
   + <a target="_blank" href="https://developer.mozilla.org/en-US/docs/Learn/Server-side/Apache_Configuration_htaccess#media_types_and_character_encodings" title="Apache">Apache</a>
   + <a target="_blank" href="https://docs.microsoft.com/en-us/iis/configuration/system.webserver/staticcontent/mimemap" title="IIS">IIS</a>
   + <a target="_blank" href="https://www.nginx.com/resources/wiki/start/topics/examples/full/#mime-types" title="NGINX">NGINX</a>
 
- 2. Enable HTTPS
+<span>2.</span> Enable HTTPS <br/>
 
   Due to the browser <a target="_blank" href="https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts" title="security restriction">security restriction</a> on camera video streaming access, a secure HTTPS connection is required to use the library with camera.
 
diff --git a/programming/javascript/faq/stop-camera-to-open-right-away.md b/programming/javascript/faq/stop-camera-to-open-right-away.md
@@ -10,6 +10,13 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## Version 10
+```javascript
+let startScanBtn = document.getElementById("StartScanning"); // double check the ID of the button
+```
+
+## version 9
+
 Instead of creating the `BarcodeScanner` instance on page load, trigger the creation on the click of the `Start Scanning` button instead, as shown in the sample code below -
 
 ```javascript
diff --git a/programming/javascript/faq/unable-to-scan-aztec-code.md b/programming/javascript/faq/unable-to-scan-aztec-code.md
@@ -10,6 +10,8 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## For version 8 and version 9
+
 The reason for this is that the JavaScript edition defaults to the `compact engine`, rather than the `full engine`. The compact engine currently only supports `1D`, `QR`, `PDF417`, and `DataMatrix` codes.
 
 To switch to the full engine, please call the following before creating the `BarcodeReader/BarcodeScanner` instance:
diff --git a/programming/javascript/faq/ways-to-copy-dbr-js-deployable-files.md b/programming/javascript/faq/ways-to-copy-dbr-js-deployable-files.md
@@ -14,6 +14,17 @@ A copy of Dbr JS deployable files can be obtained using any of the methods menti
 
 1. Download the DBR-JS package from the [Dynamsoft website](https://www.dynamsoft.com/barcode-reader/downloads) or from the [Dynamsoft Customer Portal](https://www.dynamsoft.com/customer/download) (Download Products tab on the left hand side)
 2. Install the library via `npm`
+### version 10
+you will need to install dependencies along with the barcode reader sdk
+    dynamsoft-barcode-reader,
+    dynamsoft-camera-enhancer
+    dynamsoft-capture-vision-router,
+    dynamsoft-core,
+    dynamsoft-license,
+    dynamsoft-utility,
+
+### version 9
     * `npm install dynamsoft-javascript-barcode --save`
+    
 3. Install the library via `yarn`
     * `yarn add dynamsoft-javascript-barcode`
diff --git a/programming/javascript/faq/when-singleFrameMode-is-enabled.md b/programming/javascript/faq/when-singleFrameMode-is-enabled.md
@@ -10,6 +10,11 @@ needAutoGenerateSidebar: false
 
 [<< Back to FAQ index](index.md)
 
+## Verson 10
+SingleFrameMode can be enabled by calling the api from the camera enhancer module. check
+[singleFrameMode](https://www.dynamsoft.com/camera-enhancer/docs/web/programming/javascript/api-reference/acquisition.html#singleframemode) for detailed information.
+
+## Version 9 
 `singleFrameMode` is enable in the below two scenarios -
 
 1. When using the library from a non-secure origin (no HTTPS).
diff --git a/programming/javascript/upgrade-guide/9to10.md b/programming/javascript/upgrade-guide/9to10.md
diff --git a/programming/javascript/user-guide/index.md b/programming/javascript/user-guide/index.md
