Skip to content

Commit 13c6ea3

Browse files
Dynamsoft-HenryDynamsoft-Henry
committed
Updating side list
1 parent 7c82089 commit 13c6ea3

File tree

3 files changed

+149
-8
lines changed

3 files changed

+149
-8
lines changed

‎_includes/sidelist-programming/programming-react-native.html‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,10 @@
33
<li lang="react-native"><a style="cursor:pointer;color:#3c3c3c">User Guide</a>
44
<ul lang="react-native">
55
<li lang="react-native"><a class="otherLinkColour" href="{{ site.dbr_react_native }}user-guide.html" style="cursor:pointer;color:#3c3c3c">Read Barcode</a></li>
6-
<li lang="react-native"><a class="otherLinkColour" href="{{ site.dbr_react_native }}driver-license-user-guide.html" style="cursor:pointer;color:#3c3c3c">Read Driver License</a></li>
7-
</ul>
8-
</li>
9-
<li lang="react-native"><a style="cursor:pointer;color:#3c3c3c">Explore Features</a>
10-
<ul lang="react-native">
11-
<li lang="react-native"><a class="otherLinkColour" href="{{ site.dbr_react_native }}explore-features/ui-customization.html" style="cursor:pointer;color:#3c3c3c">UI Customization</a></li>
12-
<li lang="react-native"><a class="otherLinkColour" href="{{ site.dbr_react_native }}explore-features/advanced-features.html" style="cursor:pointer;color:#3c3c3c">Advanced Features</a></li>
136
</ul>
147
</li>
158
<li lang="react-native"><a href="{{ site.dcv_react_native }}samples/index.html" class="otherLinkColour">Demo &amp; Samples</a></li>
16-
<li lang="react-native"><a style="cursor:pointer;color:#3c3c3c">API References</a>
9+
<li lang="react-native"><a href="{{ site.dcv_react_native_api }}" class="otherLinkColour">API References</a>
1710
<ul lang="react-native">
1811
<li lang="react-native"><a>CaptureVisionRouter</a>
1912
<ul lang="react-native">

