diff --git a/error.md b/error.md index a25cf789..7cd4412c 100644 --- a/error.md +++ b/error.md @@ -2,7 +2,7 @@ layout: default-layout title: Error Page - Dynamsoft Barcode Reader SDK Documentation keywords: dynamsoft barcode reader, dbr, documentation, error page -description: Dynamsoft Barcode Reader SDK Documentation Errorpage +description: Dynamsoft Barcode Reader SDK Documentation Error page ---
diff --git a/programming/javascript/api-reference/interfaces/barcode-result-item.md b/programming/javascript/api-reference/interfaces/barcode-result-item.md index 097058e9..39f966be 100644 --- a/programming/javascript/api-reference/interfaces/barcode-result-item.md +++ b/programming/javascript/api-reference/interfaces/barcode-result-item.md @@ -117,7 +117,7 @@ moduleSize: number; ## details -Represent additional details specific to the barcode, which could vary depending on the barcode format. +Represents additional details specific to the barcode, which could vary depending on the barcode format. ```typescript details: BarcodeDetails; @@ -153,4 +153,4 @@ eciSegments: Array; **Remarks** -New added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000. +Added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000. diff --git a/programming/javascript/api-reference/interfaces/decoded-barcode-element.md b/programming/javascript/api-reference/interfaces/decoded-barcode-element.md index e40e35c3..7a2b3104 100644 --- a/programming/javascript/api-reference/interfaces/decoded-barcode-element.md +++ b/programming/javascript/api-reference/interfaces/decoded-barcode-element.md @@ -80,7 +80,7 @@ bytes: Array; ## details -Represent additional details specific to the barcode, which could vary depending on the barcode format. +Represents additional details specific to the barcode, which could vary depending on the barcode format. ```typescript details: BarcodeDetails; @@ -152,4 +152,4 @@ eciSegments: Array; **Remarks** -New added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000. \ No newline at end of file +Added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000. \ No newline at end of file diff --git a/programming/javascript/api-reference/interfaces/eci-segment.md b/programming/javascript/api-reference/interfaces/eci-segment.md index 179b85b8..be3ddbac 100644 --- a/programming/javascript/api-reference/interfaces/eci-segment.md +++ b/programming/javascript/api-reference/interfaces/eci-segment.md @@ -65,4 +65,4 @@ length: number; **Remarks** -New added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000. \ No newline at end of file +Added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000. \ No newline at end of file diff --git a/programming/javascript/api-reference/interfaces/scaled-barcode-image-unit.md b/programming/javascript/api-reference/interfaces/scaled-barcode-image-unit.md index d4e6cf25..e7d3c060 100644 --- a/programming/javascript/api-reference/interfaces/scaled-barcode-image-unit.md +++ b/programming/javascript/api-reference/interfaces/scaled-barcode-image-unit.md @@ -1,18 +1,18 @@ --- layout: default-layout -title: interface ScaleBarcodeImageUnit - Dynamsoft Barcode Reader Module JS Edition API Reference -description: This page shows the JS edition of the interface ScaleBarcodeImageUnit in Dynamsoft Barcode Reader Module. +title: interface ScaledBarcodeImageUnit - Dynamsoft Barcode Reader Module JS Edition API Reference +description: This page shows the JS edition of the interface ScaledBarcodeImageUnit in Dynamsoft Barcode Reader Module. keywords: scaled, Image unit, JS needAutoGenerateSidebar: true noTitleIndex: true --- -# ScaleBarcodeImageUnit +# ScaledBarcodeImageUnit A unit of data that contains scaled barcode image. It extends the `IntermediateResultUnit` interface. ```typescript -interface ScaleBarcodeImageUnit extends Core.IntermediateResultUnit { +interface ScaledBarcodeImageUnit extends Core.IntermediateResultUnit { imageData: Core.DSImageData; } ``` diff --git a/programming/javascript/api-reference/interfaces/simplified-barcode-reader-settings.md b/programming/javascript/api-reference/interfaces/simplified-barcode-reader-settings.md index 28b4fd2a..c1499463 100644 --- a/programming/javascript/api-reference/interfaces/simplified-barcode-reader-settings.md +++ b/programming/javascript/api-reference/interfaces/simplified-barcode-reader-settings.md @@ -92,7 +92,7 @@ grayscaleEnhancementModes: Array; ## localizationModes -Set the location modes with an array of enumeration `LocalizationMode`. View the reference page of `LocalizationModes` for more detail about location modes. +Set the localization modes with an array of enumeration `LocalizationMode`. View the reference page of `LocalizationModes` for more detail about localization modes. ```typescript localizationModes: Array; diff --git a/programming/javascript/release-notes/index.md b/programming/javascript/release-notes/index.md index bd9ba9cd..aff9bd29 100644 --- a/programming/javascript/release-notes/index.md +++ b/programming/javascript/release-notes/index.md @@ -33,7 +33,6 @@ breadcrumbText: Release Notes - [9.6.11 (03/13/2023)](js-9.html#9611-03132023) - [9.6.10 (02/21/2023)](js-9.html#9610-02212023) - [9.6.2 (01/16/2023)](js-9.html#962-01162023) -- [9.6.2 (01/16/2023)](js-9.html#962-01162023) - [9.6.1 (12/19/2022)](js-9.html#961-12192022) - [9.6.0 (12/13/2022)](js-9.html#960-12132022) - [9.3.1 (10/10/2022)](js-9.html#931-10102022) @@ -77,4 +76,4 @@ breadcrumbText: Release Notes - [6.4.1 (12/11/2018)](js-7.html#641-12112018) - [6.3.0 (08/16/2018)](js-7.html#630-08162018) - [5.2.0 (09/18/2017)](js-7.html#520-09182017) -- [5.1.0 (05/25/2017)](js-7.html#510-05252017) +- [5.1.0 (05/25/2017)](js-7.html#510-05252017) diff --git a/programming/javascript/release-notes/js-10.md b/programming/javascript/release-notes/js-10.md index 4c95b5ed..0c8075de 100644 --- a/programming/javascript/release-notes/js-10.md +++ b/programming/javascript/release-notes/js-10.md @@ -15,19 +15,14 @@ permalink: /programming/javascript/release-notes/js-10.html ### New -- Introduced [BarcodeScanner](https://dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/barcode-scanner.html) class +- Introduced the [BarcodeScanner](https://dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/barcode-scanner.html) class - Offers high-level APIs that provide core functionalities - Includes pre-built UI for fast and seamless integration - Features intuitive configuration objects to simplify both algorithm and UI setup -

