From 8b89057372a1e94e9e83bda7a97d74449198e3c6 Mon Sep 17 00:00:00 2001 From: Justin Date: Mon, 13 Jul 2026 10:43:15 +0800 Subject: [PATCH] Refine documentation across multiple modules for clarity and consistency - Updated descriptions in ECISegment class documentation for mobile apps. - Corrected phrasing and grammar in the API reference index for Android, MAUI, and Objective-C/Swift. - Enhanced clarity in FAQ sections regarding CameraX and third-party camera modules. - Improved UI configuration documentation for iOS and clarified installation steps for MAUI. - Fixed minor grammatical errors and improved readability in various user guides and upgrade instructions. --- programming/android/api-reference/eci-segment.md | 2 +- programming/android/api-reference/index.md | 10 +++++----- programming/android/faq/index.md | 9 ++++----- programming/android/user-guide/ui-configurations.md | 2 +- .../user-guide/understand-barcode-scan-results.md | 2 +- programming/flutter/api-reference/index.md | 8 ++++---- programming/maui/api-reference/index.md | 12 ++++++------ programming/maui/faq/common-environment-issues.md | 10 +++++----- programming/maui/faq/index.md | 10 +++++----- programming/maui/upgrade.md | 8 ++++---- programming/maui/user-guide.md | 4 ++-- programming/objectivec-swift/api-reference/index.md | 10 +++++----- programming/objectivec-swift/faq/index.md | 8 ++++---- .../objectivec-swift/migrate-from-v10/index.md | 4 ++-- .../objectivec-swift/migrate-from-v9/index.md | 2 +- programming/objectivec-swift/upgrade.md | 2 +- .../objectivec-swift/user-guide/ui-configurations.md | 4 ++-- programming/react-native/api-reference/index.md | 8 ++++---- 18 files changed, 57 insertions(+), 58 deletions(-) diff --git a/programming/android/api-reference/eci-segment.md b/programming/android/api-reference/eci-segment.md index 2d344455..757565fc 100644 --- a/programming/android/api-reference/eci-segment.md +++ b/programming/android/api-reference/eci-segment.md @@ -1,7 +1,7 @@ --- layout: default-layout title: ECISegment Class - Dynamsoft Barcode Reader Android Edition -description: "Learn what ECISegment does in Dynamsoft Barcode Reader Android API, including its purpose, key data, and how it supports capture workflows for modern web." +description: "Learn what ECISegment does in Dynamsoft Barcode Reader Android API, including its purpose, key data, and how it supports capture workflows for mobile apps." keywords: ECISegment, ECI, character encoding, api reference needAutoGenerateSidebar: true needGenerateH3Content: true diff --git a/programming/android/api-reference/index.md b/programming/android/api-reference/index.md index a767e7bf..df3cb2bc 100644 --- a/programming/android/api-reference/index.md +++ b/programming/android/api-reference/index.md @@ -15,10 +15,10 @@ The Dynamsoft Barcode Reader (DBR) SDK is built on the Dynamsoft Capture Vision

region-def

-

Modules hierarchical of the DBR SDK

+

Module hierarchy of the DBR SDK

