Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion programming/android/api-reference/eci-segment.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
10 changes: 5 additions & 5 deletions programming/android/api-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ The Dynamsoft Barcode Reader (DBR) SDK is built on the Dynamsoft Capture Vision

<div align="center">
<p><img src="../../assets/dcv-dbr-dependency.png" width="70%" alt="region-def"></p>
<p>Modules hierarchical of the DBR SDK</p>
<p>Module hierarchy of the DBR SDK</p>
</div>

The table below describes details the functionalities of these modules:
The table below describes the functionalities of these modules:

| Module | Description |
|:-------|:------------|
Expand Down Expand Up @@ -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).
9 changes: 4 additions & 5 deletions programming/android/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

Expand All @@ -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:

Expand Down Expand Up @@ -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)

Expand Down Expand Up @@ -234,4 +234,3 @@ public class ProcessBarcodeResultUtil {
return processedResult.toString();
}
}
```
2 changes: 1 addition & 1 deletion programming/android/user-guide/ui-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.*;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
}
);
```
Expand Down
8 changes: 4 additions & 4 deletions programming/flutter/api-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,24 @@ 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).

This guide focuses on the Barcode Reader functional product. To learn how to use the foundational Capture Vision API to set up and run the Barcode Reader, please refer to the [User Guide (Foundational Edition)]({{ site.dbr_flutter }}foundational-user-guide.html).

### 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).
12 changes: 6 additions & 6 deletions programming/maui/api-reference/index.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -18,10 +18,10 @@ This page provides an overview of the various modules and highlights the most es

<div align="center">
<p><img src="../../assets/dcv-dbr-dependency.png" width="70%" alt="region-def"></p>
<p>Modules hierarchical of the DBR SDK</p>
<p>Module hierarchy of the DBR SDK</p>
</div>

The table below describes details the functionalities of these modules:
The table below describes the functionalities of these modules:

| File | Description |
|:-----|:------------|
Expand All @@ -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

Expand All @@ -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).
10 changes: 5 additions & 5 deletions programming/maui/faq/common-environment-issues.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
<PropertyGroup>
Expand All @@ -32,7 +32,7 @@ Remove iOS platform from you project via the project file.
</PropertyGroup>
```

### 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.

Expand All @@ -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
<PropertyGroup>
Expand Down
Loading