- multiple - multiple -

- ### Improved -- Merged resource files previously required by the Barcode-Reader-Bundle, significantly reduced the overall size of the `.wasm` file +- Merged resource files previously required by the Barcode-Reader-Bundle, significantly reducing the overall size of the `.wasm` file ## 10.4.3100 (01/03/2025) @@ -155,14 +150,14 @@ permalink: /programming/javascript/release-notes/js-10.html - Changed the logic of the `capturedResultItemTypes` setting of [`SimplifiedCaptureVisionSettings`]({{ site.dcvb_js_api }}capture-vision-router/interfaces/simplified-capture-vision-settings.html): - If the result item types don't match the specified template, the method [`updateSettings`]({{ site.dcvb_js_api }}capture-vision-router/settings.html#updatesettings) will return the error code `EC_PARAMETER_VALUE_INVALID` with the message "The captured result item types do not match the task configurations in the template". - Based on the `capturedResultItemTypes` setting, the irrelevant tasks will be removed from the template. - - The `capturedResultItemTypes` should include at least one of the `CRIT_BARCODE`, `CRIT_TEXT_LINE`, `CRIT_DETECTED_QUAD`, `CRIT_NORMALIZED_IMAGE`. Otherwise, the method [`updateSettings`]({{ site.dcvb_js_api }}capture-vision-router/settings.html#updatesettings) will return the error code `EC_PARAMETER_VALUE_INVALID` with the message "The captured result item types should contain at least one task result type". + - The `capturedResultItemTypes` should include at least one of the `CRIT_BAR_CODE`, `CRIT_TEXT_LINE`, `CRIT_DETECTED_QUAD`, `CRIT_NORMALIZED_IMAGE`. Otherwise, the method [`updateSettings`]({{ site.dcvb_js_api }}capture-vision-router/settings.html#updatesettings) will return the error code `EC_PARAMETER_VALUE_INVALID` with the message "The captured result item types should contain at least one task result type". - Refactored the [`Contour`]({{ site.dcvb_js_api }}core/basic-structures/contour.html) interface. Please view API reference - `Contour` interface for more information. ## 10.0.21 (02/05/2024) #### Improved -- Introduced `dbr.bundle.js` to include packages that are required on running Dynamsoft Barcode Reader to reduce the complexity of the code. +- Introduced `dbr.bundle.js` to include packages that are required to run Dynamsoft Barcode Reader to reduce the complexity of the code. ## 10.0.20 (01/29/2024) @@ -170,7 +165,7 @@ permalink: /programming/javascript/release-notes/js-10.html In this version, the SDK has been refactored under the `DynamsoftCaptureVision` (DCV) architecture. To learn more about the architecture, please see [Architecture of Dynamsoft Capture Vision](https://www.dynamsoft.com/capture-vision/docs/core/architecture/). The following highlights the major changes: -* The class `BarcodeReader` and `BarcodeScanner` are removed and its functionalities are now incorporated into the newly added Class `CaptureVisionRouter`. +* The class `BarcodeReader` and `BarcodeScanner` were removed and their functionalities are now incorporated into the newly added Class `CaptureVisionRouter`. * License-related functions are handled by class [Dynamsoft.License.LicenseManager]({{ site.dcvb_js_api }}license/license-manager.html#initLicense). diff --git a/programming/javascript/release-notes/js-11.md b/programming/javascript/release-notes/js-11.md index 1920391e..cf44fe8b 100644 --- a/programming/javascript/release-notes/js-11.md +++ b/programming/javascript/release-notes/js-11.md @@ -21,7 +21,7 @@ Updated third-party libraries to incorporate the latest security fixes. - Fixed an issue where coordinate conversion could behave abnormally after large images were compressed. - Fixed an issue where abnormal DCEFrame `imageData` could cause errors in the `toCanvas()` method. -### improved +### Improved - Optimized the behavior of the Dynamsoft Camera Enhancer torch and other camera-related features. @@ -154,7 +154,7 @@ Starting with this release, the **Foundational API** (`CaptureVisionRouter` and #### Engineering Optimizations - Optimized the parallel download logic to improve resource loading speed. -- Optimized [adaptive WASM loading logic](../faq/adaptive-wasm-loading.md) to further enhance performance in modern browser environments. +- Optimized [adaptive WASM loading logic](https://www.dynamsoft.com/faq/barcode-reader/web/capabilities/adaptive-wasm-loading.html) to further enhance performance in modern browser environments. ### API Changes @@ -193,7 +193,7 @@ Starting with this release, the **Foundational API** (`CaptureVisionRouter` and - Introduced new samples: - [`Pick One to Fill`](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/scenarios/pick-one-to-fill/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/scenarios/pick-one-to-fill/index.html?utm_source=sampleReadme): Pick one and auto-fill fields by simply opening the camera and scanning a group of barcodes. - - [`Batch Inventory`](https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/main/scenarios/batch-inventory/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/scenarios/batch-inventory/index.html?utm_source=sampleReadme): An inventory management tool scan barcodes in batches and provide real-time analysis of the scanned data. + - [`Batch Inventory`](https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/main/scenarios/batch-inventory/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/scenarios/batch-inventory/index.html?utm_source=sampleReadme): An inventory management tool scans barcodes in batches and provides real-time analysis of the scanned data. - [`Read and Parse GS1-AI`](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/scenarios/read-and-parse-GS1-AI/scan-using-rtu-api/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/scenarios/read-and-parse-GS1-AI/scan-using-rtu-api/index.html?utm_source=sampleReadme): Read GS1 Application Identifier (AI) barcode and parse its structured data. - Template Version Validation: Introduced version checking for templates to prevent compatibility issues and mismatches. @@ -233,9 +233,7 @@ Starting with this release, the **Foundational API** (`CaptureVisionRouter` and - Added several new UI controls (not displayed by default). - - -- Introduced a new `"Scan and Search"` sample to simulate searching for relevant data via barcodes. [Give it a try!](https://demo.dynamsoft.com/Samples/DBR/JS/scenarios/scan-and-search/scan-and-search.html) +- Introduced a new `"Scan and Search"` sample to simulate searching for relevant data via barcodes. [Give it a try!](https://demo.dynamsoft.com/Samples/DBR/JS/scenarios/scan-and-search/index.html) diff --git a/programming/javascript/release-notes/js-7.md b/programming/javascript/release-notes/js-7.md index 138736b7..de499c2f 100644 --- a/programming/javascript/release-notes/js-7.md +++ b/programming/javascript/release-notes/js-7.md @@ -58,7 +58,7 @@ permalink: /programming/javascript/release-notes/js-7.html ### IMPROVED -- The method decodebuffer now uses the pixel format IPF_ABGR_8888 by default. +- The method decodeBuffer now uses the pixel format IPF_ABGR_8888 by default. - Enhanced deformation resistance for QR. - Optimized the algorithm for reading large-size dense QR and DataMatrix. - Optimized the algorithm for 1D barcode deblurring. diff --git a/programming/javascript/release-notes/js-8.md b/programming/javascript/release-notes/js-8.md index 38310895..f145f73a 100644 --- a/programming/javascript/release-notes/js-8.md +++ b/programming/javascript/release-notes/js-8.md @@ -14,7 +14,7 @@ permalink: /programming/javascript/release-notes/js-8.html ## 8.8.7 (01/26/2022) * Added the attribute `muted` to the video embed element so that the video can be played without user interaction. -* Fixed a bug with the property `intervalTime` in `ScanSettings` to avoid unnecesary frame fetching actions. +* Fixed a bug with the property `intervalTime` in `ScanSettings` to avoid unnecessary frame fetching actions. ## 8.8.5 (01/26/2022) @@ -36,7 +36,7 @@ permalink: /programming/javascript/release-notes/js-8.html
* Added a new localization mode `ONED_FAST_SCAN`, which significantly improved the localization speed for 1D barcodes. -* Added the ability to specify barcode `width`, `height`, `angle` to improve the recognition speed if you have advance information about barcodes. +* Added the ability to specify barcode `width`, `height`, `angle` to improve the recognition speed if you have advanced information about barcodes. * Optimized the logic of `confidence` scoring for 2D barcodes. The 2D barcode results with confidence greater than 30 are more accurate.
@@ -62,7 +62,7 @@ The class names of the built-in UI elements have changed | `dbrScanner-bg-camera` | `dce-bg-camera` | | `dbrScanner-video` | `dce-video` | | `dbrScanner-sel-camera` | `dce-sel-camera` | -| `dbrScanner-sel-resolutio` | `dce-sel-resolution` | +| `dbrScanner-sel-resolution` | `dce-sel-resolution` | | `dbrScanner-btn-close` | `dce-btn-close` | ## 8.6.3 (09/30/2021) @@ -244,7 +244,7 @@ Please note that these APIs still exist under `Dynamsoft.DBR.BarcodeReader` , bu ### Fixed -* Fixed a bug where `barcodeFormatString`, `barcodeFormatString_2`, `regionName` and `documentName` don't have value in the `IRT_TYPED_BARCODE_ZONE` intermediate result. +* Fixed a bug where `barcodeFormatString`, `barcodeFormatString_2`, `regionName` and `documentName` don't have value in the `IRT_TYPED_BAR_CODE_ZONE` intermediate result. ## 8.1.0 (01/19/2021) @@ -279,13 +279,13 @@ Please note that these APIs still exist under `Dynamsoft.DBR.BarcodeReader` , bu ### New * Added support for decoding barcodes from an existing video stream. -* Introduced new namespace `Dynamsoft. DBR`. +* Introduced new namespace `Dynamsoft.DBR`. * Implemented a new licensing tracking mechanism, License 2.0, which makes it easier for users to track license usage. * Added a new format control parameter, BarcodeZoneMinDistanceToImageBorders, to set the minimum distance (in pixels) between the barcode zone and image borders. * Added a new format control parameter, MinRatioOfBarcodeZoneWidthToHeight, to set the minimum ratio (width/height) of the barcode zone. * Added a new format control parameter, BarcodeZoneBarCountRangeArray, to set the barcode zone's range of bar count for barcode search. * Added a new argument, SpatialIndexBlockSize, for RPM_GENERAL_RGB_CONTRAST, RPM_GENERAL_GRAY_CONTRAST and RPM_GENERAL_HSV_CONTRAST. -* Added a new parameter, DeblurModes, so users can use different deblur algorithms for different scenarios. DeblurModes has the following enum types: DirectBinarization, ThresholdBinarization, GrayEqulization, Smoothing, Morphing, DeepAnalysis and Sharpening. +* Added a new parameter, DeblurModes, so users can use different deblur algorithms for different scenarios. DeblurModes has the following enum types: DirectBinarization, ThresholdBinarization, GrayEqualization, Smoothing, Morphing, DeepAnalysis and Sharpening. ### Improved diff --git a/programming/javascript/release-notes/js-9.md b/programming/javascript/release-notes/js-9.md index 9c701a9a..bca3b3e1 100644 --- a/programming/javascript/release-notes/js-9.md +++ b/programming/javascript/release-notes/js-9.md @@ -115,7 +115,7 @@ permalink: /programming/javascript/release-notes/js-9.html - Updated the internal `Dynamsoft Camera Enhancer` to [v3.3.1](https://www.dynamsoft.com/camera-enhancer/docs-archive/web/programming/javascript/release-note/release-notes-3.x.html#331-02202023). - The method `decodeBuffer` is updated to accept an additional parameter "orientation" to help specify the orientation of the image data. - The interface `LocalizationResult` is updated to have a new property "transformationMatrix". -- Three missing errorcodes are added: DBR_PANORAMA_LICENSE_INVALID, DBR_PHARMACODE_LICENSE_INVALID, DBR_IMAGE_ORIENTATION_INVALID. Check the full list at [`EnumErrorCode`](https://www.dynamsoft.com/barcode-reader/docs/v9/web/programming/javascript/api-reference/enum/EnumErrorCode.html). +- Three missing error codes are added: DBR_PANORAMA_LICENSE_INVALID, DBR_PHARMACODE_LICENSE_INVALID, DBR_IMAGE_ORIENTATION_INVALID. Check the full list at [`EnumErrorCode`](https://www.dynamsoft.com/barcode-reader/docs/v9/web/programming/javascript/api-reference/enum/EnumErrorCode.html). #### Fixed @@ -158,7 +158,7 @@ permalink: /programming/javascript/release-notes/js-9.html 2. `autoFocus`, when set to `true`, means the SDK will automatically focus on the part of the video where a barcode is found but fails to be read; 3. `autoSuggestTip`, when set to `true`, means the SDK will automatically suggest Tip messages to help guide the user to acquire better video frames for barcode reading. -> These features are only valid when there is a intermediate_results module license. +> These features are only valid when there is an intermediate_results module license. #### Changed @@ -244,7 +244,7 @@ permalink: /programming/javascript/release-notes/js-9.html * Added method `setVideoFit()` to `BarcodeScanner` to allow the video element to either fit or cover the viewer. * Added method `setImageSource()` to `BarcodeReader` to specify an Image Source which provides images of the type `DSImage` for continuous scanning. -* Added methods `startScanning()`, `pauseScanning()`, `resumeScanning()`, `stopScanning()`, `getScanSettings()` and `updateScanSettings()` as well as events `onUniqueRead` and `onImageRead` to `BarcodeReader` to facilitate continous scanning of images coming from the Image Source. +* Added methods `startScanning()`, `pauseScanning()`, `resumeScanning()`, `stopScanning()`, `getScanSettings()` and `updateScanSettings()` as well as events `onUniqueRead` and `onImageRead` to `BarcodeReader` to facilitate continuous scanning of images coming from the Image Source. ## 9.0.0 (03/24/2022) @@ -256,7 +256,7 @@ permalink: /programming/javascript/release-notes/js-9.html * Simplified the license activation steps. Different license activation APIs are integrated into one API. * Added support for **Pharmacode**. -* Added support for **Code 11**, an 1D format. +* Added support for **Code 11**, a 1D format. * Deformation resisting modes `DRM_BROAD_WARP`, `DRM_LOCAL_REFERENCE` and `DRM_DEWRINKLE` are optimized and detached from `DRM_GENERAL`. Users can specify a more effective deformation resisting mode when processing **QRCode** and **DataMatrix codes**. * Optimized the confidence scoring system for **PDF417 codes**. @@ -275,7 +275,6 @@ permalink: /programming/javascript/release-notes/js-9.html * The file **dbr.scanner.html** has been renamed to **dbr.ui.html**. * `dbrScanner-cvs-scanarea` class is now renamed to `dce-scanarea` * `dce-video` is now replaced by `dce-video-container` - * `dbrScanner-scanlight` is now replaced by `dce-scanlight` * `dbrScanner-cvs-drawarea` has been removed The following APIs are renamed: diff --git a/programming/javascript/user-guide/explore-features/index.md b/programming/javascript/user-guide/explore-features/index.md index 3532bce8..8a935d3f 100644 --- a/programming/javascript/user-guide/explore-features/index.md +++ b/programming/javascript/user-guide/explore-features/index.md @@ -36,7 +36,7 @@ While the SDK has been carefully tuned to provide the best possible performance * [Read barcodes with uneven lighting]({{site.features}}read-barcodes-with-uneven-lighting.html?lang=js) * [Read images with texture]({{site.features}}read-images-with-texture.html?lang=js) * [Read images with lots of text]({{site.features}}read-images-with-lots-of-text.html?lang=js) -* [Preprocesss images to read difficult barcodes]({{site.features}}preprocess-images.html?lang=js) +* [Preprocess images to read difficult barcodes]({{site.features}}preprocess-images.html?lang=js) ## Barcode Results @@ -44,7 +44,7 @@ While the SDK has been carefully tuned to provide the best possible performance * [Get barcode location]({{site.features}}get-barcode-location.html?lang=js) * [Get detailed barcode information]({{site.features}}get-detailed-info.html?lang=js) * [Filter and sort decoding results]({{site.features}}filter-and-sort.html?lang=js) - + ## Advanced Features diff --git a/programming/javascript/user-guide/index.md b/programming/javascript/user-guide/index.md index df43daf0..12da73f0 100644 --- a/programming/javascript/user-guide/index.md +++ b/programming/javascript/user-guide/index.md @@ -84,7 +84,7 @@ The complete code of the "Hello World" example is shown below ```