-The table below describes details the functionalities of these modules: +The table below describes the functionalities of these modules: | Module | Description | |:-------|:------------| @@ -47,16 +47,16 @@ The main class [`CaptureVisionRouter`]({{ site.dcvb_android_api }}capture-vision The [`ImageSourceAdapter`]({{ site.dcvb_android_api }}core/basic-structures/image-source-adapter.html) class is an abstract class representing an adapter for image sources, providing a framework for fetching, buffering, and managing images from various sources. It serves as the input for the [`CaptureVisionRouter`]({{ site.dcvb_android_api }}capture-vision-router/capture-vision-router.html). You can either use the typical implementations of [`ImageSourceAdapter`]({{ site.dcvb_android_api }}core/basic-structures/image-source-adapter.html) or implement your own. -Class [`CameraEnhancer`]({{ site.dce_android }}primary-api/camera-enhancer.html) is one of the typical implementations of [`ImageSourceAdapter`]({{ site.dcvb_android_api }}core/basic-structures/image-source-adapter.html). It is a class that not only implements the video frame obtaining APIs but also enable you to improve the video quality by adjusting the camera settings. +Class [`CameraEnhancer`]({{ site.dce_android }}primary-api/camera-enhancer.html) is one of the typical implementations of [`ImageSourceAdapter`]({{ site.dcvb_android_api }}core/basic-structures/image-source-adapter.html). It is a class that not only implements the video frame obtaining APIs but also enables you to improve the video quality by adjusting the camera settings. ### Captured Result Receiver To receive the results of video streaming barcode decoding, you need to implement the [`CapturedResultReceiver`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) with the callback method [`onDecodedBarcodesReceived`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html#ondecodedbarcodesreceived). The result you received in the callback method is a [`DecodedBarcodesResult`](decoded-barcodes-result.md) object, which contains all the decoded barcodes from the processed video frame. - [`onDecodedBarcodesReceived`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html#ondecodedbarcodesreceived): The callback method for you to receive the barcode decoding results with a [`DecodedBarcodesResult`](decoded-barcodes-result.md) object. -- [`DecodedBarcodesResult`](decoded-barcodes-result.md): An object that contains all the [`BarcodeResultItem`](barcode-result-item.md) that obtained from a video frame. +- [`DecodedBarcodesResult`](decoded-barcodes-result.md): An object that contains all the [`BarcodeResultItem`](barcode-result-item.md) obtained from a video frame. - [`BarcodeResultItem`](barcode-result-item.md): The basic item that represents a single barcode with the decoded text and other information. ### Camera View -[`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html) is a view class that design for visualizing the real time video streaming and the barcode decoding result. If the [`CameraEnhancer`]({{ site.dce_android }}primary-api/camera-enhancer.html) is set as the input of your CVR, the decoded barcodes will be highlighted automatically on the [`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html). +[`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html) is a view class that is designed for visualizing real-time video streaming and the barcode decoding result. If the [`CameraEnhancer`]({{ site.dce_android }}primary-api/camera-enhancer.html) is set as the input of your CVR, the decoded barcodes will be highlighted automatically on the [`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html). diff --git a/programming/android/faq/index.md b/programming/android/faq/index.md index dd897d87..468fdf17 100644 --- a/programming/android/faq/index.md +++ b/programming/android/faq/index.md @@ -20,7 +20,7 @@ noTitleIndex: false ### CameraX -If you are using the CameraX, you can view [DecodeWithCamerX sample](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/android/FoundationalAPISamples/DecodeWithCameraX) for a quick start. +If you are using the CameraX, you can view [DecodeWithCameraX sample](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/android/FoundationalAPISamples/DecodeWithCameraX) for a quick start. ### Third-Party Camera Module @@ -35,7 +35,7 @@ If you are using a third-party camera module, what you have to do is: Yes, DBR Android can support simulator devices, but in a very limited capacity. If you are only working with existing images in the device's photo library, and there is **no use of the camera whatsoever**, then DBR Android can work just fine on a simulator. -If you are attempting to test the SDK in an interactive video scenario, you will most likely encounter an error that is caused by the camera open command in the code. More specifically, when the Camera Enhancer object call for the camera to open using the [open](https://www.dynamsoft.com/camera-enhancer/docs/mobile/programming/android/primary-api/camera-enhancer.html#open) method. +If you are attempting to test the SDK in an interactive video scenario, you will most likely encounter an error that is caused by the camera open command in the code. More specifically, when the Camera Enhancer object calls for the camera to open using the [open](https://www.dynamsoft.com/camera-enhancer/docs/mobile/programming/android/primary-api/camera-enhancer.html#open) method. Please note that DCE is not compatible with the simulator as the required use of a camera cannot be satisfied via the simulator. @@ -49,7 +49,7 @@ To help troubleshoot whether the method is being called multiple times, we recom ## How can I implement continuous barcode scanning and one-off barcode scanning? -If you `startCapturing` successfully, the program will continuously decode the the video frames from the camera. As a result, you can continuously receive the barcode decoding results. +If you `startCapturing` successfully, the program will continuously decode the video frames from the camera. As a result, you can continuously receive the barcode decoding results. However, if you want to stop the barcode decoding thread, you can call the `stopCapturing` method when a barcode decoding result is received: @@ -84,7 +84,7 @@ If the barcode is not recognized by Dynamsoft Barcode Reader, please do not hesi Alternatively, here is the general troubleshooting steps: 1. Please ensure the lighting is not very bright or very dim. -2. Please ensure the aimming barcode format has been checked on.(Advanced Scan -> settings -> Barcode Format -> check the barcode formats) +2. Please ensure the aiming barcode format has been checked on.(Advanced Scan -> settings -> Barcode Format -> check the barcode formats) 3. We can decrease the Confidence level to increase the read rate.(Advanced Scan -> settings -> Result Settings -> Set Confidence Level to 10) 4. We can increase the deblur level to increase the read rate.(Advanced Scan -> settings -> Additional Settings -> increase DeblurLevel) @@ -234,4 +234,3 @@ public class ProcessBarcodeResultUtil { return processedResult.toString(); } } -``` diff --git a/programming/android/user-guide/ui-configurations.md b/programming/android/user-guide/ui-configurations.md index 8e41e286..a66b2d6c 100644 --- a/programming/android/user-guide/ui-configurations.md +++ b/programming/android/user-guide/ui-configurations.md @@ -17,7 +17,7 @@ In this article, you will learn: ## Preparations -UI configuring APIs are all included in the [CameraView]({{ site.dce_android }}auxiliary-api/dcecameraview.html) class. All the UI configurations are implemented via the `CameraView` instance. You can use the following steps to get prepared for UI configurations. These steps are also mentioned in the [Getting started](../user-guide.md). +UI configuration APIs are included in the [CameraView]({{ site.dce_android }}auxiliary-api/dcecameraview.html) class. All the UI configurations are implemented via the `CameraView` instance. You can use the following steps to get prepared for UI configurations. These steps are also mentioned in the [Getting started](../user-guide.md). ```java import com.dynamsoft.dce.*; diff --git a/programming/android/user-guide/understand-barcode-scan-results.md b/programming/android/user-guide/understand-barcode-scan-results.md index f9f24dcf..1356e342 100644 --- a/programming/android/user-guide/understand-barcode-scan-results.md +++ b/programming/android/user-guide/understand-barcode-scan-results.md @@ -17,7 +17,7 @@ The barcode list is non-empty only when `resultStatus` is `RS_FINISHED`. launcher = registerForActivityResult( new BarcodeScannerActivity.ResultContract(), result -> { - // User code for using the the scan result. + // User code for using the scan result. } ); ``` diff --git a/programming/flutter/api-reference/index.md b/programming/flutter/api-reference/index.md index b6b1c87e..e8bd551d 100644 --- a/programming/flutter/api-reference/index.md +++ b/programming/flutter/api-reference/index.md @@ -16,7 +16,7 @@ This page provides an overview of the various modules and highlights the most es ### Capture Vision Router -The Dynamsoft Capture Vision Router class is the cornerstone of the Dynamsoft Capture Vision (DCV) architecture. It focuses on coordinating batch image processing and provides API for setting up image sources and result receivers, configuring workflows with parameters, and controlling processes. Dynamsoft Capture Vision helps connects the functional products of Dynamsoft under the same umbrella - allowing for easier integration and interchangeable API to control them all. +The Dynamsoft Capture Vision Router class is the cornerstone of the Dynamsoft Capture Vision (DCV) architecture. It focuses on coordinating batch image processing and provides APIs for setting up image sources and result receivers, configuring workflows with parameters, and controlling processes. Dynamsoft Capture Vision helps connect the functional products of Dynamsoft under the same umbrella - allowing for easier integration and interchangeable APIs to control them all. You can find the CaptureVisionRouter API [here]({{ site.dcv_flutter_api }}capture-vision-router/capture-vision-router.html). @@ -24,16 +24,16 @@ This guide focuses on the Barcode Reader functional product. To learn how to use ### Image Source -[`CameraEnhancer`]({{ site.dce_flutter_api }}primary-api/camera-enhancer.html) is a class that not only implements the video frame obtaining APIs but also enable you to improve the video quality by adjusting the camera settings. +[`CameraEnhancer`]({{ site.dce_flutter_api }}primary-api/camera-enhancer.html) is a class that not only implements the video frame obtaining APIs but also enables you to improve the video quality by adjusting the camera settings. ### Captured Result Receiver To receive the results of video streaming barcode decoding, you need to implement the [`CapturedResultReceiver`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result-receiver.html) with the callback method [`onDecodedBarcodesReceived`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result-receiver.html#ondecodedbarcodesreceived). The result you received in the callback method is a [`DecodedBarcodesResult`](barcode-reader/decoded-barcodes-result.md) object, which contains all the decoded barcodes from the processed video frame. - [`onDecodedBarcodesReceived`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result-receiver.html#ondecodedbarcodesreceived): The callback method for you to receive the barcode decoding results with a [`DecodedBarcodesResult`](barcode-reader/decoded-barcodes-result.md) object. -- [`DecodedBarcodesResult`](barcode-reader/decoded-barcodes-result.md): An object that contains all the [`BarcodeResultItem`](barcode-reader/barcode-result-item.md) that obtained from a video frame. +- [`DecodedBarcodesResult`](barcode-reader/decoded-barcodes-result.md): An object that contains all the [`BarcodeResultItem`](barcode-reader/barcode-result-item.md) obtained from a video frame. - [`BarcodeResultItem`](barcode-reader/barcode-result-item.md): The basic item that represents a single barcode with the decoded text and other information. ### Camera View -[`CameraView`]({{ site.dce_flutter_api }}camera-view.html) is a view class that design for visualizing the real time video streaming and the barcode decoding result. If the [`CameraEnhancer`]({{ site.dce_flutter_api }}camera-enhancer.html) is set as the input of your CVR, the decoded barcodes will be highlighted automatically on the [`CameraView`]({{ site.dce_flutter_api }}camera-view.html). +[`CameraView`]({{ site.dce_flutter_api }}camera-view.html) is a view class that is designed for visualizing real-time video streaming and the barcode decoding result. If the [`CameraEnhancer`]({{ site.dce_flutter_api }}camera-enhancer.html) is set as the input of your CVR, the decoded barcodes will be highlighted automatically on the [`CameraView`]({{ site.dce_flutter_api }}camera-view.html). diff --git a/programming/maui/api-reference/index.md b/programming/maui/api-reference/index.md index 884ba48a..7f71eee5 100644 --- a/programming/maui/api-reference/index.md +++ b/programming/maui/api-reference/index.md @@ -1,6 +1,6 @@ --- layout: default-layout -title: Dynamsoft Barcode Reader MAUI API Reference - Main Page +title: Dynamsoft Barcode Reader MAUI API Reference - Main Page description: This is the main page of Dynamsoft Barcode Reader SDK API Reference for MAUI. keywords: api reference, MAUI needAutoGenerateSidebar: true @@ -18,10 +18,10 @@ This page provides an overview of the various modules and highlights the most es

region-def

-

Modules hierarchical of the DBR SDK

+

Module hierarchy of the DBR SDK

-The table below describes details the functionalities of these modules: +The table below describes the functionalities of these modules: | File | Description | |:-----|:------------| @@ -48,11 +48,11 @@ The main class [`CaptureVisionRouter`]({{ site.dcv_maui_api }}capture-vision-rou The [`ImageSourceAdapter`]({{ site.dcv_maui_api }}core/image-source-adapter.html) class is an abstract class representing an adapter for image sources, providing a framework for fetching, buffering, and managing images from various sources. It serves as the input for the [`CaptureVisionRouter`]({{ site.dcv_maui_api }}capture-vision-router/capture-vision-router.html). You can either use the typical implementations of [`ImageSourceAdapter`]({{ site.dcv_maui_api }}core/image-source-adapter.html) or implement your own. -Class [`CameraEnhancer`]({{ site.dce_maui_api }}camera-enhancer.html) is one of the typical implementations of [`ImageSourceAdapter`]({{ site.dcv_maui_api }}core/image-source-adapter.html). It is a class that not only implements the video frame obtaining APIs but also enable you to improve the video quality by adjusting the camera settings. +Class [`CameraEnhancer`]({{ site.dce_maui_api }}camera-enhancer.html) is one of the typical implementations of [`ImageSourceAdapter`]({{ site.dcv_maui_api }}core/image-source-adapter.html). It is a class that not only implements the video frame obtaining APIs but also enables you to improve the video quality by adjusting the camera settings. ### Captured Result Receiver -Implement the callback methods of [`CapturedResultReceiver`]({{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) to receive the corresponding results you required. The callbacks are triggered when the processing of an image/vide frame is finished or timeout. +Implement the callback methods of [`CapturedResultReceiver`]({{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) to receive the corresponding results you require. The callbacks are triggered when the processing of an image/video frame is finished or times out. #### Barcode Decoding @@ -67,4 +67,4 @@ Related APIs: ### Camera View -[`CameraView`]({{ site.dce_maui_api }}auxiliary-api/dcecameraview.html) is a view class that design for visualizing the real time video streaming and the barcode decoding result. If the [`CameraEnhancer`]({{ site.dce_maui_api }}camera-enhancer.html) is set as the input of your CVR, the decoded barcodes will be highlighted automatically on the [`CameraView`]({{ site.dce_maui_api }}auxiliary-api/dcecameraview.html). +[`CameraView`]({{ site.dce_maui_api }}auxiliary-api/dcecameraview.html) is a view class that is designed for visualizing real-time video streaming and the barcode decoding result. If the [`CameraEnhancer`]({{ site.dce_maui_api }}camera-enhancer.html) is set as the input of your CVR, the decoded barcodes will be highlighted automatically on the [`CameraView`]({{ site.dce_maui_api }}auxiliary-api/dcecameraview.html). diff --git a/programming/maui/faq/common-environment-issues.md b/programming/maui/faq/common-environment-issues.md index 3f1d2bad..7d616a23 100644 --- a/programming/maui/faq/common-environment-issues.md +++ b/programming/maui/faq/common-environment-issues.md @@ -1,7 +1,7 @@ --- layout: default-layout title: Common Environment Issues - Dynamsoft Barcode Reader for MAUI -description: This page introduce how to solve common environment issues when using Dynamsoft Barcode Reader MAUI SDK. +description: This page introduces how to solve common environment issues when using Dynamsoft Barcode Reader MAUI SDK. keywords: FAQ, maui, common environment issues needAutoGenerateSidebar: true needGenerateH3Content: true @@ -12,13 +12,13 @@ noTitleIndex: true ## Failed to install -You might get "Could not find a part of the path 'C:\Users\admin\.nuget\packages\dynamsoft.imageprocessing.ios\2.2.300\lib\net7.0-ios16.1\Dynamsoft.ImageProcessing.iOS.resources\DynamsoftImageProcessing.xcframework\ios-arm64\dSYMs\DynamsoftImageProcessing.framework.dSYM\Contents\Resources\DWARF\DynamsoftImageProcessing'" error when installing the package on a **Windows** PC. That's because the Windows system have a limitation of 260 characters in the path. There are 2 ways to solve this: +You might get "Could not find a part of the path 'C:\Users\admin\.nuget\packages\dynamsoft.imageprocessing.ios\2.2.300\lib\net7.0-ios16.1\Dynamsoft.ImageProcessing.iOS.resources\DynamsoftImageProcessing.xcframework\ios-arm64\dSYMs\DynamsoftImageProcessing.framework.dSYM\Contents\Resources\DWARF\DynamsoftImageProcessing'" error when installing the package on a **Windows** PC. That's because the Windows system has a limitation of 260 characters in the path. There are 2 ways to solve this: ### Exclude the iOS platform from the project The long path belongs to the iOS xcframework of the package. If you only want to run Android on Windows, you can use this solution. -Remove iOS platform from you project via the project file. +Remove iOS platform from your project via the project file. ```xml @@ -32,7 +32,7 @@ Remove iOS platform from you project via the project file. ``` -### Add the library via project file instead of **Nuget Package Manager** +### Add the library via project file instead of **NuGet Package Manager** Adding the library via project file can ignore the 260 character limitation but you need some additional steps to complete the installation. @@ -59,7 +59,7 @@ You may find similar issues like: - "not compatible with net8.0-windows10.0.19041" - "not compatible with net8.0-maccatalyst17.2" -Currently, `Dynamsoft.BarcodeReaderBundle.Maui` library doesn't support desktop environment. You have to remove them from your project. +Currently, `Dynamsoft.BarcodeReaderBundle.Maui` library doesn't support desktop environments. You have to remove those target frameworks from your project. ```xml diff --git a/programming/maui/faq/index.md b/programming/maui/faq/index.md index 2686f589..e118b571 100644 --- a/programming/maui/faq/index.md +++ b/programming/maui/faq/index.md @@ -1,7 +1,7 @@ --- layout: default-layout title: Common Environment Issues - Dynamsoft Barcode Reader for MAUI -description: This page introduce how to solve common environment issues when using Dynamsoft Barcode Reader MAUI SDK. +description: This page introduces how to solve common environment issues when using Dynamsoft Barcode Reader MAUI SDK. keywords: FAQ, maui, common environment issues needAutoGenerateSidebar: true needGenerateH3Content: false @@ -12,13 +12,13 @@ noTitleIndex: false ## Failed to install -You might get "Could not find a part of the path 'C:\Users\admin\.nuget\packages\dynamsoft.imageprocessing.ios\2.2.300\lib\net7.0-ios16.1\Dynamsoft.ImageProcessing.iOS.resources\DynamsoftImageProcessing.xcframework\ios-arm64\dSYMs\DynamsoftImageProcessing.framework.dSYM\Contents\Resources\DWARF\DynamsoftImageProcessing'" error when installing the package on a **Windows** PC. That's because the Windows system have a limitation of 260 characters in the path. There are 2 ways to solve this: +You might get "Could not find a part of the path 'C:\Users\admin\.nuget\packages\dynamsoft.imageprocessing.ios\2.2.300\lib\net7.0-ios16.1\Dynamsoft.ImageProcessing.iOS.resources\DynamsoftImageProcessing.xcframework\ios-arm64\dSYMs\DynamsoftImageProcessing.framework.dSYM\Contents\Resources\DWARF\DynamsoftImageProcessing'" error when installing the package on a **Windows** PC. That's because the Windows system has a limitation of 260 characters in the path. There are 2 ways to solve this: ### Exclude the iOS platform from the project The long path belongs to the iOS xcframework of the package. If you only want to run Android on Windows, you can use this solution. -Remove iOS platform from you project via the project file. +Remove iOS platform from your project via the project file. ```xml @@ -32,7 +32,7 @@ Remove iOS platform from you project via the project file. ``` -### Add the library via project file instead of **Nuget Package Manager** +### Add the library via project file instead of **NuGet Package Manager** Adding the library via project file can ignore the 260 character limitation but you need some additional steps to complete the installation. @@ -59,7 +59,7 @@ You may find similar issues like: - "not compatible with net8.0-windows10.0.19041" - "not compatible with net8.0-maccatalyst17.2" -Currently, `Dynamsoft.BarcodeReaderBundle.Maui` library doesn't support desktop environment. You have to remove them from your project. +Currently, `Dynamsoft.BarcodeReaderBundle.Maui` library doesn't support desktop environments. You have to remove those target frameworks from your project. ```xml diff --git a/programming/maui/upgrade.md b/programming/maui/upgrade.md index ea4fb276..b5aecb96 100644 --- a/programming/maui/upgrade.md +++ b/programming/maui/upgrade.md @@ -17,7 +17,7 @@ pageStartVer: 10.0 #### Visual Studio for Mac -In the **NuGet Package Manager>Manage Packages for Solution** of your project, search for **Dynamsoft.BarcodeReaderBundle.Maui**. Select the latest version and click **install**. +In the **NuGet Package Manager > Manage Packages for Solution** of your project, search for **Dynamsoft.BarcodeReaderBundle.Maui**. Select the latest version and click **install**. #### Visual Studio for Windows @@ -43,9 +43,9 @@ You need to add the library via the project file and complete additional steps f
> - > - Please view [user guide](user-guide.md#option-1-add-the-library-via-maven) for the correct version number. - > - Windows system have a limitation of 260 characters in the path. If you don't use console to install the package, you will receive error "Could not find a part of the path 'C:\Users\admin\.nuget\packages\dynamsoft.imageprocessing.ios\2.4.300\lib\net7.0-ios16.1\Dynamsoft.ImageProcessing.iOS.resources\DynamsoftImageProcessing.xcframework\ios-arm64\dSYMs\DynamsoftImageProcessing.framework.dSYM\Contents\Resources\DWARF\DynamsoftImageProcessing'" - > - The library only support Android & iOS platform. Be sure that you remove the other platforms like Windows, maccatalyst, etc. + > - Please view [user guide](user-guide.md#visual-studio-for-windows) for the correct version number. + > - Windows system has a limitation of 260 characters in the path. If you don't use console to install the package, you will receive an error "Could not find a part of the path 'C:\Users\admin\.nuget\packages\dynamsoft.imageprocessing.ios\2.4.300\lib\net7.0-ios16.1\Dynamsoft.ImageProcessing.iOS.resources\DynamsoftImageProcessing.xcframework\ios-arm64\dSYMs\DynamsoftImageProcessing.framework.dSYM\Contents\Resources\DWARF\DynamsoftImageProcessing'" + > - The library only supports Android and iOS platforms. Be sure that you remove the other platforms like Windows, maccatalyst, etc. ### Update the Template File diff --git a/programming/maui/user-guide.md b/programming/maui/user-guide.md index d0e71d15..07ef9de4 100644 --- a/programming/maui/user-guide.md +++ b/programming/maui/user-guide.md @@ -86,8 +86,8 @@ You need to add the library via the project file and complete additional steps f
> -> - Windows system have a limitation of 260 characters in the path. If you don't use console to install the package, you will receive error "Could not find a part of the path 'C:\Users\admin\.nuget\packages\dynamsoft.imageprocessing.ios\2.4.300\lib\net7.0-ios16.1\Dynamsoft.ImageProcessing.iOS.resources\DynamsoftImageProcessing.xcframework\ios-arm64\dSYMs\DynamsoftImageProcessing.framework.dSYM\Contents\Resources\DWARF\DynamsoftImageProcessing'" -> - The library only support Android & iOS platform. Be sure that you remove the other platforms like Windows, maccatalyst, etc. +> - Windows system has a limitation of 260 characters in the path. If you don't use console to install the package, you will receive an error "Could not find a part of the path 'C:\Users\admin\.nuget\packages\dynamsoft.imageprocessing.ios\2.4.300\lib\net7.0-ios16.1\Dynamsoft.ImageProcessing.iOS.resources\DynamsoftImageProcessing.xcframework\ios-arm64\dSYMs\DynamsoftImageProcessing.framework.dSYM\Contents\Resources\DWARF\DynamsoftImageProcessing'" +> - The library only supports Android and iOS platforms. Be sure that you remove the other platforms like Windows, maccatalyst, etc. ## Build Your Barcode Scanner App diff --git a/programming/objectivec-swift/api-reference/index.md b/programming/objectivec-swift/api-reference/index.md index 2f0f19ed..259e14e5 100644 --- a/programming/objectivec-swift/api-reference/index.md +++ b/programming/objectivec-swift/api-reference/index.md @@ -15,10 +15,10 @@ The Dynamsoft Barcode Reader (DBR) SDK is built on the Dynamsoft Capture Vision

region-def

-

Modules hierarchical of the DBR SDK

+

Module hierarchy of the DBR SDK

-The table below describes details the functionalities of these modules: +The table below describes the functionalities of these modules: | File | Description | |:-----|:------------| @@ -47,16 +47,16 @@ The main class [`DSCaptureVisionRouter`]({{ site.dcvb_ios_api }}capture-vision-r The [`DSImageSourceAdapter`]({{ site.dcvb_ios_api }}core/basic-structures/image-source-adapter.html) class is an abstract class representing an adapter for image sources, providing a framework for fetching, buffering, and managing images from various sources. It serves as the input for the [`DSCaptureVisionRouter`]({{ site.dcvb_ios_api }}capture-vision-router/capture-vision-router.html). You can either use the typical implementations of [`DSImageSourceAdapter`]({{ site.dcvb_ios_api }}core/basic-structures/image-source-adapter.html) or implement your own. -Class [`DSCameraEnhancer`]({{ site.dce_ios }}primary-api/camera-enhancer.html) is one of the typical implementations of [`DSImageSourceAdapter`]({{ site.dcvb_ios_api }}core/basic-structures/image-source-adapter.html). It is a class that not only implements the video frame obtaining APIs but also enable you to improve the video quality by adjusting the camera settings. +Class [`DSCameraEnhancer`]({{ site.dce_ios }}primary-api/camera-enhancer.html) is one of the typical implementations of [`DSImageSourceAdapter`]({{ site.dcvb_ios_api }}core/basic-structures/image-source-adapter.html). It is a class that not only implements the video frame obtaining APIs but also enables you to improve the video quality by adjusting the camera settings. ### Captured Result Receiver To receive the results of video streaming barcode decoding, you need to implement the [`DSCapturedResultReceiver`]({{ site.dcvb_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) with the callback method [`onDecodedBarcodesReceived`]({{ site.dcvb_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html#ondecodedbarcodesreceived). The result you received in the callback method is a [`DSDecodedBarcodesResult`](decoded-barcodes-result.md) object, which contains all the decoded barcodes from the processed video frame. - [`onDecodedBarcodesReceived`]({{ site.dcvb_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html#ondecodedbarcodesreceived): The callback method for you to receive the barcode decoding results with a [`DSDecodedBarcodesResult`](decoded-barcodes-result.md) object. -- [`DSDecodedBarcodesResult`](decoded-barcodes-result.md): An object that contains all the [`DSBarcodeResultItem`](barcode-result-item.md) that obtained from a video frame. +- [`DSDecodedBarcodesResult`](decoded-barcodes-result.md): An object that contains all the [`DSBarcodeResultItem`](barcode-result-item.md) obtained from a video frame. - [`DSBarcodeResultItem`](barcode-result-item.md): The basic item that represents a single barcode with the decoded text and other information. ### Camera View -[`DSCameraView`]({{ site.dce_ios }}auxiliary-api/dcecameraview.html) is a view class that design for visualizing the real time video streaming and the barcode decoding result. If the [`DSCameraEnhancer`]({{ site.dce_ios }}primary-api/camera-enhancer.html) is set as the input of your CVR, the decoded barcodes will be highlighted automatically on the [`DSCameraView`]({{ site.dce_ios }}auxiliary-api/dcecameraview.html). +[`DSCameraView`]({{ site.dce_ios }}auxiliary-api/dcecameraview.html) is a view class that is designed for visualizing real-time video streaming and the barcode decoding result. If the [`DSCameraEnhancer`]({{ site.dce_ios }}primary-api/camera-enhancer.html) is set as the input of your CVR, the decoded barcodes will be highlighted automatically on the [`DSCameraView`]({{ site.dce_ios }}auxiliary-api/dcecameraview.html). diff --git a/programming/objectivec-swift/faq/index.md b/programming/objectivec-swift/faq/index.md index 62191873..6440b933 100644 --- a/programming/objectivec-swift/faq/index.md +++ b/programming/objectivec-swift/faq/index.md @@ -20,7 +20,7 @@ noTitleIndex: false ### AVCaptureSession -If you are using the CameraX, you can view [HelloWorld/DecodeWithAVCaptureSession sample](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/ios/FoundationalAPISamples/DecodeWithAVCaptureSession) for a quick start. +If you are using the AVCaptureSession, you can view [HelloWorld/DecodeWithAVCaptureSession sample](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/ios/FoundationalAPISamples/DecodeWithAVCaptureSession) for a quick start. ### Third-Party Camera Module @@ -35,7 +35,7 @@ If you are using a third-party camera module, what you have to do is: Yes, Dynamsoft Barcode Reader iOS can support simulator devices, but in a very limited capacity. If you are only working with existing images in the device's photo library, and there is **no use of the camera whatsoever**, then DBR iOS can work just fine on a simulator. -If you are attempting to test the SDK in an interactive video scenario, you will most likely encounter a UI unresponsiveness error that is caused by the camera open command in the code. More specifically, when the Camera Enhancer object call for the camera to open using the [open](https://www.dynamsoft.com/camera-enhancer/docs/mobile/programming/ios/primary-api/camera-enhancer.html#open) method. +If you are attempting to test the SDK in an interactive video scenario, you will most likely encounter a UI unresponsiveness error that is caused by the camera open command in the code. More specifically, when the Camera Enhancer object calls for the camera to open using the [open](https://www.dynamsoft.com/camera-enhancer/docs/mobile/programming/ios/primary-api/camera-enhancer.html#open) method. If you have a Mac M1 machine (or a later model) then you can test your application on the Mac M1 machine directly via Xcode. In order to do that, please select *My Mac (designed for iPhone/iPad)* in the dropdown menu when selecting the target device. @@ -43,7 +43,7 @@ If you have a Mac M1 machine (or a later model) then you can test your applicati Before a barcode reader instance can be created, a one-time connection for license validation needs to occur when the app initializes (or whenever the license is set before the barcode reader instance creation). Sometimes, this license validation could take a second to complete. -A potential "freeze" of the page can occur if [`LicenseManager.initLicense()`]({{ site.dcvb_ios_api }}license/license-manager.html#initlicense) is called multiple times in a single process. For example, we have seen some Swift users call `initLicense` both in the ViewController file as well as AppDelegate. We recommend doing it in the AppDelegate file, and as long at it is not called in both files, then the implementation should be fine. +A potential "freeze" of the page can occur if [`LicenseManager.initLicense()`]({{ site.dcvb_ios_api }}license/license-manager.html#initlicense) is called multiple times in a single process. For example, we have seen some Swift users call `initLicense` both in the ViewController file as well as AppDelegate. We recommend doing it in the AppDelegate file, and as long as it is not called in both files, then the implementation should be fine. Please make sure that `initLicense` is called only once in your code. @@ -57,7 +57,7 @@ For a continuous video scanning scenario, configure the [minImageCaptureInterval ## How can I implement continuous barcode scanning and one-off barcode scanning? -If you `startCapturing` successfully, the program will continuously decode the the video frames from the camera. As a result, you can continuously receive the barcode decoding results. +If you `startCapturing` successfully, the program will continuously decode the video frames from the camera. As a result, you can continuously receive the barcode decoding results. However, if you want to stop the barcode decoding thread, you can call the `stopCapturing` method when a barcode decoding result is received: diff --git a/programming/objectivec-swift/migrate-from-v10/index.md b/programming/objectivec-swift/migrate-from-v10/index.md index 5e26c5a1..142137cf 100644 --- a/programming/objectivec-swift/migrate-from-v10/index.md +++ b/programming/objectivec-swift/migrate-from-v10/index.md @@ -51,7 +51,7 @@ There are three ways in which you can include the `DynamsoftBarcodeReaderBundle` ```
- > Please view [user guide](user-guide.md#option-1-add-the-library-via-maven) for the correct version number. + > Please view [user guide](user-guide.md#option-2-add-the-frameworks-via-cocoapods) for the correct version number. 2. Execute the pod command to install the frameworks and generate workspace(**[TargetName].xcworkspace**): @@ -73,4 +73,4 @@ There are three ways in which you can include the `DynamsoftBarcodeReaderBundle` ## Update the Template File -If you are using a template file, please use the [online template converter](https://www.dynamsoft.com/tools/template-upgrade/) to convert it to the latest version. +If you are using a template file, please use the [online template converter](https://www.dynamsoft.com/tools/template-upgrade/) to convert it to the latest version. diff --git a/programming/objectivec-swift/migrate-from-v9/index.md b/programming/objectivec-swift/migrate-from-v9/index.md index 977cd5ef..c5eb5d43 100644 --- a/programming/objectivec-swift/migrate-from-v9/index.md +++ b/programming/objectivec-swift/migrate-from-v9/index.md @@ -58,7 +58,7 @@ There are three ways in which you can include the `DynamsoftBarcodeReaderBundle` ```
- > Please view [user guide](user-guide.md#option-1-add-the-library-via-maven) for the correct version number. + > Please view [user guide](user-guide.md#option-2-add-the-frameworks-via-cocoapods) for the correct version number. 2. Execute the pod command to install the frameworks and generate workspace(**[TargetName].xcworkspace**): diff --git a/programming/objectivec-swift/upgrade.md b/programming/objectivec-swift/upgrade.md index 0fe6a1f4..b3896049 100644 --- a/programming/objectivec-swift/upgrade.md +++ b/programming/objectivec-swift/upgrade.md @@ -41,7 +41,7 @@ There are three ways in which you can include the `DynamsoftBarcodeReaderBundle` ```
- > Please view [user guide](user-guide.md#option-1-add-the-library-via-maven) for the correct version number. + > Please view [user guide](user-guide.md#option-2-add-the-frameworks-via-cocoapods) for the correct version number. 2. Execute the pod command to install the frameworks and generate workspace(**[TargetName].xcworkspace**): diff --git a/programming/objectivec-swift/user-guide/ui-configurations.md b/programming/objectivec-swift/user-guide/ui-configurations.md index f7b03ae9..08b327a7 100644 --- a/programming/objectivec-swift/user-guide/ui-configurations.md +++ b/programming/objectivec-swift/user-guide/ui-configurations.md @@ -1,7 +1,7 @@ --- layout: default-layout title: UI Configurations - Dynamsoft Barcode Reader for iOS -description: LLearn how to add basic UI elements on the DCECameraView for iOS edition. +description: Learn how to add basic UI elements on the DCECameraView for iOS edition. keywords: UI Configurations, iOS needAutoGenerateSidebar: true needGenerateH3Content: true @@ -19,7 +19,7 @@ In this article, you will learn: ## Introduction -UI configurations APIs are all included in the [CameraView]({{site.dce_ios}}auxiliary-api/dcecameraview.html) class. All the UI configurations are implemented via the CameraView instance. You can use the following steps to get prepared for UI configurations. These steps are also mentioned in the [Getting started](../user-guide.md). +UI configuration APIs are included in the [CameraView]({{site.dce_ios}}auxiliary-api/dcecameraview.html) class. All the UI configurations are implemented via the CameraView instance. You can use the following steps to get prepared for UI configurations. These steps are also mentioned in the [Getting started](../user-guide.md).
>- Objective-C diff --git a/programming/react-native/api-reference/index.md b/programming/react-native/api-reference/index.md index 971e4fd2..225e9b4a 100644 --- a/programming/react-native/api-reference/index.md +++ b/programming/react-native/api-reference/index.md @@ -16,7 +16,7 @@ This page provides an overview of the various modules and highlights the most es ### Capture Vision Router -The Dynamsoft Capture Vision Router class is the cornerstone of the Dynamsoft Capture Vision (DCV) architecture. It focuses on coordinating batch image processing and provides API for setting up image sources and result receivers, configuring workflows with parameters, and controlling processes. Dynamsoft Capture Vision helps connects the functional products of Dynamsoft under the same umbrella - allowing for easier integration and interchangeable API to control them all. +The Dynamsoft Capture Vision Router class is the cornerstone of the Dynamsoft Capture Vision (DCV) architecture. It focuses on coordinating batch image processing and provides APIs for setting up image sources and result receivers, configuring workflows with parameters, and controlling processes. Dynamsoft Capture Vision helps connect the functional products of Dynamsoft under the same umbrella - allowing for easier integration and interchangeable APIs to control them all. You can find the CaptureVisionRouter API [here]({{ site.dcv_react_native_api }}capture-vision-router/capture-vision-router.html). @@ -24,16 +24,16 @@ This guide focuses on the Barcode Reader functional product. To learn how to use ### Image Source -[`CameraEnhancer`]({{ site.dce_react_native_api }}camera-enhancer.html) is a class that not only implements the video frame obtaining APIs but also enable you to improve the video quality by adjusting the camera settings. +[`CameraEnhancer`]({{ site.dce_react_native_api }}camera-enhancer.html) is a class that not only implements the video frame obtaining APIs but also enables you to improve the video quality by adjusting the camera settings. ### Captured Result Receiver To receive the results of video streaming barcode decoding, you need to implement the [`CapturedResultReceiver`]({{ site.dcv_react_native_api }}capture-vision-router/captured-result-receiver.html) with the callback method [`onDecodedBarcodesReceived`]({{ site.dcv_react_native_api }}capture-vision-router/captured-result-receiver.html#ondecodedbarcodesreceived). The result you received in the callback method is a [`DecodedBarcodesResult`](barcode-reader/decoded-barcodes-result.md) object, which contains all the decoded barcodes from the processed video frame. - [`onDecodedBarcodesReceived`]({{ site.dcv_react_native_api }}capture-vision-router/captured-result-receiver.html#ondecodedbarcodesreceived): The callback method for you to receive the barcode decoding results with a [`DecodedBarcodesResult`](barcode-reader/decoded-barcodes-result.md) object. -- [`DecodedBarcodesResult`](barcode-reader/decoded-barcodes-result.md): An object that contains all the [`BarcodeResultItem`](barcode-reader/barcode-result-item.md) that obtained from a video frame. +- [`DecodedBarcodesResult`](barcode-reader/decoded-barcodes-result.md): An object that contains all the [`BarcodeResultItem`](barcode-reader/barcode-result-item.md) obtained from a video frame. - [`BarcodeResultItem`](barcode-reader/barcode-result-item.md): The basic item that represents a single barcode with the decoded text and other information. ### Camera View -[`CameraView`]({{ site.dce_react_native_api }}camera-view.html) is a view class that design for visualizing the real time video streaming and the barcode decoding result. If the [`CameraEnhancer`]({{ site.dce_react_native_api }}camera-enhancer.html) is set as the input of your CVR, the decoded barcodes will be highlighted automatically on the [`CameraView`]({{ site.dce_react_native_api }}camera-view.html). +[`CameraView`]({{ site.dce_react_native_api }}camera-view.html) is a view class that is designed for visualizing real-time video streaming and the barcode decoding result. If the [`CameraEnhancer`]({{ site.dce_react_native_api }}camera-enhancer.html) is set as the input of your CVR, the decoded barcodes will be highlighted automatically on the [`CameraView`]({{ site.dce_react_native_api }}camera-view.html).