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 faq/can-i-build-ios-for-armv7.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default-layout
title: Can I build an iOS app for armv7?
keywords: Dynamsoft Barcode Reader, FAQ, IOS, Mobile, building error, archetecture, armv7
keywords: Dynamsoft Barcode Reader, FAQ, iOS, Mobile, building error, architecture, armv7
description: Can I build an iOS app for armv7?
needAutoGenerateSidebar: false
---
Expand Down
10 changes: 5 additions & 5 deletions faq/exclude-architectures.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: default-layout
title: How to fix building errors related to IOS archetecture?
keywords: Dynamsoft Barcode Reader, FAQ, IOS, Mobile, building error, archetecture, arm64
description: How to fix building errors related to IOS archetecture?
title: How to fix building errors related to iOS architecture?
keywords: Dynamsoft Barcode Reader, FAQ, iOS, Mobile, building error, architecture, arm64
description: How to fix building errors related to iOS architecture?
needAutoGenerateSidebar: false
noTitleIndex: true
breadcrumbText: Exclude Architecture
Expand All @@ -12,7 +12,7 @@ breadcrumbText: Exclude Architecture

[<< Back to FAQ index](index.md)

Dynamsoft framework can be used to build an app for arm64 iOS. If you build the app for arm64 simulator and you are migrate your app from older versions to Xcode 12 or higher, the following error message may pops up:
Dynamsoft framework can be used to build an app for arm64 iOS. If you build the app for arm64 simulator and you are migrating your app from older versions to Xcode 12 or higher, the following error message may pop up:

> ld: "Building for iOS Simulator, but linking in dylib built for iOS, file '/ios/Pods/DynamsoftBarcodeReader/DynamsoftBarcodeReader.xcframework/DynamsoftBarcodeReader' for architecture arm64"

Expand All @@ -21,7 +21,7 @@ Dynamsoft framework can be used to build an app for arm64 iOS. If you build the
**To fix the error:**

1. Set *Build Settings* > *Build Options* > *VALIDATE_WORKSPACE* to "YES" and then rebuild your project
2. Set *Build Settings* > *Archetectures* > *Build Active Architecture Only* to "YES" and choose iPhone device run
2. Set *Build Settings* > *Architectures* > *Build Active Architecture Only* to "YES" and run on an iPhone device
3. Set *Build Settings* > *Architectures* -> $(ARCHS_STANDARD)

<br />
Expand Down
2 changes: 1 addition & 1 deletion faq/net-maui-support.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default-layout
title: Does DCV support .NET MAUI?
keywords: Dynamsoft Barcode Reader, FAQ, IOS, Android, Mobile, building error, archetecture, arm64
keywords: Dynamsoft Barcode Reader, FAQ, iOS, Android, Mobile, building error, architecture, arm64
description: Does DCV support .NET MAUI?
needAutoGenerateSidebar: false
noTitleIndex: true
Expand Down
4 changes: 2 additions & 2 deletions faq/proguard.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ breadcrumbText: Add Proguard

This page provides you a possible solution when your project build fails after implementing the code obfuscation.

Generally, you dont have to add any configurations when shrinking your code because proguard rule is already configured in the library. If you still build failed after shrinking code, you can try enabling proguard in your project and add the following code in your **proguard_xamarin.cfg** file.
Generally, you don't have to add any configurations when shrinking your code because ProGuard rules are already configured in the library. If your build still fails after shrinking code, you can try enabling ProGuard in your project and add the following code in your **proguard_xamarin.cfg** file.

```bash
-keepclasseswithmembernames class * {
Expand All @@ -24,4 +24,4 @@ Generally, you don’t have to add any configurations when shrinking your code b
-keep class com.dynamsoft.dce.** { *; }
```

You can view the <a href="https://learn.microsoft.com/en-us/xamarin/android/deploy-test/release-prep/proguard?tabs=macos" target="_blank">official documents</a> for how to enable proguard.
You can view the <a href="https://learn.microsoft.com/en-us/xamarin/android/deploy-test/release-prep/proguard?tabs=macos" target="_blank">official documents</a> for how to enable ProGuard.
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ ImageSourceAdapter getInput();

**Return Value**

