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

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/LEGAL.txt CHANGED
@@ -322,133 +322,6 @@ license you like.
322
322
 
323
323
 
324
324
 
325
- ===================================================================================
326
- OpenSSL
327
-
328
- The OpenSSL toolkit stays under a double license, i.e. both the conditions of
329
- the OpenSSL License and the original SSLeay license apply to the toolkit.
330
- See below for the actual license texts.
331
-
332
- OpenSSL License
333
- ---------------
334
-
335
- /* ====================================================================
336
- * Copyright (c) 1998-2019 The OpenSSL Project. All rights reserved.
337
- *
338
- * Redistribution and use in source and binary forms, with or without
339
- * modification, are permitted provided that the following conditions
340
- * are met:
341
- *
342
- * 1. Redistributions of source code must retain the above copyright
343
- * notice, this list of conditions and the following disclaimer.
344
- *
345
- * 2. Redistributions in binary form must reproduce the above copyright
346
- * notice, this list of conditions and the following disclaimer in
347
- * the documentation and/or other materials provided with the
348
- * distribution.
349
- *
350
- * 3. All advertising materials mentioning features or use of this
351
- * software must display the following acknowledgment:
352
- * "This product includes software developed by the OpenSSL Project
353
- * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
354
- *
355
- * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
356
- * endorse or promote products derived from this software without
357
- * prior written permission. For written permission, please contact
358
- * openssl-core@openssl.org.
359
- *
360
- * 5. Products derived from this software may not be called "OpenSSL"
361
- * nor may "OpenSSL" appear in their names without prior written
362
- * permission of the OpenSSL Project.
363
- *
364
- * 6. Redistributions of any form whatsoever must retain the following
365
- * acknowledgment:
366
- * "This product includes software developed by the OpenSSL Project
367
- * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
368
- *
369
- * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
370
- * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
371
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
372
- * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
373
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
374
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
375
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
376
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
377
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
378
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
379
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
380
- * OF THE POSSIBILITY OF SUCH DAMAGE.
381
- * ====================================================================
382
- *
383
- * This product includes cryptographic software written by Eric Young
384
- * (eay@cryptsoft.com). This product includes software written by Tim
385
- * Hudson (tjh@cryptsoft.com).
386
- *
387
- */
388
-
389
- Original SSLeay License
390
- -----------------------
391
-
392
- /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
393
- * All rights reserved.
394
- *
395
- * This package is an SSL implementation written
396
- * by Eric Young (eay@cryptsoft.com).
397
- * The implementation was written so as to conform with Netscapes SSL.
398
- *
399
- * This library is free for commercial and non-commercial use as long as
400
- * the following conditions are aheared to. The following conditions
401
- * apply to all code found in this distribution, be it the RC4, RSA,
402
- * lhash, DES, etc., code; not just the SSL code. The SSL documentation
403
- * included with this distribution is covered by the same copyright terms
404
- * except that the holder is Tim Hudson (tjh@cryptsoft.com).
405
- *
406
- * Copyright remains Eric Young's, and as such any Copyright notices in
407
- * the code are not to be removed.
408
- * If this package is used in a product, Eric Young should be given attribution
409
- * as the author of the parts of the library used.
410
- * This can be in the form of a textual message at program startup or
411
- * in documentation (online or textual) provided with the package.
412
- *
413
- * Redistribution and use in source and binary forms, with or without
414
- * modification, are permitted provided that the following conditions
415
- * are met:
416
- * 1. Redistributions of source code must retain the copyright
417
- * notice, this list of conditions and the following disclaimer.
418
- * 2. Redistributions in binary form must reproduce the above copyright
419
- * notice, this list of conditions and the following disclaimer in the
420
- * documentation and/or other materials provided with the distribution.
421
- * 3. All advertising materials mentioning features or use of this software
422
- * must display the following acknowledgement:
423
- * "This product includes cryptographic software written by
424
- * Eric Young (eay@cryptsoft.com)"
425
- * The word 'cryptographic' can be left out if the rouines from the library
426
- * being used are not cryptographic related :-).
427
- * 4. If you include any Windows specific code (or a derivative thereof) from
428
- * the apps directory (application code) you must include an acknowledgement:
429
- * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
430
- *
431
- * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
432
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
433
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
434
- * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
435
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
436
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
437
- * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
438
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
439
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
440
- * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
441
- * SUCH DAMAGE.
442
- *
443
- * The licence and distribution terms for any publically available version or
444
- * derivative of this code cannot be changed. i.e. this code cannot simply be
445
- * copied and put under another distribution licence
446
- * [including the GNU Public Licence.]
447
- */
448
- ===================================================================================
449
-
450
-
451
-
452
325
  ===================================================================================