‎programming/react-native/api-reference/index.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
layout: default-layout
3+
title: Dynamsoft Capture Vision React Native API Reference - Main Page
4+
description: This is the main page of Dynamsoft Capture Vision SDK API Reference for React Native.
5+
keywords: api reference, React Native
6+
needAutoGenerateSidebar: true
7+
noTitleIndex: true
8+
needGenerateH3Content: true
9+
---
10+
11+
# SDK Overview: Modules and Main APIs
12+
13+
This page provides an overview of the various modules and highlights the most essential APIs that form the backbone of Dynamsoft Capture Vision SDKs.
14+
15+
## Modules Summary
16+
17+
**DynamsoftCaptureVisionBundle** is a bundle package that includes all libraries of Dynamsoft Capture Vision (DCV) architecture. The DCV libraries work together to achieve barcode reading, MRZ recognizing, document scanning and other image processing features. The hierarchical structure diagram below illustrates the various modules of the DCV SDKs (with modules at the top depending on those below).
18+
19+
<div align="center">
20+
<p><img src="../../../assets/img/dcv-dependencies.png" width="70%" alt="dependencies"></p>
21+
<p>Modules hierarchical of the DCV SDK</p>
22+
</div>
23+
24+
The table below describes details the functionalities of these modules:
25+
26+
| File | Description |
27+
|:-----|:------------|
28+
| `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. |
29+
| `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. |
30+
| `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. |
31+
| `DynamsoftLabelRecognizer` (DLR) | The Dynamsoft Label Recognizer module identifies and recognizes text labels such as passport MRZs, ID cards, and VIN numbers. |
32+
| `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.|
33+
| `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. |
34+
| `DynamsoftNeuralNetwork` (DNN) | The Dynamsoft Neural Network module allows SDKs compliant with the DCV (Dynamsoft Capture Vision) architecture to leverage the power of deep learning when processing digital images. |
35+
| `DynamsoftLicense` (License) | The Dynamsoft License module manages the licensing aspects of Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. |
36+
| `DynamsoftCameraEnhancer` (DCE) | The Dynamsoft Camera Enhancer (DCE) module controls the camera, transforming it into an image source for the DCV (Dynamsoft Capture Vision) architecture through ISA implementation. It also enhances image quality during acquisition and provides basic viewers for user interaction. |
37+
| `DynamsoftUtility` (Utility) | The Dynamsoft Utility module defines auxiliary classes, including the ImageManager, and implementations of the CRF (Captured Result Filter) and ISA (Image Source Adapter). These are shared by all Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. |
38+
| `DynamsoftCodeParser` (DCP) | The Dynamsoft Code Parser module converts data strings, typically encrypted in barcodes and machine-readable zones, into human-readable information. |
39+
| `DynamsoftCodeParserDedicator` (DCPD) | The Dynamsoft Code Parser Dedicator module provides auxiliary functionality to enhance and extend the capabilities of DCP module. |
40+
41+
## Main APIs
42+
43+
### Capture Vision Router
44+
45+
The main class [`CaptureVisionRouter`]({{ site.dcv_react_native_api }}capture-vision-router/capture-vision-router.html) acts as the SDK entry point and provides the following essential APIs.
46+
47+
### Image Source Adapter
48+
49+
The [`ImageSourceAdapter`]({{ site.dcv_react_native_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_react_native_api }}capture-vision-router/capture-vision-router.html). You can either use the typical implementations of [`ImageSourceAdapter`]({{ site.dcv_react_native_api }}core/image-source-adapter.html) or implement your own.
50+
51+
Class [`CameraEnhancer`]({{ site.dce_react_native_api }}camera-enhancer.html) is one of the typical implementations of [`ImageSourceAdapter`]({{ site.dcv_react_native_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.
52+
53+
### Captured Result Receiver
54+
55+
Implement the callback methods of [`CapturedResultReceiver`]({{ site.dcv_react_native_api }}capture-vision-router/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.
56+
57+
#### Barcode Decoding
58+
59+
Callback methods that are related to barcode decoding:
60+
61+
- [`onDecodedBarcodesReceived`]({{ site.dcv_react_native_api }}capture-vision-router/captured-result-receiver.html#ondecodedbarcodesreceived): The callback of barcode decoding. The result you received in the callback method is a [`DecodedBarcodesResult`]({{ site.dbr_react_native_api }}decoded-barcodes-result.html) object, which contains all the decoded barcodes from the processed image.
62+
63+
Related APIs:
64+
65+
- [`DecodedBarcodesResult`]({{ site.dbr_react_native_api }}decoded-barcodes-result.html): All barcodes that decoded from the processed image.
66+
- [`BarcodeResultItem`]({{ site.dbr_react_native_api }}barcode-result-item.html): The barcode decoding result of a single barcode.
67+
68+
#### Document Scanning
69+
70+
Callback methods that are related to document scanning:
71+
72+
- [`onProcessedDocumentResultReceived`]({{ site.dcv_react_native_api }}capture-vision-router/captured-result-receiver.html#onprocesseddocumentresultreceived): The callback of document boundary detection. The result you received in the callback method is a [`ProcessedDocumentResult`]({{ site.ddn_react_native_api }}processed-document-result.html) object, which contains the detected boundaries, the deskewed images, and the enhanced images from the processed image.
73+
74+
Related APIs:
75+
76+
- [`ProcessedDocumentResult`]({{ site.ddn_react_native_api }}processed-document-result.html): A combination of all kinds of document processing results.
77+
- [`DetectedQuadResultItem`]({{ site.ddn_react_native_api }}detected-quad-result-item.html): The boundary detection result of a single document page.
78+
- [`DeskewedImageResultItem`]({{ site.ddn_react_native_api }}deskewed-image-result-item.html): The deskewing result of a single document page.
79+
- [`EnhancedImageResultItem`]({{ site.ddn_react_native_api }}enhanced-image-result-item.html): The enhanced result of a single document page.
80+
81+
#### MRZ Scanning
82+
83+
Callback methods that are related to MRZ scanning:
84+
85+
- [`onParsedResultsReceived`]({{ site.dcv_react_native_api }}capture-vision-router/captured-result-receiver.html#onparsedresultsreceived): The callback of content parsing. The result you received in the callback method is a [`ParsedResult`]({{ site.dcp_react_native_api }}parsed-result.html) object, which contains all the parsed results from the processed image.
86+
- [`onRecognizedTextLinesReceived`]({{ site.dcv_react_native_api }}capture-vision-router/captured-result-receiver.html#onrecognizedtextlinesreceived): The callback of text recognition. The result you received in the callback method is a [`RecognizedTextLinesResult`]({{ site.dlr_react_native_api }}recognized-text-lines-result.html) object, which contains all the original MRZ text of the processed image.
87+
88+
Related APIs:
89+
90+
- [`ParsedResult`]({{ site.dcp_react_native_api }}parsed-result.html): All parsed results that captured from the processed image.
91+
- [`ParsedResultItem`]({{ site.dcp_react_native_api }}parsed-result-item.html): The parsing result of a single parsable content.
92+
- [`RecognizedTextLinesResult`]({{ site.dlr_react_native_api }}recognized-text-lines-result.html): All text lines that recognized from the processed image.
93+
- [`TextLineResultItem`]({{ site.dlr_react_native_api }}text-line-result-item.html): The text recognition result of a single text line.
94+
95+
### Camera View
96+
97+
[`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).