The `ImageSourceAdapter` object that is bind with this `CaptureVisionRouter` object.
The `ImageSourceAdapter` object that is bound to this `CaptureVisionRouter` object.

## addResultReceiver

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default-layout
title: Vector4 - Dynamsoft Capture Vision Android Edition API Reference
description: The class Vector4 of Dynamsoft Capture Vision Android represents a a four-dimensional vector.
description: The class Vector4 of Dynamsoft Capture Vision Android represents a four-dimensional vector.
keywords: vector4, Java, Kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
Expand Down
18 changes: 9 additions & 9 deletions programming/android/api-reference/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default-layout
title: Dynamsoft Capture Vision Android API Reference - Main Page
title: Dynamsoft Capture Vision Android API Reference - Main Page
description: This is the main page of Dynamsoft Capture Vision SDK API Reference for Android.
keywords: api reference, Android
needAutoGenerateSidebar: true
Expand All @@ -18,7 +18,7 @@ This page provides an overview of the various modules and highlights the most es

<div align="center">
<p><img src="../../../assets/img/dcv-dependencies.png" width="70%" alt="dependencies"></p>
<p>Modules hierarchical of the DCV SDK</p>
<p>Module hierarchy of the DCV SDK</p>
</div>

The table below describes details the functionalities of these modules:
Expand All @@ -27,7 +27,7 @@ The table below describes details the functionalities of these modules:
|:-----|:------------|
| `DynamsoftCaptureVisionRouter` (CVR) | The Dynamsoft Capture Vision Router module 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. |
| `DynamsoftBarcodeReader`(DBR) | The Dynamsoft Barcode Reader module recognizes and decodes multiple barcode formats such as QR codes, Code 39, Code 128, and Data Matrix, among many others. |
| `DynamsoftDocumentNormalizer`(DBR) | The Dynamsoft Document Normalizer module extracts structural information from document images, including document boundaries, shadow areas, and text areas. It uses this information to generate normalized document images through processes such as deskewing, shadow removal, and distortion correction. |
| `DynamsoftDocumentNormalizer`(DDN) | The Dynamsoft Document Normalizer module extracts structural information from document images, including document boundaries, shadow areas, and text areas. It uses this information to generate normalized document images through processes such as deskewing, shadow removal, and distortion correction. |
| `DynamsoftLabelRecognizer` (DLR) | The Dynamsoft Label Recognizer module identifies and recognizes text labels such as passport MRZs, ID cards, and VIN numbers. |
| `DynamsoftCore` (Core) | The Dynamsoft Core module lays the foundation for Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. It encapsulates the basic classes, interfaces, and enumerations shared by these SDKs.|
| `DynamsoftImageProcessing` (DIP) | The Dynamsoft Image Processing module facilitates digital image processing and supports operations for other modules, including the Barcode Reader, Label Recognizer, and Document Normalizer. |
Expand All @@ -53,11 +53,11 @@ The main class [`CaptureVisionRouter`]({{ site.dcv_android_api }}capture-vision-

The [`ImageSourceAdapter`]({{ site.dcv_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.dcv_android_api }}capture-vision-router/capture-vision-router.html). You can either use the typical implementations of [`ImageSourceAdapter`]({{ site.dcv_android_api }}core/basic-structures/image-source-adapter.html) or implement your own.

Class [`CameraEnhancer`]({{ site.dce_android_api }}primary-api/camera-enhancer.html) is one of the typical implementations of [`ImageSourceAdapter`]({{ site.dcv_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_api }}primary-api/camera-enhancer.html) is one of the typical implementations of [`ImageSourceAdapter`]({{ site.dcv_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

Implement the callback methods of [`CapturedResultReceiver`]({{ site.dcv_android_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_android_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/video frame is finished or times out.

#### Barcode Decoding

Expand All @@ -67,7 +67,7 @@ Callback methods that are related to barcode decoding:

Related APIs:

- [`DecodedBarcodesResult`]({{ site.dbr_android_api }}decoded-barcodes-result.html): All barcodes that decoded from the processed image.
- [`DecodedBarcodesResult`]({{ site.dbr_android_api }}decoded-barcodes-result.html): All barcodes that were decoded from the processed image.
- [`BarcodeResultItem`]({{ site.dbr_android_api }}barcode-result-item.html): The barcode decoding result of a single barcode.

#### Document Scanning
Expand All @@ -92,11 +92,11 @@ Callback methods that are related to MRZ scanning:

Related APIs:

- [`ParsedResult`]({{ site.dcp_android_api }}parsed-result.html): All parsed results that captured from the processed image.
- [`ParsedResult`]({{ site.dcp_android_api }}parsed-result.html): All parsed results that were captured from the processed image.
- [`ParsedResultItem`]({{ site.dcp_android_api }}parsed-result-item.html): The parsing result of a single parsable content.
- [`RecognizedTextLinesResult`]({{ site.dlr_android_api }}recognized-text-lines-result.html): All text lines that recognized from the processed image.
- [`RecognizedTextLinesResult`]({{ site.dlr_android_api }}recognized-text-lines-result.html): All text lines that were recognized from the processed image.
- [`TextLineResultItem`]({{ site.dlr_android_api }}text-line-result-item.html): The text recognition result of a single text line.

### Camera View

[`CameraView`]({{ site.dce_android_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_android_api }}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_api }}auxiliary-api/dcecameraview.html).
[`CameraView`]({{ site.dce_android_api }}auxiliary-api/dcecameraview.html) is a view class that is designed for visualizing the real time video streaming and the barcode decoding result. If the [`CameraEnhancer`]({{ site.dce_android_api }}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_api }}auxiliary-api/dcecameraview.html).
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default-layout
title: ImageProcessor - Dynamsoft Capture Vision Android Edition API Reference
description: The class ImageProcessor of Dynamsoft Capture Vision Android is a utility class for processing images. It provides functionality like croping or converting images.
description: The class ImageProcessor of Dynamsoft Capture Vision Android is a utility class for processing images. It provides functionality like cropping or converting images.
keywords: image io, image manager, Java, Kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
Expand Down
4 changes: 2 additions & 2 deletions programming/android/user-guide/get-original-image.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default-layout
title: Get Original Image - Dynamsoft Capture Vision Android Edition
description: This page introduce how to get original image for Dynamsoft Capture Vision Android Edition.
description: This page introduces how to get original image for Dynamsoft Capture Vision Android Edition.
keywords: Android, original image
needAutoGenerateSidebar: true
needGenerateH3Content: true
Expand All @@ -10,7 +10,7 @@ noTitleIndex: true

# Obtain Original Image

This page is the guide of how to obtain the original image that used for data capturing.
This page is the guide on how to obtain the original image used for data capture.

## Use Original Image Hash ID

Expand Down
6 changes: 3 additions & 3 deletions programming/android/user-guide/mrz.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default-layout
title: Scan & Parse MRZ - Dynamsoft Capture Vision Android Edition
description: This page introduce how to scan and parse a MRZ with Dynamsoft Capture Vision Android Edition.
description: This page introduces how to scan and parse a MRZ with Dynamsoft Capture Vision Android Edition.
keywords: Android, MRZ, passport, id card, visa
needAutoGenerateSidebar: true
needGenerateH3Content: true
Expand Down Expand Up @@ -51,7 +51,7 @@ The MRZ (Machine Readable Zone) in TD1 format consists of 3 lines, each containi

### ID (TD2 Size)

The MRZ (Machine Readable Zone) in TD2 format consists of 2 lines, with each line containing 36 characters.
The MRZ (Machine Readable Zone) in TD2 format consists of 2 lines, with each line containing 36 characters.

<div>
<img src="../../assets/td2-id.png" alt="Example of MRZ in TD2 format" width="72%" />
Expand All @@ -62,7 +62,7 @@ The MRZ (Machine Readable Zone) in TD2 format consists of 2 lines, with each li
The MRZ (Machine Readable Zone) in TD3 format consists of 2 lines, with each line containing 44 characters.

<div>
<img src="../../assets/td3-passport.png" alt="Example of MRZ in TD2 format" width="88%" />
<img src="../../assets/td3-passport.png" alt="Example of MRZ in TD3 format" width="88%" />
</div>

## Requirements
Expand Down
6 changes: 3 additions & 3 deletions programming/android/user-guide/setup-resources.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default-layout
title: Add Resource Files - Dynamsoft Capture Vision Android Edition
description: This page introduce how to add additional resource files for Dynamsoft Capture Vision Android Edition.
description: This page introduces how to add additional resource files for Dynamsoft Capture Vision Android Edition.
keywords: Android, resource files
needAutoGenerateSidebar: true
needGenerateH3Content: true
Expand All @@ -10,9 +10,9 @@ noTitleIndex: true

# Setup Resources

This page is the guide of how to setup resources for Dynamsoft Capture Vision Android Edition.
This page is the guide on how to set up resources for Dynamsoft Capture Vision Android Edition.

1. Right click on your project folder, select **New**, then select **Directory** and select the **src\main\assets** to create an assets folder.
1. Right-click on your project folder, select **New**, then select **Directory** and select the **src\main\assets** to create an assets folder.

2. Under the **assets** folder create a new folder and name it based on the type of your resource file.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
layout: default-layout
title: Use multi-frame cross filter - Dynamsoft Capture Vision Android Edition
description: This page introduce how to use the multi-frame cross filter feature of Dynamsoft Capture Vision Android Edition.
description: This page introduces how to use the multi-frame cross filter feature of Dynamsoft Capture Vision Android Edition.
keywords: Android, multi-frame, filter
needAutoGenerateSidebar: true
needGenerateH3Content: true
---

# How to Use Multi-Frame Cross Filter

[`MultiFrameCrossFilter`]({{ site.dcv_android_api }}utility/multi-frame-cross-filter.html) is a class under `DynamsoftUtility` library. It provides APIs for users to implement filter features based on the neighbouring video frames.
[`MultiFrameResultCrossFilter`]({{ site.dcv_android_api }}utility/multi-frame-cross-filter.html) is a class under `DynamsoftUtility` library. It provides APIs for users to implement filter features based on the neighbouring video frames.

| Filter Type | Description |
| ----------- | ----------- |
Expand Down
4 changes: 2 additions & 2 deletions programming/flutter/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ The hierarchical structure diagram below illustrates the various modules of the

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

## API Overview

### 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 API to control them all.

You can find the CaptureVisionRouter API [here](./api-reference/capture-vision-router/capture-vision-router.md).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
layout: default-layout
title: BufferedItemsManager - Dynamsoft Capture Vision iOS API Reference
description: The BufferedItemsManager class of DCV iOS edition is used to manage the buffered items.
title: DSBufferedItemsManager - Dynamsoft Capture Vision iOS API Reference
description: The DSBufferedItemsManager class of DCV iOS edition is used to manage the buffered items.
keywords: buffered items, manager, Objc, Objective-C, Swift
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# BufferedItemsManager
# DSBufferedItemsManager

The `BufferedItemsManager` class is used to manage the buffered items.
The `DSBufferedItemsManager` class is used to manage the buffered items.

## Definition

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The `DSCaptureStateListener` protocol defines the methods for monitoring the cap
```
2.
```swift
protocol DSCaptureStateListener : NSObjectProtocol
protocol CaptureStateListener : NSObjectProtocol
```

## Methods
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Adds a [DSIntermediateResultReceiver](intermediate-result-receiver.md) object as
```
2.
```swift
func addResultReceiver(_ receiver: DSIntermediateResultReceiver)
func addResultReceiver(_ receiver: IntermediateResultReceiver)
```

**Parameters**
Expand Down Expand Up @@ -92,7 +92,7 @@ Removes the specified [DSIntermediateResultReceiver](intermediate-result-receive
```
2.
```swift
func removeResultReceiver(_ receiver: DSIntermediateResultReceiver)
func removeResultReceiver(_ receiver: IntermediateResultReceiver)
```

**Parameters**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ func getObservationParameters() -> ObservationParameters

**Return Value**

An `ObservationParameters` object.
An `DSObservationParameters` object.

### onTargetROIResultsReceived

Expand Down Expand Up @@ -224,7 +224,7 @@ func onLocalizedTextLinesReceived(_ unit: LocalizedTextLinesUnit, info: Intermed

**Parameters**

`unit`: The intermediate result that contains the localized text lines, of type `LocalizedTextLinesUnit`.
`unit`: The intermediate result that contains the localized text lines, of type `DSLocalizedTextLinesUnit`.

`info`: Additional information about the result, of type `IntermediateResultExtraInfo`.

Expand Down
Loading