453
326
  localForage
454
327
 
package/README.html CHANGED
@@ -229,41 +229,6 @@
229
229
  ![downloads](https://img.shields.io/npm/dm/dynamsoft-javascript-barcode.svg)
230
230
  ![jsdelivr](https://img.shields.io/jsdelivr/npm/hm/dynamsoft-javascript-barcode.svg) -->
231
231
  <p>In this guide, you will learn step by step on how to integrate the DBR-JS SDK into your website.</p>
232
- <!-- <span style="font-size:20px">Table of Contents</span>
233
-
234
- - [Barcode Reader for Your Website - Foundational API Guide](#barcode-reader-for-your-website---foundational-api-guide)
235
- - [Hello World - Simplest Implementation](#hello-world---simplest-implementation)
236
- - [Understand the code](#understand-the-code)
237
- - [About the code](#about-the-code)
238
- - [Run the example](#run-the-example)
239
- - [Preparing the SDK](#preparing-the-sdk)
240
- - [Step 1: Include the SDK](#step-1-include-the-sdk)
241
- - [Step 2: Prepare the SDK](#step-2-prepare-the-sdk)
242
- - [1. Specify the license](#1-specify-the-license)
243
- - [2. \[Optional\] Specify the location of the "engine" files](#2-optional-specify-the-location-of-the-engine-files)
244
- - [Using the SDK](#using-the-sdk)
245
- - [Step 1: Preload the module](#step-1-preload-the-module)
246
- - [Step 2: Create a CaptureVisionRouter object](#step-2-create-a-capturevisionrouter-object)
247
- - [Step 3: Connect an image source](#step-3-connect-an-image-source)
248
- - [Step 4: Register a result receiver](#step-4-register-a-result-receiver)
249
- - [Step 5: Start process video frames](#step-5-start-process-video-frames)
250
- - [Customizing the process](#customizing-the-process)
251
- - [1. Adjust the preset template settings](#1-adjust-the-preset-template-settings)
252
- - [1.1. Change barcode settings](#11-change-barcode-settings)
253
- - [1.2. Retrieve the original image](#12-retrieve-the-original-image)
254
- - [1.3. Change reading frequency to save power](#13-change-reading-frequency-to-save-power)
255
- - [1.4. Specify a scan region](#14-specify-a-scan-region)
256
- - [2. Edit the preset templates directly](#2-edit-the-preset-templates-directly)
257
- - [3. \[Important\] Filter the results](#3-important-filter-the-results)
258
- - [Method 1: Verify results across multiple frames](#method-1-verify-results-across-multiple-frames)
259
- - [Method 2: Eliminate redundant results detected within a short time frame](#method-2-eliminate-redundant-results-detected-within-a-short-time-frame)
260
- - [4. Add feedback](#4-add-feedback)
261
- - [Customizing the UI](#customizing-the-ui)
262
- - [Documentation](#documentation)
263
- - [API Reference](#api-reference)
264
- - [How to Upgrade](#how-to-upgrade)
265
- - [Release Notes](#release-notes)
266
- - [Next Steps](#next-steps) -->
267
232
  <h2 id="hello-world---simplest-implementation">Hello World - Simplest Implementation</h2>
268
233
  <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>
269
234
  <p><strong>Basic Requirements</strong></p>
@@ -282,7 +247,7 @@
282
247
  <span class="hljs-tag">&lt;<span class="hljs-name">body</span>&gt;</span>
283
248
  <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>
284
249
  <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>
285
- <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>
250
+ <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.3000/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
286
251
  <span class="hljs-tag">&lt;<span class="hljs-name">script</span>&gt;</span><span class="javascript">
287
252
  Dynamsoft.License.LicenseManager.initLicense(<span class="hljs-string">&quot;DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9&quot;</span>);
288
253
  Dynamsoft.Core.CoreModule.loadWasm();
@@ -317,7 +282,7 @@
317
282
  <span class="hljs-tag">&lt;/<span class="hljs-name">html</span>&gt;</span>
318
283
  </code></pre>
319
284
  <p align="center" style="text-align:center; white-space: normal; ">
320
- <a target="_blank" href="https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/v11.4.20/hello-world.html" title="Code in Github" style="text-decoration:none;">
285
+ <a target="_blank" href="https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/v11.4.20/basics/hello-world.html" title="Code in Github" style="text-decoration:none;">
321
286
  <img src="https://cdn.jsdelivr.net/npm/simple-icons@3.0.1/icons/github.svg" alt="Code in Github" width="20" height="20" style="width:20px;height:20px;">
322
287
  </a>
323
288
  &nbsp;
@@ -325,7 +290,7 @@
325
290
  <img src="https://cdn.jsdelivr.net/npm/simple-icons@3.0.1/icons/jsfiddle.svg" alt="Run via JSFiddle" width="20" height="20" style="width:20px;height:20px;" >
326
291
  </a>
327
292
  &nbsp;
328
- <a target="_blank" href="https://demo.dynamsoft.com/Samples/DBR/JS/hello-world.html?ver=11.4.20&utm_source=npm" title="Run in Dynamsoft" style="text-decoration:none;">
293
+ <a target="_blank" href="https://demo.dynamsoft.com/Samples/DBR/JS/basics/hello-world.html?ver=11.4.20&utm_source=npm" title="Run in Dynamsoft" style="text-decoration:none;">
329
294
  <img src="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.0.0/svgs/solid/circle-play.svg" alt="Run in Dynamsoft" width="20" height="20" style="width:20px;height:20px;">
330
295
  </a>
331
296
  </p>
@@ -368,7 +333,7 @@ cvRouter.addResultFilter(filter);
368
333
  <p>Read more on <a href="https://www.dynamsoft.com/capture-vision/docs/core/architecture/#capture-vision-router">Capture Vision Router</a>.</p>
369
334
  </blockquote>
370
335
  <h3 id="run-the-example">Run the example</h3>
371
- <p>You can run the example deployed to <a href="https://demo.dynamsoft.com/Samples/DBR/JS/hello-world.html?ver=11.4.20&utm_source=npm">the Dynamsoft Demo Server</a> or test it with <a href="https://jsfiddle.net/DynamsoftTeam/csm2f9wb/">JSFiddle code editor</a>. </p>
336
+ <p>You can run the example deployed to <a href="https://demo.dynamsoft.com/Samples/DBR/JS/basics/hello-world.html?ver=11.4.20&utm_source=npm">the Dynamsoft Demo Server</a> or test it with <a href="https://jsfiddle.net/DynamsoftTeam/csm2f9wb/">JSFiddle code editor</a>. </p>
372
337
  <p>You will be asked to allow access to your camera, after which the video will be displayed on the page. After that, you can point the camera at a barcode to read it.</p>
373
338
  <p>When a barcode is decoded, you will see the result text show up under the video and the barcode location will be highlighted in the video feed.</p>
374
339
  <p>Alternatively, you can test locally by copying and pasting the code shown above into a local file (e.g. "hello-world.html") and opening it in your browser.</p>
@@ -390,24 +355,24 @@ cvRouter.addResultFilter(filter);
390
355
  <ul>
391
356
  <li>jsDelivr</li>
392
357
  </ul>
393
- <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>
358
+ <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.3000/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
394
359
  </code></pre>
395
360
  <ul>
396
361
  <li>UNPKG</li>
397
362
  </ul>
398
- <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>
363
+ <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.3000/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
399
364
  </code></pre>
400
365
  <!-- - 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.
401
- <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>
366
+ <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.3000/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
402
367
  </code></pre>
403
368
 
404
369
  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. -->
405
370
  <ul>
406
371
  <li>In frameworks like React, Vue and Angular, you may want to add the package as a dependency.</li>
407
372
  </ul>
408
- <pre><code class="hljs sh language-sh"> npm i dynamsoft-barcode-reader-bundle@11.4.2000 -E
373
+ <pre><code class="hljs sh language-sh"> npm i dynamsoft-barcode-reader-bundle@11.4.3000 -E
409
374
  <span class="hljs-comment"># or</span>
410
- yarn add dynamsoft-barcode-reader-bundle@11.4.2000 -E
375
+ yarn add dynamsoft-barcode-reader-bundle@11.4.3000 -E
411
376
  </code></pre>
412
377
  <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>
413
378
  <div class="multi-panel-end"></div>
@@ -417,17 +382,17 @@ cvRouter.addResultFilter(filter);
417
382
  <ul>
418
383
  <li><p>From the website</p>
419
384
  <p><a href="https://www.dynamsoft.com/barcode-reader/downloads/?ver=11.4.20&utm_source=npm&product=dbr&package=js">Download Dynamsoft Barcode Reader JavaScript Package</a></p>
420
- <p>The resources are located at path <code>dynamsoft/distributables/&lt;pkg&gt;@&lt;version&gt;</code>.</p></li>
385
+ <p>The resources are located at path <code>dynamsoft-barcode-reader-js-{version-number}/dist/</code>.</p></li>
421
386
  <li><p>From npm</p></li>
422
387
  </ul>
423
- <pre><code class="hljs sh language-sh"> npm i dynamsoft-barcode-reader-bundle@11.4.2000 -E
388
+ <pre><code class="hljs sh language-sh"> npm i dynamsoft-barcode-reader-bundle@11.4.3000 -E
424
389
  </code></pre>
425
390
  <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>
426
391
  <blockquote>
427
392
  <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>
428
393
  </blockquote>
429
394
  <p>You can typically include SDK like this:</p>
430
- <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>
395
+ <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.3000/dist/dbr.bundle.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
431
396
  </code></pre>
432
397
  <div class="multi-panel-end"></div>
433
398
  <div class="multi-panel-switching-end"></div>
@@ -693,7 +658,7 @@ settings.timeout = <span class="hljs-number">500</span>;
693
658
  <h3 id="2-edit-the-preset-templates-directly">2. Edit the preset templates directly</h3>
694
659
  <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>
695
660
  <ul>
696
- <li>"/dynamsoft-barcode-reader-js-11.4.2000/dist/templates/"</li>
661
+ <li>"/dynamsoft-barcode-reader-js-11.4.3000/dist/templates/"</li>
697
662
  </ul>
698
663
  <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>
699
664
  <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 +732,7 @@ uiElement.querySelector(<span class="hljs-string">&#x27;.dce-sel-resolution&#x27
767
732
  <h2 id="documentation">Documentation</h2>
768
733
  <h3 id="api-reference">API Reference</h3>
769
734
  <p>You can check out the detailed documentation about the APIs of the SDK at<br />
770
- <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>
735
+ <a href="https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=11.4.3000">https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=11.4.3000</a>.</p>
771
736
  <!-- Compatibility is basically not an issue. Pls remove to another place
772
737
 
773
738
  ## System Requirements
package/README.md CHANGED
@@ -12,42 +12,6 @@
12
12
 
13
13
  In this guide, you will learn step by step on how to integrate the DBR-JS SDK into your website.
14
14
 
15
- <!-- <span style="font-size:20px">Table of Contents</span>
16
-
17
- - [Barcode Reader for Your Website - Foundational API Guide](#barcode-reader-for-your-website---foundational-api-guide)
18
- - [Hello World - Simplest Implementation](#hello-world---simplest-implementation)
19
- - [Understand the code](#understand-the-code)
20
- - [About the code](#about-the-code)
21
- - [Run the example](#run-the-example)
22
- - [Preparing the SDK](#preparing-the-sdk)
23
- - [Step 1: Include the SDK](#step-1-include-the-sdk)
24
- - [Step 2: Prepare the SDK](#step-2-prepare-the-sdk)
25
- - [1. Specify the license](#1-specify-the-license)
26
- - [2. \[Optional\] Specify the location of the "engine" files](#2-optional-specify-the-location-of-the-engine-files)
27
- - [Using the SDK](#using-the-sdk)
28
- - [Step 1: Preload the module](#step-1-preload-the-module)
29
- - [Step 2: Create a CaptureVisionRouter object](#step-2-create-a-capturevisionrouter-object)
30
- - [Step 3: Connect an image source](#step-3-connect-an-image-source)
31
- - [Step 4: Register a result receiver](#step-4-register-a-result-receiver)
32
- - [Step 5: Start process video frames](#step-5-start-process-video-frames)
33
- - [Customizing the process](#customizing-the-process)
34
- - [1. Adjust the preset template settings](#1-adjust-the-preset-template-settings)
35
- - [1.1. Change barcode settings](#11-change-barcode-settings)
36
- - [1.2. Retrieve the original image](#12-retrieve-the-original-image)
37
- - [1.3. Change reading frequency to save power](#13-change-reading-frequency-to-save-power)
38
- - [1.4. Specify a scan region](#14-specify-a-scan-region)
39
- - [2. Edit the preset templates directly](#2-edit-the-preset-templates-directly)
40
- - [3. \[Important\] Filter the results](#3-important-filter-the-results)
41
- - [Method 1: Verify results across multiple frames](#method-1-verify-results-across-multiple-frames)
42
- - [Method 2: Eliminate redundant results detected within a short time frame](#method-2-eliminate-redundant-results-detected-within-a-short-time-frame)
43
- - [4. Add feedback](#4-add-feedback)
44
- - [Customizing the UI](#customizing-the-ui)
45
- - [Documentation](#documentation)
46
- - [API Reference](#api-reference)
47
- - [How to Upgrade](#how-to-upgrade)
48
- - [Release Notes](#release-notes)
49
- - [Next Steps](#next-steps) -->
50
-
51
15
  ## Hello World - Simplest Implementation
52
16
 
53
17
  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.
@@ -70,7 +34,7 @@ The complete code of the "Hello World" example is shown below
70
34
  <body>
71
35
  <div id="camera-view-container" style="width: 100%; height: 60vh"></div>
72
36
  <textarea id="results" style="width: 100%; min-height: 10vh; font-size: 3vmin; overflow: auto" disabled></textarea>
73
- <script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js"></script>
37
+ <script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.3000/dist/dbr.bundle.js"></script>
74
38
  <script>
75
39
  Dynamsoft.License.LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9");
76
40
  Dynamsoft.Core.CoreModule.loadWasm();
@@ -106,7 +70,7 @@ The complete code of the "Hello World" example is shown below
106
70
  ```
107
71
 
108
72
  <p align="center" style="text-align:center; white-space: normal; ">
109
- <a target="_blank" href="https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/v11.4.20/hello-world.html" title="Code in Github" style="text-decoration:none;">
73
+ <a target="_blank" href="https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/v11.4.20/basics/hello-world.html" title="Code in Github" style="text-decoration:none;">
110
74
  <img src="https://cdn.jsdelivr.net/npm/simple-icons@3.0.1/icons/github.svg" alt="Code in Github" width="20" height="20" style="width:20px;height:20px;">
111
75
  </a>
112
76
  &nbsp;
@@ -114,7 +78,7 @@ The complete code of the "Hello World" example is shown below
114
78
  <img src="https://cdn.jsdelivr.net/npm/simple-icons@3.0.1/icons/jsfiddle.svg" alt="Run via JSFiddle" width="20" height="20" style="width:20px;height:20px;" >
115
79
  </a>
116
80
  &nbsp;
117
- <a target="_blank" href="https://demo.dynamsoft.com/Samples/DBR/JS/hello-world.html?ver=11.4.20&utm_source=npm" title="Run in Dynamsoft" style="text-decoration:none;">
81
+ <a target="_blank" href="https://demo.dynamsoft.com/Samples/DBR/JS/basics/hello-world.html?ver=11.4.20&utm_source=npm" title="Run in Dynamsoft" style="text-decoration:none;">
118
82
  <img src="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.0.0/svgs/solid/circle-play.svg" alt="Run in Dynamsoft" width="20" height="20" style="width:20px;height:20px;">
119
83
  </a>
120
84
  </p>
@@ -159,7 +123,7 @@ The complete code of the "Hello World" example is shown below
159
123
 
160
124
  ### Run the example
161
125
 
162
- You can run the example deployed to [the Dynamsoft Demo Server](https://demo.dynamsoft.com/Samples/DBR/JS/hello-world.html?ver=11.4.20&utm_source=npm) or test it with [JSFiddle code editor](https://jsfiddle.net/DynamsoftTeam/csm2f9wb/).
126
+ You can run the example deployed to [the Dynamsoft Demo Server](https://demo.dynamsoft.com/Samples/DBR/JS/basics/hello-world.html?ver=11.4.20&utm_source=npm) or test it with [JSFiddle code editor](https://jsfiddle.net/DynamsoftTeam/csm2f9wb/).
163
127
 
164
128
  You will be asked to allow access to your camera, after which the video will be displayed on the page. After that, you can point the camera at a barcode to read it.
165
129
 
@@ -192,19 +156,19 @@ The simplest way to include the SDK is to use either the [jsDelivr](https://jsde
192
156
  - jsDelivr
193
157
 
194
158
  ```html
195
- <script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js"></script>
159
+ <script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.3000/dist/dbr.bundle.js"></script>
196
160
  ```
197
161
 
198
162
  - UNPKG
199
163
 
200
164
  ```html
201
- <script src="https://unpkg.com/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js"></script>
165
+ <script src="https://unpkg.com/dynamsoft-barcode-reader-bundle@11.4.3000/dist/dbr.bundle.js"></script>
202
166
  ```
203
167
 
204
168
  <!-- - 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.
205
169
 
206
170
  ```html
207
- <script src="https://download2.dynamsoft.com/packages/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js"></script>
171
+ <script src="https://download2.dynamsoft.com/packages/dynamsoft-barcode-reader-bundle@11.4.3000/dist/dbr.bundle.js"></script>
208
172
  ```
209
173
 
210
174
  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 +176,9 @@ The simplest way to include the SDK is to use either the [jsDelivr](https://jsde
212
176
  - In frameworks like React, Vue and Angular, you may want to add the package as a dependency.
213
177
 
214
178
  ```sh
215
- npm i dynamsoft-barcode-reader-bundle@11.4.2000 -E
179
+ npm i dynamsoft-barcode-reader-bundle@11.4.3000 -E
216
180
  # or
217
- yarn add dynamsoft-barcode-reader-bundle@11.4.2000 -E
181
+ yarn add dynamsoft-barcode-reader-bundle@11.4.3000 -E
218
182
  ```
219
183
 
220
184
  NOTE that in frameworks, you need to [specify the location of the engine files](#2-optional-specify-the-location-of-the-engine-files).
@@ -229,12 +193,12 @@ Besides using the public CDN, you can also download the SDK and host its files o
229
193
 
230
194
  [Download Dynamsoft Barcode Reader JavaScript Package](https://www.dynamsoft.com/barcode-reader/downloads/?ver=11.4.20&utm_source=npm&product=dbr&package=js)
231
195
 
232
- The resources are located at path `dynamsoft/distributables/<pkg>@<version>`.
196
+ The resources are located at path `dynamsoft-barcode-reader-js-{version-number}/dist/`.
233
197
 
234
198
  - From npm
235
199
 
236
200
  ```sh
237
- npm i dynamsoft-barcode-reader-bundle@11.4.2000 -E
201
+ npm i dynamsoft-barcode-reader-bundle@11.4.3000 -E
238
202
  ```
239
203
 
240
204
  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 +207,7 @@ Besides using the public CDN, you can also download the SDK and host its files o
243
207
  You can typically include SDK like this:
244
208
 
245
209
  ```html
246
- <script src="path/to/dynamsoft-barcode-reader-bundle@11.4.2000/dist/dbr.bundle.js"></script>
210
+ <script src="path/to/dynamsoft-barcode-reader-bundle@11.4.3000/dist/dbr.bundle.js"></script>
247
211
  ```
248
212
  <div class="multi-panel-end"></div>
249
213
 
@@ -562,7 +526,7 @@ await cvRouter.startCapturing("ReadSingleBarcode");
562
526
 
563
527
  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
564
528
 
565
- * "/dynamsoft-barcode-reader-js-11.4.2000/dist/templates/"
529
+ * "/dynamsoft-barcode-reader-js-11.4.3000/dist/templates/"
566
530
 
567
531
  Upon completing the template editing, you can invoke the `initSettings` method and provide it with the template path as an argument.
568
532
 
@@ -664,7 +628,7 @@ The UI is part of the auxiliary SDK "Dynamsoft Camera Enhancer", read more on ho
664
628
  ### API Reference
665
629
 
666
630
  You can check out the detailed documentation about the APIs of the SDK at
667
- [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).
631
+ [https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=11.4.3000](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=11.4.3000).
668
632
 
669
633
  <!-- Compatibility is basically not an issue. Pls remove to another place
670
634
 
@@ -1265,7 +1265,8 @@ declare const productNameMap: {
1265
1265
  readonly dcvBundle: "dynamsoft-capture-vision-bundle";
1266
1266
  };
1267
1267
 
1268
- export { Arc, AuxiliaryRegionElement, BinaryImageUnit, CapturedResultBase, CapturedResultItem, ColourImageUnit, Contour, ContoursUnit, CoreModule, Corner, DSFile, DSImageData, DSRect, DwtInfo, Edge, EngineResourcePaths, EnhancedGrayscaleImageUnit, EnumBufferOverflowProtectionMode, EnumCapturedResultItemType, EnumColourChannelUsageType, EnumCornerType, EnumCrossVerificationStatus, EnumErrorCode, EnumGrayscaleEnhancementMode, EnumGrayscaleTransformationMode, EnumImageCaptureDistanceMode, EnumImageFileFormat, EnumImagePixelFormat, EnumImageTagType, EnumIntermediateResultUnitType, EnumModuleName, EnumPDFReadingMode, EnumRasterDataSource, EnumRegionObjectElementType, EnumSectionType, ErrorInfo, FileImageTag, GrayscaleImageUnit, ImageSourceAdapter, ImageSourceErrorListener, ImageTag, InnerVersions, IntermediateResult, IntermediateResultExtraInfo, IntermediateResultUnit, LineSegment, LineSegmentsUnit, MapController, MimeType, ObservationParameters, OriginalImageResultItem, PDFReadingParameter, PathInfo, Point, Polygon, PostMessageBody, PredetectedRegionElement, PredetectedRegionsUnit, Quadrilateral, Rect, RegionObjectElement, ScaledColourImageUnit, ShortLinesUnit, TextRemovedBinaryImageUnit, TextZone, TextZonesUnit, TextureDetectionResultUnit, TextureRemovedBinaryImageUnit, TextureRemovedGrayscaleImageUnit, TransformedGrayscaleImageUnit, Warning, WasmLoadOptions, WasmType, WasmVersions, WorkerAutoResources, _saveToFile, _toBlob, _toCanvas, _toImage, bDebug, blobToDsImage, checkIsLink, compareVersion, createImageData, d, doOrWaitAsyncDependency, e, encodeBMP, getNextTaskID, handleEngineResourcePaths, imagePtrToUint8Array, innerVersions, isArc, isContour, isDSImageData, isDSRect, isDsImageKeyValue, isImageTag, isLineSegment, isObject, isOriginalDsImageData, isPoint, isPolygon, isQuad, isRect, isSimdSupported, mapAsyncDependency, mapPackageRegister, mapTaskCallBack, onLog, productNameMap, requestResource, resolveDsImageData, setBDebug, setOnLog, waitAsyncDependency, worker, workerAutoResources };
1268
+ export { CoreModule, EnumBufferOverflowProtectionMode, EnumCapturedResultItemType, EnumColourChannelUsageType, EnumCornerType, EnumCrossVerificationStatus, EnumErrorCode, EnumGrayscaleEnhancementMode, EnumGrayscaleTransformationMode, EnumImageCaptureDistanceMode, EnumImageFileFormat, EnumImagePixelFormat, EnumImageTagType, EnumIntermediateResultUnitType, EnumModuleName, EnumPDFReadingMode, EnumRasterDataSource, EnumRegionObjectElementType, EnumSectionType, ImageSourceAdapter, _saveToFile, _toBlob, _toCanvas, _toImage, bDebug, blobToDsImage, checkIsLink, compareVersion, createImageData, d, doOrWaitAsyncDependency, e, encodeBMP, getNextTaskID, handleEngineResourcePaths, imagePtrToUint8Array, innerVersions, isArc, isContour, isDSImageData, isDSRect, isDsImageKeyValue, isImageTag, isLineSegment, isObject, isOriginalDsImageData, isPoint, isPolygon, isQuad, isRect, isSimdSupported, mapAsyncDependency, mapPackageRegister, mapTaskCallBack, onLog, productNameMap, requestResource, resolveDsImageData, setBDebug, setOnLog, waitAsyncDependency, worker, workerAutoResources };
1269
+ export type { Arc, AuxiliaryRegionElement, BinaryImageUnit, CapturedResultBase, CapturedResultItem, ColourImageUnit, Contour, ContoursUnit, Corner, DSFile, DSImageData, DSRect, DwtInfo, Edge, EngineResourcePaths, EnhancedGrayscaleImageUnit, ErrorInfo, FileImageTag, GrayscaleImageUnit, ImageSourceErrorListener, ImageTag, InnerVersions, IntermediateResult, IntermediateResultExtraInfo, IntermediateResultUnit, LineSegment, LineSegmentsUnit, MapController, MimeType, ObservationParameters, OriginalImageResultItem, PDFReadingParameter, PathInfo, Point, Polygon, PostMessageBody, PredetectedRegionElement, PredetectedRegionsUnit, Quadrilateral, Rect, RegionObjectElement, ScaledColourImageUnit, ShortLinesUnit, TextRemovedBinaryImageUnit, TextZone, TextZonesUnit, TextureDetectionResultUnit, TextureRemovedBinaryImageUnit, TextureRemovedGrayscaleImageUnit, TransformedGrayscaleImageUnit, Warning, WasmLoadOptions, WasmType, WasmVersions, WorkerAutoResources };
1269
1270
 
1270
1271
 
1271
1272
 
@@ -1806,7 +1807,8 @@ declare enum EnumPresetTemplate {
1806
1807
  PT_RECOGNIZE_UPPERCASE_LETTERS = "RecognizeUppercaseLetters"
1807
1808
  }
1808
1809
 
1809
- export { CaptureVisionRouter, CaptureVisionRouterModule, CapturedResult, CapturedResultFilter, CapturedResultReceiver, EnumImageSourceState, EnumPresetTemplate, ImageSourceStateListener, IntermediateResultReceiver, RawImageResultItem, SimplifiedCaptureVisionSettings };
1810
+ export { CaptureVisionRouter, CaptureVisionRouterModule, CapturedResultReceiver, EnumImageSourceState, EnumPresetTemplate, IntermediateResultReceiver };
1811
+ export type { CapturedResult, CapturedResultFilter, ImageSourceStateListener, RawImageResultItem, SimplifiedCaptureVisionSettings };
1810
1812
 
1811
1813
 
1812
1814
  declare class BarcodeReaderModule {
@@ -2434,7 +2436,8 @@ interface ParsedResult extends CapturedResultBase {
2434
2436
  parsedResultItems: Array<ParsedResultItem>;
2435
2437
  }
2436
2438
 
2437
- export { CodeParser, CodeParserModule, EnumCodeType, EnumMappingStatus, EnumValidationStatus, ParsedResult, ParsedResultItem };
2439
+ export { CodeParser, CodeParserModule, EnumCodeType, EnumMappingStatus, EnumValidationStatus };
2440
+ export type { ParsedResult, ParsedResultItem };
2438
2441
 
2439
2442
 
2440
2443
  declare class DocumentNormalizerModule {
@@ -2574,7 +2577,8 @@ interface SimplifiedDocumentNormalizerSettings {
2574
2577
  expectedDocumentsCount: number;
2575
2578
  }
2576
2579
 
2577
- export { CandidateQuadEdgesUnit, CornersUnit, DeskewedImageElement, DeskewedImageResultItem, DeskewedImageUnit, DetectedQuadElement, DetectedQuadResultItem, DetectedQuadsUnit, DocumentNormalizerModule, EnhancedImageElement, EnhancedImageResultItem, EnhancedImageUnit, EnumImageColourMode, LogicLinesUnit, LongLinesUnit, ProcessedDocumentResult, SimplifiedDocumentNormalizerSettings };
2580
+ export { DocumentNormalizerModule, EnumImageColourMode };
2581
+ export type { CandidateQuadEdgesUnit, CornersUnit, DeskewedImageElement, DeskewedImageResultItem, DeskewedImageUnit, DetectedQuadElement, DetectedQuadResultItem, DetectedQuadsUnit, EnhancedImageElement, EnhancedImageResultItem, EnhancedImageUnit, LogicLinesUnit, LongLinesUnit, ProcessedDocumentResult, SimplifiedDocumentNormalizerSettings };
2578
2582
 
2579
2583
 
2580
2584
  declare class LabelRecognizerModule {
@@ -2788,7 +2792,8 @@ interface RecognizedTextLinesUnit extends IntermediateResultUnit {
2788
2792
  recognizedTextLines: Array<RecognizedTextLineElement>;
2789
2793
  }
2790
2794
 
2791
- export { BufferedCharacterItem, BufferedCharacterItemSet, CharacterCluster, CharacterResult, EnumRawTextLineStatus, LabelRecognizerModule, LocalizedTextLineElement, LocalizedTextLinesUnit, RawTextLine, RawTextLinesUnit, RecognizedTextLineElement, RecognizedTextLinesResult, RecognizedTextLinesUnit, SimplifiedLabelRecognizerSettings, TextLineResultItem, utilsFuncs };
2795
+ export { EnumRawTextLineStatus, LabelRecognizerModule, utilsFuncs };
2796
+ export type { BufferedCharacterItem, BufferedCharacterItemSet, CharacterCluster, CharacterResult, LocalizedTextLineElement, LocalizedTextLinesUnit, RawTextLine, RawTextLinesUnit, RecognizedTextLineElement, RecognizedTextLinesResult, RecognizedTextLinesUnit, SimplifiedLabelRecognizerSettings, TextLineResultItem };
2792
2797
 
2793
2798
  declare class LicenseModule {
2794
2799
  /**
@@ -2851,7 +2856,8 @@ interface InitConfig {
2851
2856
  pv?: any;
2852
2857
  }
2853
2858
 
2854
- export { InitConfig, LicenseManager, LicenseModule };
2859
+ export { LicenseManager, LicenseModule };
2860
+ export type { InitConfig };
2855
2861
 
2856
2862
 
2857
2863
 
@@ -3142,7 +3148,8 @@ declare class ImageProcessor {
3142
3148
  static cropAndDeskewImage(image: Blob | DSImageData, roi: Quadrilateral, dstWidth?: number, dstHeight?: number, padding?: number): Promise<DSImageData>;
3143
3149
  }
3144
3150
 
3145
- export { CBarcodeResultItem, CDecodedBarcodeElement, CEdge, CLocalizedBarcodeElement, CQuadrilateral, CapturedResultMap, CrossVerificationCriteria, EnumFilterType, ImageDrawer, ImageIO, ImageProcessor, MultiFrameResultCrossFilter, UtilityModule, resultItemTypeString };
3151
+ export { EnumFilterType, ImageDrawer, ImageIO, ImageProcessor, MultiFrameResultCrossFilter, UtilityModule };
3152
+ export type { CBarcodeResultItem, CDecodedBarcodeElement, CEdge, CLocalizedBarcodeElement, CQuadrilateral, CapturedResultMap, CrossVerificationCriteria, resultItemTypeString };
3146
3153
 
3147
3154
 
3148
3155