‎programming/react-native/index.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: default-layout
3+
title: Index - Dynamsoft Capture Vision React Native Edition
4+
description: The introduction of Dynamsoft Capture Vision React Native edition.
5+
keywords: API reference, index, React Native
6+
needAutoGenerateSidebar: true
7+
noTitleIndex: false
8+
---
9+
10+
# Dynamsoft Capture Vision React Native Edition - Documentation
11+
12+
Dynamsoft Capture Vision (DCV) is a comprehensive SDK that integrates various functional products. It encompasses image capture, content understanding, result parsing, and interactive workflow. Essentially, DCV processes images to extract specific information that is meaningful within a business context.
13+
14+
DCV is designed to enable developers to quickly create conceptual prototypes within hours. It also offers the flexibility to handle more complex customizations for demanding tasks.
15+
16+
> Read [Introduction to Dynamsoft Capture Vision]({{ site.dcvb_introduction }})
17+
18+
This documentation provides guidance to assist developers in utilizing DCV for React Native applications.
19+
20+
## Using the SDK
21+
22+
### System Requirements
23+
24+
- Supported OS: React Native 5.0 (API Level 21) or higher.
25+
- Supported ABI: **armeabi-v7a**, **arm64-v8a**, **x86** and **x86_64**.
26+
- Development Environment:
27+
- IDE: Android Studio 2024.3.2 suggested.
28+
- JDK: Java 17 or higher.
29+
- Gradle: 8.0 or higher.
30+
31+
### Get Started
32+
33+
- [Read Barcode]({{ site.dbr_react_native }}user-guide.html){:target="_blank"}
34+
35+
### Check APIs
36+
37+
While the guide covers common APIs, more detailed explanations of these and other APIs can be found in the [API Reference](./api-reference/index.md).
38+
39+
### Read about CaptureVisionTemplate
40+
41+
Using DCV in React Native involves:
42+
43+
1. Creating a `CaptureVisionRouter` instance.
44+
2. Defining and binding an image source and a result receiver to the instance.
45+
3. Specifying a template which defines how to process images.
46+
47+
Apparently, the use of DCV varies with the choice of template. Dynamsoft provides popular preset templates and will add more over time. To understand, adjust, or define your own template, read about [CaptureVisionTemplate]({{ site.parameter }}file/).
48+
49+
### Contact Us
50+
51+
Feel free to [contact us](https://www.dynamsoft.com/company/customer-service/#contact){:target="_blank"} if you have any questions.

0 commit comments

Comments
 (0)