npm - dynamsoft-barcode-reader-bundle - Versions diffs - 11.4.2001-beta-202604231927 → 11.4.2001 - Mend

dynamsoft-barcode-reader-bundle 11.4.2001-beta-202604231927 → 11.4.2001

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.

Files changed (8) hide show

package/README.html CHANGED Viewed

@@ -229,41 +229,42 @@
 ![downloads](https://img.shields.io/npm/dm/dynamsoft-javascript-barcode.svg)
 ![jsdelivr](https://img.shields.io/jsdelivr/npm/hm/dynamsoft-javascript-barcode.svg) -->
 <p>In this guide, you will learn step by step on how to integrate the DBR-JS SDK into your website.</p>
-<!-- <span style="font-size:20px">Table of Contents</span>
-- [Barcode Reader for Your Website - Foundational API Guide](#barcode-reader-for-your-website---foundational-api-guide)
-  - [Hello World - Simplest Implementation](#hello-world---simplest-implementation)
-    - [Understand the code](#understand-the-code)
-      - [About the code](#about-the-code)
-    - [Run the example](#run-the-example)
-  - [Preparing the SDK](#preparing-the-sdk)
-    - [Step 1: Include the SDK](#step-1-include-the-sdk)
-    - [Step 2: Prepare the SDK](#step-2-prepare-the-sdk)
-      - [1. Specify the license](#1-specify-the-license)
-      - [2. \[Optional\] Specify the location of the "engine" files](#2-optional-specify-the-location-of-the-engine-files)
-  - [Using the SDK](#using-the-sdk)
-    - [Step 1: Preload the module](#step-1-preload-the-module)
-    - [Step 2: Create a CaptureVisionRouter object](#step-2-create-a-capturevisionrouter-object)
-    - [Step 3: Connect an image source](#step-3-connect-an-image-source)
-    - [Step 4: Register a result receiver](#step-4-register-a-result-receiver)
-    - [Step 5: Start process video frames](#step-5-start-process-video-frames)
-  - [Customizing the process](#customizing-the-process)
-    - [1. Adjust the preset template settings](#1-adjust-the-preset-template-settings)
-      - [1.1. Change barcode settings](#11-change-barcode-settings)
-      - [1.2. Retrieve the original image](#12-retrieve-the-original-image)
-      - [1.3. Change reading frequency to save power](#13-change-reading-frequency-to-save-power)
-      - [1.4. Specify a scan region](#14-specify-a-scan-region)
-    - [2. Edit the preset templates directly](#2-edit-the-preset-templates-directly)
-    - [3. \[Important\] Filter the results](#3-important-filter-the-results)
-      - [Method 1: Verify results across multiple frames](#method-1-verify-results-across-multiple-frames)
-      - [Method 2: Eliminate redundant results detected within a short time frame](#method-2-eliminate-redundant-results-detected-within-a-short-time-frame)
-    - [4. Add feedback](#4-add-feedback)
-  - [Customizing the UI](#customizing-the-ui)
-  - [Documentation](#documentation)
-    - [API Reference](#api-reference)
-    - [How to Upgrade](#how-to-upgrade)
-    - [Release Notes](#release-notes)
-  - [Next Steps](#next-steps) -->
+<p><span style="font-size:20px">Table of Contents</span></p>
+<ul>
+<li><a href="#barcode-reader-for-your-website---foundational-api-guide">Barcode Reader for Your Website - Foundational API Guide</a></li>
+<li><a href="#hello-world---simplest-implementation">Hello World - Simplest Implementation</a><ul>
+<li><a href="#understand-the-code">Understand the code</a></li>
+<li><a href="#about-the-code">About the code</a></li>
+<li><a href="#run-the-example">Run the example</a></li></ul></li>
+<li><a href="#preparing-the-sdk">Preparing the SDK</a><ul>
+<li><a href="#step-1-include-the-sdk">Step 1: Include the SDK</a></li>
+<li><a href="#step-2-prepare-the-sdk">Step 2: Prepare the SDK</a></li>
+<li><a href="#1-specify-the-license">1. Specify the license</a></li>
+<li><a href="#2-optional-specify-the-location-of-the-engine-files">2. [Optional] Specify the location of the "engine" files</a></li></ul></li>
+<li><a href="#using-the-sdk">Using the SDK</a><ul>
+<li><a href="#step-1-preload-the-module">Step 1: Preload the module</a></li>
+<li><a href="#step-2-create-a-capturevisionrouter-object">Step 2: Create a CaptureVisionRouter object</a></li>
+<li><a href="#step-3-connect-an-image-source">Step 3: Connect an image source</a></li>
+<li><a href="#step-4-register-a-result-receiver">Step 4: Register a result receiver</a></li>
+<li><a href="#step-5-start-process-video-frames">Step 5: Start process video frames</a></li></ul></li>
+<li><a href="#customizing-the-process">Customizing the process</a><ul>
+<li><a href="#1-adjust-the-preset-template-settings">1. Adjust the preset template settings</a></li>
+<li><a href="#11-change-barcode-settings">1.1. Change barcode settings</a></li>
+<li><a href="#12-retrieve-the-original-image">1.2. Retrieve the original image</a></li>
+<li><a href="#13-change-reading-frequency-to-save-power">1.3. Change reading frequency to save power</a></li>
+<li><a href="#14-specify-a-scan-region">1.4. Specify a scan region</a></li>
+<li><a href="#2-edit-the-preset-templates-directly">2. Edit the preset templates directly</a></li>
+<li><a href="#3-important-filter-the-results">3. [Important] Filter the results</a></li>
+<li><a href="#method-1-verify-results-across-multiple-frames">Method 1: Verify results across multiple frames</a></li>
+<li><a href="#method-2-eliminate-redundant-results-detected-within-a-short-time-frame">Method 2: Eliminate redundant results detected within a short time frame</a></li>
+<li><a href="#4-add-feedback">4. Add feedback</a></li></ul></li>
+<li><a href="#customizing-the-ui">Customizing the UI</a></li>
+<li><a href="#documentation">Documentation</a><ul>
+<li><a href="#api-reference">API Reference</a></li>
+<li><a href="#how-to-upgrade">How to Upgrade</a></li>
+<li><a href="#release-notes">Release Notes</a></li></ul></li>
+<li><a href="#next-steps">Next Steps</a></li>
+</ul>
 <h2 id="hello-world---simplest-implementation">Hello World - Simplest Implementation</h2>
 <p>Let's start with the "Hello World" example of the DBR-JS SDK which demonstrates how to use the minimum code to enable a web page to read barcodes from a live video stream.  </p>
 <p><strong>Basic Requirements</strong></p>
@@ -282,7 +283,7 @@
 <span class="hljs-tag">&lt;<span class="hljs-name">body</span>&gt;</span>
 <span class="hljs-tag">&lt;<span class="hljs-name">div</span> <span class="hljs-attr">id</span>=<span class="hljs-string">&quot;camera-view-container&quot;</span> <span class="hljs-attr">style</span>=<span class="hljs-string">&quot;width: 100%; height: 60vh&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">div</span>&gt;</span>
 <span class="hljs-tag">&lt;<span class="hljs-name">textarea</span> <span class="hljs-attr">id</span>=<span class="hljs-string">&quot;results&quot;</span> <span class="hljs-attr">style</span>=<span class="hljs-string">&quot;width: 100%; min-height: 10vh; font-size: 3vmin; overflow: auto&quot;</span> <span class="hljs-attr">disabled</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">textarea</span>&gt;</span>
-<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
+<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.2001/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
 <span class="hljs-tag">&lt;<span class="hljs-name">script</span>&gt;</span><span class="javascript">
   Dynamsoft.License.LicenseManager.initLicense(<span class="hljs-string">&quot;DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9&quot;</span>);
   Dynamsoft.Core.CoreModule.loadWasm();
@@ -390,24 +391,24 @@ cvRouter.addResultFilter(filter);
 <ul>
 <li>jsDelivr</li>
 </ul>
-<pre><code class="hljs html language-html">  <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
+<pre><code class="hljs html language-html">  <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.2001/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
 </code></pre>
 <ul>
 <li>UNPKG</li>
 </ul>
-<pre><code class="hljs html language-html">  <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://unpkg.com/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
+<pre><code class="hljs html language-html">  <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://unpkg.com/dynamsoft-barcode-reader-bundle@11.4.2001/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
 </code></pre>
 <!-- - In some rare cases (such as some restricted areas), you might not be able to access the CDN. If this happens, you can use the following files for the test.
-<pre><code class="hljs html language-html">  <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://download2.dynamsoft.com/packages/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
+<pre><code class="hljs html language-html">  <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://download2.dynamsoft.com/packages/dynamsoft-barcode-reader-bundle@11.4.2001/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
 </code></pre>
   However, please **DO NOT** use `download2.dynamsoft.com` resources in a production application as they are for temporary testing purposes only. Instead, you can try hosting the SDK yourself. -->
 <ul>
 <li>In frameworks like React, Vue and Angular, you may want to add the package as a dependency.</li>
 </ul>
-<pre><code class="hljs sh language-sh">  npm i dynamsoft-barcode-reader-bundle@11.4.2000 -E
+<pre><code class="hljs sh language-sh">  npm i dynamsoft-barcode-reader-bundle@11.4.2001 -E
   <span class="hljs-comment"># or</span>
-  yarn add dynamsoft-barcode-reader-bundle@11.4.2000 -E
+  yarn add dynamsoft-barcode-reader-bundle@11.4.2001 -E
 </code></pre>
 <p>NOTE that in frameworks, you need to <a href="#2-optional-specify-the-location-of-the-engine-files">specify the location of the engine files</a>.</p>
 <div class="multi-panel-end"></div>
@@ -420,14 +421,14 @@ cvRouter.addResultFilter(filter);
 <p>The resources are located at path <code>dynamsoft/distributables/&lt;pkg&gt;@&lt;version&gt;</code>.</p></li>
 <li><p>From npm</p></li>
 </ul>
-<pre><code class="hljs sh language-sh">  npm i dynamsoft-barcode-reader-bundle@11.4.2000 -E
+<pre><code class="hljs sh language-sh">  npm i dynamsoft-barcode-reader-bundle@11.4.2001 -E
 </code></pre>
 <p>The resources are located at the path <code>node_modules/&lt;pkg&gt;</code>, without <code>@&lt;version&gt;</code>. You must copy "dynamsoft-xxx" packages elsewhere and add <code>@&lt;version&gt;</code>. The <code>&lt;version&gt;</code> can be obtained from <code>package.json</code> of each package. Another thing to do is to <a href="#2-optional-specify-the-location-of-the-engine-files">specify the engineResourcePaths</a> so that the SDK can correctly locate the resources.</p>
 <blockquote>
   <p>Since "node<em>modules" is reserved for Node.js dependencies, and in our case the package is used only as static resources, we recommend either renaming the "node</em>modules" folder or moving the "dynamsoft-" packages to a dedicated folder for static resources in your project to facilitate self-hosting.</p>
 </blockquote>
 <p>You can typically include SDK like this:</p>
-<pre><code class="hljs html language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;path/to/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
+<pre><code class="hljs html language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;path/to/dynamsoft-barcode-reader-bundle@11.4.2001/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
 </code></pre>
 <div class="multi-panel-end"></div>
 <div class="multi-panel-switching-end"></div>
@@ -693,7 +694,7 @@ settings.timeout = <span class="hljs-number">500</span>;
 <h3 id="2-edit-the-preset-templates-directly">2. Edit the preset templates directly</h3>
 <p>The preset templates have many more settings that can be customized to suit your use case best. If you <a href="https://www.dynamsoft.com/barcode-reader/downloads/1000003-confirmation/">download the SDK from Dynamsoft website</a>, you can find the templates under</p>
 <ul>
-<li>"/dynamsoft-barcode-reader-js-11.4.2000/dist/templates/"</li>
+<li>"/dynamsoft-barcode-reader-js-11.4.2001/dist/templates/"</li>
 </ul>
 <p>Upon completing the template editing, you can invoke the <code>initSettings</code> method and provide it with the template path as an argument.</p>
 <pre><code class="hljs javascript language-javascript"><span class="hljs-keyword">await</span> cvRouter.initSettings(<span class="hljs-string">&quot;PATH-TO-THE-FILE&quot;</span>); <span class="hljs-comment">// E.g. &quot;https://your-website/ReadSingleBarcode.json&quot;)</span>
@@ -767,7 +768,7 @@ uiElement.querySelector(<span class="hljs-string">&#x27;.dce-sel-resolution&#x27
 <h2 id="documentation">Documentation</h2>
 <h3 id="api-reference">API Reference</h3>
 <p>You can check out the detailed documentation about the APIs of the SDK at<br />
-<a href="https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=11.4.2000">https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=11.4.2000</a>.</p>
+<a href="https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=11.4.2001">https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=11.4.2001</a>.</p>
 <!--  Compatibility is basically not an issue. Pls remove to another place
 ## System Requirements

package/README.md CHANGED Viewed

@@ -12,7 +12,7 @@
 In this guide, you will learn step by step on how to integrate the DBR-JS SDK into your website.
-<!-- <span style="font-size:20px">Table of Contents</span>
+<span style="font-size:20px">Table of Contents</span>
 - [Barcode Reader for Your Website - Foundational API Guide](#barcode-reader-for-your-website---foundational-api-guide)
   - [Hello World - Simplest Implementation](#hello-world---simplest-implementation)
@@ -46,7 +46,7 @@ In this guide, you will learn step by step on how to integrate the DBR-JS SDK in
     - [API Reference](#api-reference)
     - [How to Upgrade](#how-to-upgrade)
     - [Release Notes](#release-notes)
-  - [Next Steps](#next-steps) -->
+  - [Next Steps](#next-steps)
 ## Hello World - Simplest Implementation
@@ -70,7 +70,7 @@ The complete code of the "Hello World" example is shown below
 <body>
 <div id="camera-view-container" style="width: 100%; height: 60vh"></div>
 <textarea id="results" style="width: 100%; min-height: 10vh; font-size: 3vmin; overflow: auto" disabled></textarea>
-<script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.2001/dist/dbr.bundle.js"></script>
 <script>
   Dynamsoft.License.LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9");
   Dynamsoft.Core.CoreModule.loadWasm();
@@ -192,19 +192,19 @@ The simplest way to include the SDK is to use either the [jsDelivr](https://jsde
 - jsDelivr
   ```html
-  <script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.2001/dist/dbr.bundle.js"></script>
   ```
 - UNPKG
   ```html
-  <script src="https://unpkg.com/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js"></script>
+  <script src="https://unpkg.com/dynamsoft-barcode-reader-bundle@11.4.2001/dist/dbr.bundle.js"></script>
   ```
 <!-- - In some rare cases (such as some restricted areas), you might not be able to access the CDN. If this happens, you can use the following files for the test.
   ```html
-  <script src="https://download2.dynamsoft.com/packages/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js"></script>
+  <script src="https://download2.dynamsoft.com/packages/dynamsoft-barcode-reader-bundle@11.4.2001/dist/dbr.bundle.js"></script>
   ```
   However, please **DO NOT** use `download2.dynamsoft.com` resources in a production application as they are for temporary testing purposes only. Instead, you can try hosting the SDK yourself. -->
@@ -212,9 +212,9 @@ The simplest way to include the SDK is to use either the [jsDelivr](https://jsde
 - In frameworks like React, Vue and Angular, you may want to add the package as a dependency.
   ```sh
-  npm i dynamsoft-barcode-reader-bundle@11.4.2000 -E
+  npm i dynamsoft-barcode-reader-bundle@11.4.2001 -E
   # or
-  yarn add dynamsoft-barcode-reader-bundle@11.4.2000 -E
+  yarn add dynamsoft-barcode-reader-bundle@11.4.2001 -E
   ```
   NOTE that in frameworks, you need to [specify the location of the engine files](#2-optional-specify-the-location-of-the-engine-files).
@@ -234,7 +234,7 @@ Besides using the public CDN, you can also download the SDK and host its files o
 - From npm
   ```sh
-  npm i dynamsoft-barcode-reader-bundle@11.4.2000 -E
+  npm i dynamsoft-barcode-reader-bundle@11.4.2001 -E
   ```
   The resources are located at the path `node_modules/<pkg>`, without `@<version>`. You must copy "dynamsoft-xxx" packages elsewhere and add `@<version>`. The `<version>` can be obtained from `package.json` of each package. Another thing to do is to [specify the engineResourcePaths](#2-optional-specify-the-location-of-the-engine-files) so that the SDK can correctly locate the resources.
@@ -243,7 +243,7 @@ Besides using the public CDN, you can also download the SDK and host its files o
 You can typically include SDK like this:
 ```html
-<script src="path/to/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js"></script>
+<script src="path/to/dynamsoft-barcode-reader-bundle@11.4.2001/dist/dbr.bundle.js"></script>
 ```
 <div class="multi-panel-end"></div>
@@ -562,7 +562,7 @@ await cvRouter.startCapturing("ReadSingleBarcode");
 The preset templates have many more settings that can be customized to suit your use case best. If you [download the SDK from Dynamsoft website](https://www.dynamsoft.com/barcode-reader/downloads/1000003-confirmation/), you can find the templates under
-* "/dynamsoft-barcode-reader-js-11.4.2000/dist/templates/"
+* "/dynamsoft-barcode-reader-js-11.4.2001/dist/templates/"
 Upon completing the template editing, you can invoke the `initSettings` method and provide it with the template path as an argument.
@@ -664,7 +664,7 @@ The UI is part of the auxiliary SDK "Dynamsoft Camera Enhancer", read more on ho
 ### API Reference
 You can check out the detailed documentation about the APIs of the SDK at
-[https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=11.4.2000](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=11.4.2000).
+[https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=11.4.2001](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=11.4.2001).
 <!--  Compatibility is basically not an issue. Pls remove to another place