- + Code in Github   @@ -92,7 +92,7 @@ The complete code of the "Hello World" example is shown below Run via JSFiddle   - + Run in Dynamsoft

@@ -137,7 +137,7 @@ The complete code of the "Hello World" example is shown below ### Run the example -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=guide) or test it with [JSFiddle code editor](https://jsfiddle.net/DynamsoftTeam/csm2f9wb/). +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.30&utm_source=guide) or test it with [JSFiddle code editor](https://jsfiddle.net/DynamsoftTeam/csm2f9wb/). 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. @@ -147,11 +147,11 @@ Alternatively, you can test locally by copying and pasting the code shown above > *Secure Contexts*: > -> If you open the web page as `http://` , our SDK may not work correctly because the [MediaDevices: getUserMedia()](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) and other methods only work in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts) (HTTPS, `localhost`, `127.0.0.1`, `file://`), in some or all supporting browsers. +> If you open the web page as `http://`, our SDK may not work correctly because the [MediaDevices: getUserMedia()](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) and other methods only work in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts) (HTTPS, `localhost`, `127.0.0.1`, `file://`), in some or all supporting browsers. > > Regarding configuring https on your server, these guides for [nginx](https://nginx.org/en/docs/http/configuring_https_servers.html) / [IIS](https://aboutssl.org/how-to-create-a-self-signed-certificate-in-iis/) / [tomcat](https://dzone.com/articles/setting-ssl-tomcat-5-minutes) / [nodejs](https://nodejs.org/docs/v0.4.1/api/tls.html) might help. > -> If the test doesn't go as expected, you can [contact us](https://www.dynamsoft.com/company/contact/?ver=11.4.20&utm_source=guide&product=dbr&package=js). +> If the test doesn't go as expected, you can [contact us](https://www.dynamsoft.com/company/contact/?ver=11.4.30&utm_source=guide&product=dbr&package=js). ## Preparing the SDK @@ -205,9 +205,9 @@ Besides using the public CDN, you can also download the SDK and host its files o - From the website - [Download Dynamsoft Barcode Reader JavaScript Package](https://www.dynamsoft.com/barcode-reader/downloads/?ver=11.4.20&utm_source=guide&product=dbr&package=js) + [Download Dynamsoft Barcode Reader JavaScript Package](https://www.dynamsoft.com/barcode-reader/downloads/?ver=11.4.30&utm_source=guide&product=dbr&package=js) - The resources are located at path `dynamsoft-barcode-reader-js-{version-number}/dist/`. + The resources are located at the path `dynamsoft-barcode-reader-js-{version-number}/dist/`. - From npm @@ -229,9 +229,9 @@ You can typically include SDK like this: *Note*: -* Certain legacy web application servers may lack support for the `application/wasm` mimetype for .wasm files. To address this, you have two options: - 1. Upgrade your web application server to one that supports the `application/wasm` mimetype. - 2. Manually define the mimetype on your server. You can refer to the guides for [apache](https://developer.mozilla.org/en-US/docs/Learn/Server-side/Apache_Configuration_htaccess#media_types_and_character_encodings) / [IIS](https://docs.microsoft.com/en-us/iis/configuration/system.webserver/staticcontent/mimemap) / [nginx](https://www.nginx.com/resources/wiki/start/topics/examples/full/#mime-types). +* Certain legacy web application servers may lack support for the `application/wasm` MIME type for .wasm files. To address this, you have two options: + 1. Upgrade your web application server to one that supports the `application/wasm` MIME type. + 2. Manually define the MIME type on your server. You can refer to the guides for [apache](https://developer.mozilla.org/en-US/docs/Learn/Server-side/Apache_Configuration_htaccess#media_types_and_character_encodings) / [IIS](https://docs.microsoft.com/en-us/iis/configuration/system.webserver/staticcontent/mimemap) / [nginx](https://www.nginx.com/resources/wiki/start/topics/examples/full/#mime-types). * To work properly, the SDK requires a few engine files, which are relatively large and may take quite a few seconds to download. We recommend that you set a longer cache time for these engine files, to maximize the performance of your web application. @@ -253,7 +253,7 @@ To enable the SDK's functionality, you must provide a valid license. Utilize the Dynamsoft.License.LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9"); ``` -As previously stated, the key "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" serves as a test license valid for 24 hours, applicable to any newly authorized browser. To test the SDK further, you can request a 30-day free trial license via the Request a Trial License link. +As previously stated, the key "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" serves as a test license valid for 24 hours, applicable to any newly authorized browser. To test the SDK further, you can request a 30-day free trial license via the Request a Trial License link. > Upon registering a Dynamsoft account and obtaining the SDK package from the official website, Dynamsoft will automatically create a 30-day free trial license and embed the corresponding license key into all the provided SDK samples. @@ -272,7 +272,7 @@ CoreModule.engineResourcePaths.rootDirectory = "https://cdn.jsdelivr.net/npm/"; // in pure js Dynamsoft.Core.CoreModule.engineResourcePaths.rootDirectory = "https://cdn.jsdelivr.net/npm/"; ``` -These code uses the jsDelivr CDN as an example, feel free to change it to your own location. +This code uses the jsDelivr CDN as an example, feel free to change it to your own location. ## Using the SDK @@ -655,7 +655,7 @@ DBR requires the following features to work: When deploying your application / website for production, make sure to serve it via a secure HTTPS connection. This is required for two reasons - Access to the camera video stream is only granted in a security context. Most browsers impose this restriction. - > Some browsers like Chrome may grant the access for `http://127.0.0.1` and `http://localhost` or even for pages opened directly from the local disk (`file:///...`). This can be helpful for temporary development and test. + > Some browsers like Chrome may grant access for `http://127.0.0.1` and `http://localhost` or even for pages opened directly from the local disk (`file:///...`). This can be helpful for temporary development and testing. - Dynamsoft License requires a secure context to work. diff --git a/programming/javascript/user-guide/use-in-framework.md b/programming/javascript/user-guide/use-in-framework.md index c426c95f..0fb3831a 100644 --- a/programming/javascript/user-guide/use-in-framework.md +++ b/programming/javascript/user-guide/use-in-framework.md @@ -39,9 +39,9 @@ Assuming you have an existing project using a framework, you should have a `pack } ``` -Notice that there is no `^` before `11.4.3000`. No `^` indicates an exact version, ensuring stability and avoids automatic upgrades even without `package-lock.json`. +Notice that there is no `^` before `11.4.3000`. No `^` indicates an exact version, ensuring stability and avoiding automatic upgrades even without `package-lock.json`. -While we keep the SDK's external interface relatively stable, the SDK's internal communication often change with each new version. These changes can potentially lead to compatibility issues with `engineResourcePaths` settings. To prevent any unexpected difficulties and surprises, it's essential to use the exact version of the SDK. +While we keep the SDK's external interface relatively stable, the SDK's internal communication often changes with each new version. These changes can potentially lead to compatibility issues with `engineResourcePaths` settings. To prevent any unexpected difficulties and surprises, it's essential to use the exact version of the SDK. ## Configuration @@ -138,9 +138,9 @@ async beforeUnmount(){ } ``` -### Reading Barcode from an Uploaded File +### Reading a Barcode from an Uploaded File -In some cases, you might need to read barcode from an uploaded file. Here's how to handle that in your component. +In some cases, you might need to read a barcode from an uploaded file. Here's how to handle that in your component. ```tsx import { EnumCapturedResultItemType } from "dynamsoft-core"; @@ -190,7 +190,7 @@ async captureImage(e: Event){ When decoding barcodes, it's common for users to switch to another component. If you're familiar with handling network requests, you know that this situation is very common. -Here's how we could handle with proper checks to avoid program errors: +Here's how we could handle this with proper checks to avoid program errors: ```ts let isDestroyed = false; @@ -265,7 +265,7 @@ async beforeUnmount(){ ### Set up the video ([CameraView](https://www.dynamsoft.com/camera-enhancer/docs/web/programming/javascript/api-reference/cameraview.html)) container -To render video within a component and handle its lifecycle properly, we can use framework's methods (such as `#` or `ref` or `bind:this`) to get the component's `HTMLDivElement`. This is where the video will be rendered. +To render video within a component and handle its lifecycle properly, we can use framework methods (such as `#` or `ref` or `bind:this`) to get the component's `HTMLDivElement`. This is where the video will be rendered. ```tsx let cameraviewContainer; @@ -310,7 +310,7 @@ async beforeUnmount(){ ### Add [`CaptureVisionRouter`](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module.html) -To complete the code, we'll include the [`CaptureVisionRouter`](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module.html) and handle it's life cycle similarly. +To complete the code, we'll include the [`CaptureVisionRouter`](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module.html) and handle its lifecycle similarly. ```ts import "../dynamsoft.config"; diff --git a/programming/javascript/user-guide/zip-guide.md b/programming/javascript/user-guide/zip-guide.md index 63949afe..6dba6bdb 100644 --- a/programming/javascript/user-guide/zip-guide.md +++ b/programming/javascript/user-guide/zip-guide.md @@ -13,7 +13,7 @@ When deploying your application / website for production, make sure to serve it - Access to the camera video stream is only granted in a security context. Most browsers impose this restriction. - Dynamsoft License requires a secure context to work. -> Some browsers like Chrome may grant access for `http://127.0.0.1` and `http://localhost` or even for pages opened directly from the local disk (`file:///...`). This can be helpful for temporary development and test. +> Some browsers like Chrome may grant access for `http://127.0.0.1` and `http://localhost` or even for pages opened directly from the local disk (`file:///...`). This can be helpful for temporary development and testing. ### Browser Compatibility