- CaptureVisionRouter @@ -678,14 +678,17 @@
- USEFUL RESOURCES - - +
- Release Notes
+
-
+
- 3.x +
- Choose a Language
- Android (Java & Kotlin)
- iOS (Objective-C & Swift)
- MAUI -
- React Native +
- React Native
- C++
- Python
- Java diff --git a/_includes/sidelist-programming/programming-react-native.html b/_includes/sidelist-programming/programming-react-native.html new file mode 100644 index 0000000..2879c59 --- /dev/null +++ b/_includes/sidelist-programming/programming-react-native.html @@ -0,0 +1,750 @@ +
- DEVELOPMENT + +
- User Guide + + +
- Explore Features + + +
- Demo & Samples +
- API References
+
-
+
- CaptureVisionRouter
+
-
+
- Classes + + +
- Interfaces + + +
- Enumerations + + +
+ - Core
+
-
+
- Classes + + +
- Interfaces
+
-
+
- CapturedResultBase +
- CapturedResultItem +
- DSRect +
- ImageData +
- Point +
- Quadrilateral +
+ - Enumerations + + +
+ - BarcodeReader + + +
- CameraEnhancer
+
-
+
- Classes
+
-
+
- CameraEnhancer +
- CameraView +
- FeedBack +
- ImageEditorView +
+ - Enumerations + + +
+ - Classes
+
- CodeParser
+
-
+
- Supported Code Types + + +
- Interfaces
+
-
+
- ParsedResult +
- ParsedResultItem +
- ParsedField +
+ - Enumerations + + +
+ - License
+
-
+
- Classes
+
-
+
- LicenseManager +
+
+ - Classes
+
- Utility
+
-
+
- Classes + + +
- Enumerations
+
-
+
- EnumFilterType +
+
+ - DocumentNormalizer + + +
- LabelRecognizer + + +
+
+ - CaptureVisionRouter
+
- UNDERSTANDING DCV +
- Architecture + + +
- Parameters
+
-
+
- CaptureVisionTemplate Object + + +
- ImageSource Object
+
-
+
- DirectoryPath +
- FileFilter +
- Name +
- Pages +
- PDFReadingMode +
- Recursive +
- Type +
+ - TargetROIDef Object
+
-
+
- BaseTargetROIDefName +
- EnableResultsDeduplication +
- Location
+
-
+
- ReferenceObjectFilter + + +
- Offset + + +
+ - Name +
- PauseFlag +
- TaskSettingNameArray +
+ - BarcodeReaderTaskSetting Object
+
-
+
- BarcodeFormatIds +
- BarcodeFormatSpecificationNameArray +
- BaseBarcodeReaderTaskSettingName +
- DPMCodeReadingModes +
- ExpectedBarcodesCount +
- MaxThreadsInOneTask +
- Name +
- ReturnBarcodeZoneClarity +
- TextResultOrderModes +
- SectionArray
+
-
+
- RegionPredetectionSection Object
+
-
+
- Section +
- ImageParameterName +
- StageArray
+
-
+
- PredetectRegionsStage Object
+
-
+
- Stage +
- RegionPredetectionModes +
+
+ - PredetectRegionsStage Object
+
+ - BarcodeLocalizationSection Object
+
-
+
- Section +
- ImageParameterName +
- StageArray
+
-
+
- LocalizeCandidateBarcodesStage Object
+
-
+
- Stage +
- LocalizationModes +
+ - LocalizeBarcodesStage Object
+
-
+
- Stage +
+
+ - LocalizeCandidateBarcodesStage Object
+
+ - BarcodeDecodingSection Object
+
-
+
- Section +
- ImageParameterName +
- StageArray
+
-
+
- ResistDeformationStage Object + + +
- ComplementBarcodeStage Object
+
-
+
- Stage +
- BarcodeComplementModes +
+ - ScaleBarcodeImageStage Object
+
-
+
- Stage +
- BarcodeScaleModes +
+ - DecodeBarcodesStage Object
+
-
+
- Stage +
- DeblurModes +
+
+
+
+ - RegionPredetectionSection Object
+
+ - LabelRecognizerTaskSetting Object
+
-
+
- Name +
- BaseLabelRecognizerTaskSettingName +
- MaxThreadsInOneTask +
- TextLineSpecificationNameArray +
- SectionArray
+
-
+
- RegionsPredetectionSection Object
+
-
+
- Section +
- ImageParameterName +
- StageArray
+
-
+
- PredetectRegionsStage Object
+
-
+
- Stage +
- RegionPredetectionModes +
+
+ - PredetectRegionsStage Object
+
+ - TextLinesLocalizationSection Object
+
-
+
- Section +
- ImageParameterName +
- StageArray
+
-
+
- LocalizeTextLinesStage Object
+
-
+
- Stage +
- LocalizationModes +
+
+ - LocalizeTextLinesStage Object
+
+ - TextLinesRecognitionSection Object
+
-
+
- Section +
- ImageParameterName +
- StageArray
+
-
+
- RecognizeRawTextLinesStage Object + + +
- AssembleTextLinesStage Object
+
-
+
- Stage +
- StringRegExPattern +
- StringLengthRange +
+
+
+
+
+ - RegionsPredetectionSection Object
+
+ - DocumentNormalizerTaskSetting Object
+
-
+
- BaseDocumentNormalizerTaskSettingName +
- ExpectedDocumentsCount +
- MaxThreadsInOneTask +
- Name +
- SectionArray
+
-
+
- RegionsPredetectionSection Object
+
-
+
- Section +
- ImageParameterName +
- StageArray
+
-
+
- PredetectRegionsStage Object
+
-
+
- Stage +
- RegionPredetectionModes +
+
+ - PredetectRegionsStage Object
+
+ - DocumentDetectionSection Object
+
-
+
- Section +
- ImageParameterName +
- StageArray
+
-
+
- AssembleLongLinesStage Object
+
-
+
- Stage +
+ - AssembleLogicalLinesStage Object
+
-
+
- Stage +
+ - DetectCornersStage Object
+
-
+
- Stage +
- CornerAngleRange +
+ - DetectEdgesStage Object
+
-
+
- Stage +
+ - DetectQuadsStage Object + + +
+ - AssembleLongLinesStage Object
+
+ - DocumentDeskewingSection Object
+
-
+
- Section +
- ImageParameterName +
- StageArray
+
-
+
- DeskewImageStage Object
+
-
+
- Stage +
- DeskewMode +
- PageSize +
+
+ - DeskewImageStage Object
+
+ - ImageEnhancementSection Object
+
-
+
- Section +
- ImageParameterName +
- StageArray
+
-
+
- EnhanceImageStage Object
+
-
+
- Stage +
- ColourMode +
- Brightness +
- Contrast +
+
+ - EnhanceImageStage Object
+
+
+ - RegionsPredetectionSection Object
+
+ - CodeParserTaskSetting Object
+
-
+
- CodeSpecifications +
- Name +
- ResourcesPath +
+ - OutputTaskSetting Object
+
-
+
- Name +
- OutputCondition +
+ - ImageParameter Object
+
-
+
- BaseImageParameterName +
- Name +
- ApplicableStages
+
-
+
- Assemble Lines Stage
+
-
+
- Stage +
- LineAssemblyMode +
+ - Binarize Image Stage
+
-
+
- Stage +
- BinarizationModes +
+ - Binarize Texture Removed Grayscale Stage
+
-
+
- Stage +
- BinarizationModes +
+ - Convert to Grayscale Stage
+
-
+
- Stage +
- ColourConversionModes +
+ - Detect Shortlines Stage
+
-
+
- Stage +
- ShortlinesDetectionMode +
+ - Detect Text Zones Stage
+
-
+
- Stage +
- TextDetectionMode +
+ - Detect Texture Stage
+
-
+
- Stage +
- TextureDetectionModes +
+ - Enhance Grayscale Stage + + +
- Find Contours Stage
+
-
+
- Stage +
+ - Remove Text Zones from Binary Stage
+
-
+
- Stage +
- IfEraseTextZone +
+ - Remove Texture from Grayscale Stage + + +
- Scale Image Stage
+
-
+
- Stage +
- ImageScaleSettings +
+ - Transform Grayscale Stage + + +
+ - Assemble Lines Stage
+
+ - BarcodeFormatSpecification Object
+
-
+
- AllModuleDeviation +
- AustralianPostEncodingTable +
- BarcodeAngleRangeArray +
- BarcodeBytesLengthRangeArray +
- BarcodeHeightRangeArray +
- BarcodeTextLengthRangeArray +
- BarcodeTextRegExPattern +
- BarcodeWidthRangeArray +
- BarcodeZoneBarCountRangeArray +
- BarcodeZoneMinDistanceToImageBorders +
- Code128Subset +
- DataMatrixModuleIsotropic +
- DataMatrixSizeOptions +
- EnableAddOnCode +
- EnableDataMatrixECC000-140 +
- EnableQRCodeModel1 +
- FindUnevenModuleBarcode +
- HeadModuleRatio +
- MinQuietZoneWidth +
- MinRatioOfBarcodeZoneWidthToHeight +
- MinResultConfidence +
- MirrorMode +
- ModuleSizeRangeArray +
- MSICodeCheckDigitCalculation +
- Name +
- PartitionModes +
- PatchCodeSearchingMargins +
- RequireStartStopChars +
- ReturnPartialBarcodeValue +
- StandardFormat +
- TailModuleRatio +
- VerifyCheckDigit +
+ - TextLineSpecification Object
+
-
+
- ApplicableTextLineNumbers +
- BaseTextLineSpecificationName +
- BinarizationModes +
- CharHeightRange +
- CharacterModelName +
- TextLineRecModelName +
- CharacterNormalizationModes +
- GrayscaleEnhancementModes +
- Name +
- StringLengthRange +
- StringRegExPattern +
- Text line position parameters +
- ConcatStringLengthRange +
- ConcatStringRegExPattern +
- ConcatSeparator +
- ConcatResults +
- OutputResults +
- SubGroups +
- ReferenceGroupName +
- TextLinesCount +
- ConfusableCharactersCorrection +
- ExpectedGroupsCount +
+ - CaptureVisionModel Object
+
-
+
- DirectoryPath +
- MaxModelInstances +
- ModelArgs +
- CharSet Object +
- Name +
-
+
+ - Global Parameter + + +
- SemanticProcessing Object + + +
+
+ - USEFUL RESOURCES +
- Release Notes
+
-
+
- 3.x +
+ - Choose a Language
+
-
+
- Android (Java & Kotlin) +
- iOS (Objective-C & Swift) +
- MAUI +
- Flutter +
- C++ +
- Python +
- Java +
- .NET +
- JS +
\ No newline at end of file
diff --git a/programming/android/api-reference/core/basic-structures/captured-result-base.md b/programming/android/api-reference/core/basic-structures/captured-result-base.md
index eaaca29..a83cc0b 100644
--- a/programming/android/api-reference/core/basic-structures/captured-result-base.md
+++ b/programming/android/api-reference/core/basic-structures/captured-result-base.md
@@ -6,7 +6,6 @@ keywords: captured result base, Android
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
-ignore: true
---
# CapturedResultBase
diff --git a/programming/flutter/api-reference/capture-vision-router/multi-frame-cross-filter.md b/programming/flutter/api-reference/capture-vision-router/multi-frame-cross-filter.md
index 06dca45..88b74e8 100644
--- a/programming/flutter/api-reference/capture-vision-router/multi-frame-cross-filter.md
+++ b/programming/flutter/api-reference/capture-vision-router/multi-frame-cross-filter.md
@@ -10,10 +10,11 @@ noTitleIndex: true
# MultiFrameResultCrossFilter
-The `MultiFrameResultCrossFilter` class provides a filter that allows the library to manage and filter results by crosschecking the results across multiple images frames. This filter will compare consecutive frames of the video stream to perform operations like cross-verification, deduplication, and overlapping result management.
+The `MultiFrameResultCrossFilter` class is an officially implemented `CapturedResultFilter` that provides:
-> [!NOTE]
-> This filter is especially handy in increasing the accuracy when trying to capture barcodes, documents, or MRZ zones via a camera in an interactive video scenario.
+- **Overlapping**: Improves the read rate of multi-barcode scanning.
+- **Cross Verification**: Improves the accuracy.
+- **Deduplication**: Removes the duplicated results.
## Definition
diff --git a/programming/flutter/api-reference/core/captured-result-base.md b/programming/flutter/api-reference/core/captured-result-base.md
index 65842c5..8180bab 100644
--- a/programming/flutter/api-reference/core/captured-result-base.md
+++ b/programming/flutter/api-reference/core/captured-result-base.md
@@ -6,7 +6,6 @@ keywords: captured result base, Flutter
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
-ignore: true
---
# CapturedResultBase
diff --git a/programming/flutter/api-reference/core/enum/cross-verification-status.md b/programming/flutter/api-reference/core/enum/cross-verification-status.md
index 2525fdd..7480576 100644
--- a/programming/flutter/api-reference/core/enum/cross-verification-status.md
+++ b/programming/flutter/api-reference/core/enum/cross-verification-status.md
@@ -20,13 +20,8 @@ codeAutoHeight: true
```dart
enum EnumCrossVerificationStatus {
- /// The item has not been verified.
notVerified,
-
- /// The item has passed verification.
passed,
-
- /// The item has failed verification.
failed
}
```
diff --git a/programming/flutter/api-reference/core/enum/focus-mode.md b/programming/flutter/api-reference/core/enum/focus-mode.md
index 5f3256b..19b08b6 100644
--- a/programming/flutter/api-reference/core/enum/focus-mode.md
+++ b/programming/flutter/api-reference/core/enum/focus-mode.md
@@ -12,9 +12,6 @@ breadcrumbText: EnumFocusMode
`EnumFocusMode` is an enumeration that specifies the different modes of focus that the Camera Enhancer can apply to the camera feed.
-> [!TIP]
-> If you choose to use the locked focus mode, the focal length used is determined by the input value of [`setFocus`](../camera-enhancer.md#setfocus).
-
## Definition
*Assembly:* dynamsoft_capture_vision_flutter
@@ -30,5 +27,5 @@ enum EnumFocusMode {
| Member | Description |
| ------ | ----------- |
-| `locked` | Lock the focal length with an input value. |
+| `locked` | Lock the focal length. |
| `continuousAuto` | Implements a continuous autoFocus. |
diff --git a/programming/flutter/api-reference/core/image-source-adapter.md b/programming/flutter/api-reference/core/image-source-adapter.md
index 93b8519..6652a57 100644
--- a/programming/flutter/api-reference/core/image-source-adapter.md
+++ b/programming/flutter/api-reference/core/image-source-adapter.md
@@ -29,7 +29,7 @@ abstract class ImageSourceAdapter
| Method | Description |
| ------ | ----------- |
| [`addImageToBuffer`](#addimagetobuffer) | Adds an image to the internal buffer. |
-| [`clearBuffer`](#clearbuffer) | Clears all images from the buffer, resetting the state for new image fetching. |
+| [`clearBuffer`](#clearbuffer) | Clears all images from the buffer. |
| [`getBufferOverflowProtectionMode`](#getbufferoverflowprotectionmode) | Get the current mode for handling buffer overflow. |
| [`getColourChannelUsageType`](#getcolourchannelusagetype) | Get the current usage type for color channels in images. |
| [`getImage`](#getimage) | Get a buffered image. Implementing classes should return a Promise that resolves with an instance of `ImageData`. |
@@ -52,7 +52,7 @@ Future - User Guide - -
- Explore Features -
- Demo & Samples -
- API References +
- API References
- CaptureVisionRouter
-
diff --git a/programming/react-native/api-reference/index.md b/programming/react-native/api-reference/index.md
new file mode 100644
index 0000000..0254be3
--- /dev/null
+++ b/programming/react-native/api-reference/index.md
@@ -0,0 +1,97 @@
+---
+layout: default-layout
+title: Dynamsoft Capture Vision React Native API Reference - Main Page
+description: This is the main page of Dynamsoft Capture Vision SDK API Reference for React Native.
+keywords: api reference, React Native
+needAutoGenerateSidebar: true
+noTitleIndex: true
+needGenerateH3Content: true
+---
+
+# SDK Overview: Modules and Main APIs
+
+This page provides an overview of the various modules and highlights the most essential APIs that form the backbone of Dynamsoft Capture Vision SDKs.
+
+## Modules Summary
+
+**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).
+
+
++ +The table below describes details the functionalities of these modules: + +| File | Description | +|:-----|:------------| +| `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. | +| `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. | +| `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. | +| `DynamsoftLicense` (License) | The Dynamsoft License module manages the licensing aspects of Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. | +| `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. | +| `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. | +| `DynamsoftCodeParser` (DCP) | The Dynamsoft Code Parser module converts data strings, typically encrypted in barcodes and machine-readable zones, into human-readable information. | +| `DynamsoftCodeParserDedicator` (DCPD) | The Dynamsoft Code Parser Dedicator module provides auxiliary functionality to enhance and extend the capabilities of DCP module. | + +## Main APIs + +### Capture Vision Router + +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. + +### Image Source Adapter + +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. + +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. + +### Captured Result Receiver + +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. + +#### Barcode Decoding + +Callback methods that are related to barcode decoding: + +- [`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. + +Related APIs: + +- [`DecodedBarcodesResult`]({{ site.dbr_react_native_api }}decoded-barcodes-result.html): All barcodes that decoded from the processed image. +- [`BarcodeResultItem`]({{ site.dbr_react_native_api }}barcode-result-item.html): The barcode decoding result of a single barcode. + +#### Document Scanning + +Callback methods that are related to document scanning: + +- [`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. + +Related APIs: + +- [`ProcessedDocumentResult`]({{ site.ddn_react_native_api }}processed-document-result.html): A combination of all kinds of document processing results. +- [`DetectedQuadResultItem`]({{ site.ddn_react_native_api }}detected-quad-result-item.html): The boundary detection result of a single document page. +- [`DeskewedImageResultItem`]({{ site.ddn_react_native_api }}deskewed-image-result-item.html): The deskewing result of a single document page. +- [`EnhancedImageResultItem`]({{ site.ddn_react_native_api }}enhanced-image-result-item.html): The enhanced result of a single document page. + +#### MRZ Scanning + +Callback methods that are related to MRZ scanning: + +- [`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. +- [`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. + +Related APIs: + +- [`ParsedResult`]({{ site.dcp_react_native_api }}parsed-result.html): All parsed results that captured from the processed image. +- [`ParsedResultItem`]({{ site.dcp_react_native_api }}parsed-result-item.html): The parsing result of a single parsable content. +- [`RecognizedTextLinesResult`]({{ site.dlr_react_native_api }}recognized-text-lines-result.html): All text lines that recognized from the processed image. +- [`TextLineResultItem`]({{ site.dlr_react_native_api }}text-line-result-item.html): The text recognition result of a single text line. + +### 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). diff --git a/programming/react-native/index.md b/programming/react-native/index.md new file mode 100644 index 0000000..8b28b03 --- /dev/null +++ b/programming/react-native/index.md @@ -0,0 +1,51 @@ +--- +layout: default-layout +title: Index - Dynamsoft Capture Vision React Native Edition +description: The introduction of Dynamsoft Capture Vision React Native edition. +keywords: API reference, index, React Native +needAutoGenerateSidebar: true +noTitleIndex: false +--- + +# Dynamsoft Capture Vision React Native Edition - Documentation + +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. + +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. + +> Read [Introduction to Dynamsoft Capture Vision]({{ site.dcvb_introduction }}) + +This documentation provides guidance to assist developers in utilizing DCV for React Native applications. + +## Using the SDK + +### System Requirements + +- Supported OS: React Native 5.0 (API Level 21) or higher. +- Supported ABI: **armeabi-v7a**, **arm64-v8a**, **x86** and **x86_64**. +- Development Environment: + - IDE: Android Studio 2024.3.2 suggested. + - JDK: Java 17 or higher. + - Gradle: 8.0 or higher. + +### Get Started + +- [Read Barcode]({{ site.dbr_react_native }}user-guide.html){:target="_blank"} + +### Check APIs + +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). + +### Read about CaptureVisionTemplate + +Using DCV in React Native involves: + +1. Creating a `CaptureVisionRouter` instance. +2. Defining and binding an image source and a result receiver to the instance. +3. Specifying a template which defines how to process images. + +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/). + +### Contact Us + +Feel free to [contact us](https://www.dynamsoft.com/company/customer-service/#contact){:target="_blank"} if you have any questions.
+
Modules hierarchical of the DCV SDK
+
- CaptureVisionRouter
addImageToBuffer(ImageData image); ### clearBuffer -Clears all images from the buffer, resetting the state for new image fetching. +Clears all images from the buffer. ```dart Future clearBuffer(); @@ -75,10 +75,6 @@ Get the current usage type for color channels in images. Future getColourChannelUsageType(); ``` -**Remarks** - -This method should be used to verify which colour channel the camera is using, and in turn verify what pixel type any images retrieved during the capture process will come out in. - ### getImage Get a buffered image. Implementing classes should return a Promise that resolves with an instance of `ImageData`. @@ -119,10 +115,6 @@ Sets the usage type for color channels in images. Future setColourChannelUsageType(EnumColourChannelUsageType type); ``` -**Remarks** - -This method should be used to change the pixel type of the original image or captured frame should you choose to retrieve it after the capture process. In order to retrieve the original image after the barcode is decoded or the captured result is received, please refer to [this article]. - ### setMaximumImageCount Sets the maximum number of images that can be buffered at any time. diff --git a/programming/flutter/api-reference/utility/image-drawer.md b/programming/flutter/api-reference/utility/image-drawer.md index 2e111f2..db98e52 100644 --- a/programming/flutter/api-reference/utility/image-drawer.md +++ b/programming/flutter/api-reference/utility/image-drawer.md @@ -30,11 +30,16 @@ Draws quadrilaterals on the image with the specified style parameters. Future drawOnImage(ImageData image, List quadrilaterals, int color, int thickness) async ``` -**Remarks** +**Parameters** -- `image`: The source image to draw on. -- `quadrilaterals`: List of Quadrilateral objects to render onto the image. -- `color`: ARGB colour value (0xAARRGGBB format) -- `thickness`: The line thickness in pixels. +`image`: The source image to draw on. -The method returns an [`ImageData`](../core/image-data.md) object that represents the new image with the rendered shapes. +`quadrilaterals`: List of Quadrilateral objects to render onto the image. + +`color`: ARGB colour value (0xAARRGGBB format) + +`thickness`: The line thickness in pixels. + +**Returns** + +An [`ImageData`](../core/image-data.md) object that represents the new image with the rendered shapes. diff --git a/programming/flutter/release-notes/flutter-3.md b/programming/flutter/release-notes/flutter-3.md new file mode 100644 index 0000000..d40c0ec --- /dev/null +++ b/programming/flutter/release-notes/flutter-3.md @@ -0,0 +1,101 @@ +--- +layout: default-layout +title: Release Notes v3.x - DynamsoftCaptureVisionBundle Flutter Edition +description: The release notes of DynamsoftCaptureVisionBundle Flutter Edition v3.x. +keywords: release notes, capture vision bundle, Flutter, dcv +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# Release Notes v3.x - DynamsoftCaptureVisionRouter Module + +## 3.2.3000 (12/04/2025) + +### πMilestone Release + +Version 3.2.3000 introduces a series of AI-driven improvements designed to enhance barcode and MRZ detection accuracy, processing speed, and configuration flexibility. + +This release focuses on practical performance gains for production environments across retail, logistics, manufacturing, and identity verification workflows. + +### β¨ Key Highlights + +#### AI-Powered Barcode Detection and Decoding + +- New Localization Models β Introduces [`OneDLocalization`]({{ site.dcv_parameters_reference }}barcode-reader-task-settings/localization-modes.html#modelnamearray) and [`DataMatrixQRCodeLocalization`]({{ site.dcv_parameters_reference }}barcode-reader-task-settings/localization-modes.html#modelnamearray) neural network models for improved detection of **blurred / low-resolution 1D codes**, or **partially damaged DataMatrix/QR codes**. +- Specialized Decoders β Adds [`EAN13Decoder`]({{ site.dcv_parameters_reference }}barcode-reader-task-settings/deblur-modes.html#modelnamearray) and [`Code128Decoder`]({{ site.dcv_parameters_reference }}barcode-reader-task-settings/deblur-modes.html#modelnamearray) models optimized for **long-distance** and **motion-blurred** decoding scenarios. +- Redesigned Deblur Model β The [`OneDDeblur`]({{ site.dcv_parameters_reference }}barcode-reader-task-settings/deblur-modes.html#modelnamearray) model now provides more effective recovery from **motion and focus blur**. +- Configurable Model Selection β The new `ModelNameArray` parameter supports flexible model loading and fine-grained control for specific barcode types. + +#### Precision and Processing Control + +- Enhanced Deblur Methods β [`DM_DEEP_ANALYSIS`]({{ site.dcv_parameters_reference }}barcode-reader-task-settings/deblur-modes.html#dm_deep_analysis) now includes sub-level control with `OneDGeneral`, `TwoDGeneral`, and `EAN13Enhanced` options. +- Barcode Count Expectation β The new [`ExpectedBarcodesCount`]({{ site.dcv_parameters_reference }}barcode-format-specification/expected-barcodes-count.html) parameter enables **format-specific quantity control** and **early termination** in fixed-count workflows. +- Improved Region Detection β The new [`RPM_GRAY_CONSISTENCY`]({{ site.dcv_parameters_reference }}image-parameter/region-predetection-modes.html#rpm_gray_consistency) mode provides more precise region extraction based on **grayscale uniformity** and **local consistency** for document and label processing. + +#### AI-Powered MRZ Detection + +- Neural MRZ Localization β The new [`MRZLocalization`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/localization-modes.html#modelnamearray) model improves region detection accuracy and delivers up to **42.7%** faster processing for MRZ-based document workflows. +- Configurable Localization Control β The new [`LocalizationModes`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/localization-modes.html) parameter allows configuration for text line detection. + +#### Smart Document Capture + +- Clarity-Based Frame Selection β Automatically selects the sharpest and highest-quality frame in live capture workflows. +- Cross-Frame Verification β Updated verification algorithms enhance result reliability. + +### Performance Highlights + +#### Barcode Workflows + +- Up to **26.5%** higher read rates under blur conditions with as much as **44%** faster processing. +- Reliable decoding of DataMatrix and QR codes with missing or damaged finder patterns. +- Extended operational range beyond 75 cm for long-distance barcode scanning. + +#### Document Workflows + +- Improved performance in live video capture environments. +- Consistent document quality through clarity-based frame evaluation. +- Faster MRZ processing for high-throughput identity verification + +### Developer Notes + +- Backward Compatibility β Fully compatible with existing integrations; no code-level changes required for upgrade. +- Configuration Flexibility β Expanded parameter set allows comprehensive model configuration for scenario-specific tuning. +- Production Stability β All new models validated in enterprise environments. + +### New + +- Added a new method, [`switchCapturingTemplate`]({{ site.dcv_flutter_api }}capture-vision-router.html#switchcapturingtemplate), which allows switching templates dynamically during the image processing workflow. +- Added a new method, [`clearDLModelBuffers`]({{ site.dcv_flutter_api }}capture-vision-router.html#cleardlmodelbuffers), to release memory by clearing buffered deep learning models. +- Added a new method, [`setGlobalIntraOpNumThreads`]({{ site.dcv_flutter_api }}capture-vision-router.html#setglobalintraopnumthreads), to configure the global number of threads used for model execution. +- Added a new button, `cameraToggleButton`, to the `CameraView`, allowing users to switch between the front and back cameras. +The following APIs are provided for configuring the `cameraToggleButton`: + - [`cameraToggleButton`]({{ site.dce_flutter_api }}camera-view.html#cameratogglebutton) + - [`cameraToggleButtonVisible`]({{ site.dce_flutter_api }}camera-view.html#cameratogglebuttonvisible) +- Added new methods to class `ImageIO` for reading and saving images: + - [`readFromMemory`]({{ site.dcv_flutter_api }}utility/image-io.html#readfrommemory) + - [`saveToMemory`]({{ site.dcv_flutter_api }}utility/image-io.html#savetomemory) +- Added a new method [`cropAndDeskewImage`]({{ site.dcv_flutter_api }}utility/image-processor.html#cropanddeskewimage) to class `ImageProcessor` for cropping & deskewing images. + +## 3.0.5200 (08/28/2025) + +### [Highlights](https://www.dynamsoft.com/release-highlights/?product=dcv3.0) + +- Workflow Improvements + - Restructured the parameter control hierarchy at all levels for finer scope definition and more granular process management, with the stage level newly added. + - Enabled custom combinations and sequences of sections, increasing flexibility and operational customization under specific conditions. + - Redesigned document normalization sections to better accommodate diverse document processing operations. + +- Deep Learning Integration + - Improved the reading rate of 1D barcode by introducing a new deblurring deep-learning model. + - Enhanced text recognition capabilities with deep learning-based text-line recognition. + +- Algorithm Enhancements + - Enabled deduplication at the Region of Interest (ROI) level to consolidate results from multiple tasks. + - Enhanced the text recognition workflow by integrating improved multi-step recognition processes and validation methods. + - Improved the CODE_128 and DataMatrix DeepAnalysis algorithms for better decoding accuracy and performance. + - Added support for new barcode types: CODE_32, MATRIX_25, KIX, and TELEPEN. + - Added GS1 Application Identifiers (AI) support for improved code parsing capabilities. + +- Engineering Optimizations + - Unified template-loading logic to reduce I/O overhead. + - Implemented conversion functionality between `ImageData` and image files, including both on-disk and in-memory files. diff --git a/programming/flutter/release-notes/index.md b/programming/flutter/release-notes/index.md new file mode 100644 index 0000000..a6512b9 --- /dev/null +++ b/programming/flutter/release-notes/index.md @@ -0,0 +1,13 @@ +--- +layout: default-layout +title: Flutter Release Notes - Dynamsoft Capture Vision Flutter SDK +description: This is the release notes page of Dynamsoft Capture Vision for Flutter SDK. +keywords: release notes, Flutter +needAutoGenerateSidebar: false +breadcrumbText: Release Notes +--- + +# Dynamsoft Capture Vision Flutter SDK - Release Notes + +- [3.2.3000 (11/06/2025)]({{ site.dcv_flutter }}release-notes/flutter-3.html#323000-11062025) +- [3.0.5200 (08/28/2025)]({{ site.dcv_flutter }}release-notes/flutter-3.html#305200-08282025) diff --git a/programming/flutter/samples/index.md b/programming/flutter/samples/index.md new file mode 100644 index 0000000..463ef5a --- /dev/null +++ b/programming/flutter/samples/index.md @@ -0,0 +1,56 @@ +--- +layout: default-layout +title: Demo & Samples - Dynamsoft Capture Vision Flutter Edition +description: The index of Dynamsoft Capture Vision Flutter demo & samples. +keywords: demo, sample, index, Flutter, capture vision +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# Demo and Samples + +All of the samples that have been created for the Dynamsoft Capture Vision Flutter Edition are hosted in this Github repo. Feel free to use these samples as reference when building your own Flutter app. + +## Read Barcodes + +### ScanBarcodes_FoundationalAPI + +This is a sample that demonstrates the simplest implementation of the Capture Vision to allow for barcode decoding via the camera using the [Foundational API]({{ site.dbr_react_native_api }}). + +[Check code on GitHub](https://github.com/Dynamsoft/barcode-reader-flutter-samples/tree/main/ScanBarcodes_FoundationalAPI){:target="_blank"} + +### ScanDriverLicense + +This sample demonstrates the simplest implementation of the Capture Vision for recognizing a PDF417 barcode from video streaming and extracting structured data from its encoded data. + +[Check code on GitHub](https://github.com/Dynamsoft/barcode-reader-flutter-samples/tree/main/ScanDriversLicense){:target="_blank"} + +## Scan Documents + +Detect & Deskew the document pages. You can edit the document boundaries if required. + +[Check code on GitHub](https://github.com/Dynamsoft/capture-vision-flutter-samples/tree/main/ScanDocument) + +## Scan MRZ + +Scan the MRZ code of a passport or an ID card and parse the information. + +[Check code on GitHub](https://github.com/Dynamsoft/capture-vision-flutter-samples/tree/main/ScanMRZ) + +## Scan VIN + +Scan the vin barcode or text and extract the vehicle information. + +[Check code on GitHub](https://github.com/Dynamsoft/capture-vision-flutter-samples/tree/main/ScanVIN) + +## Demos + +If you would like to see the Capture Vision in action before starting the development journey, we have a demo app available on both the App Store as well as the Google Play Store. + +- Barcode Scanner Demo + - [View in Google Play Store](https://play.google.com/store/apps/details?id=com.dynamsoft.demo.dynamsoftbarcodereaderdemo&pli=1){:target="_blank"} + - [Download APK](https://download2.dynamsoft.com/dbr/android/DynamsoftBarcodeReaderDemoAndroid.apk) + - [View in App Store](https://apps.apple.com/us/app/dynamsoft-barcode-scanner-demo/id1120581630){:target="_blank"} +- MRZ Scanner Demo + - [View in Google Play Store](https://play.google.com/store/apps/details?id=com.dynamsoft.mrzscanner){:target="_blank"} + - [View in Apple Store](https://apps.apple.com/us/app/dynamsoft-mrz-scanner/id6736854735){:target="_blank"} diff --git a/programming/ios/api-reference/core/basic-structures/captured-result-base.md b/programming/ios/api-reference/core/basic-structures/captured-result-base.md index f9bd49b..7d987d9 100644 --- a/programming/ios/api-reference/core/basic-structures/captured-result-base.md +++ b/programming/ios/api-reference/core/basic-structures/captured-result-base.md @@ -6,7 +6,6 @@ keywords: captured result base, objective-c, swift needGenerateH3Content: true needAutoGenerateSidebar: true noTitleIndex: true -ignore: true --- # DSCapturedResultBase diff --git a/programming/maui/api-reference/core/captured-result-base.md b/programming/maui/api-reference/core/captured-result-base.md index a81ae67..d1c0589 100644 --- a/programming/maui/api-reference/core/captured-result-base.md +++ b/programming/maui/api-reference/core/captured-result-base.md @@ -6,7 +6,6 @@ keywords: captured result base, MAUI needGenerateH3Content: true needAutoGenerateSidebar: true noTitleIndex: true -ignore: true --- # CapturedResultBase diff --git a/programming/react-native/api-reference/capture-vision-router/capture-vision-router.md b/programming/react-native/api-reference/capture-vision-router/capture-vision-router.md new file mode 100644 index 0000000..d9902b9 --- /dev/null +++ b/programming/react-native/api-reference/capture-vision-router/capture-vision-router.md @@ -0,0 +1,481 @@ +--- +layout: default-layout +title: CaptureVisionRouter - Dynamsoft Capture Vision React Native +description: CaptureVisionRouter class of Dynamsoft Capture Vision Router contains all of the core methods to use Dynamsoft Capture Vision. +keywords: CaptureVisionRouter, Barcode Reader, capture, react native, foundational +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: CaptureVisionRouter +--- + +# CaptureVisionRouter Class + +The `CaptureVisionRouter` class defines how a user interacts with image-processing and semantic-processing Dynamsoft products in their applications. + +A `CaptureVisionRouter` instance accepts and processes images from an image source and returns processing results which may contain final results or intermediate results. The instance can also process video frames coming from a camera or a different image source as well, therefore providing the ability to capture results via an interactive video scenario or from static images. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +class CaptureVisionRouter +``` + +## Static Properties + +Returns the singleton instance of `CaptureVisionRouter`. + +```js +static CaptureVisionRouter get instance; +``` + +## Methods + +Constructor + +| Method | Description | +| ------ | ----------- | +| [`getInstance`](#getinstance) | Get the singleton instance of `CaptureVisionRouter`. | + +Capture from an Image + +| Method | Description | +| ------ | ----------- | +| [`capture`](#capture) | Processes an image using the specified template and outputs a CapturedResult. | +| [`captureFile`](#capturefile) | Processes an image from a file path using the specified template. | +| [`captureFileBytes`](#capturefilebytes) | Processes an image from a byte array using the specified template. | + +Process Multiple Images + +| Method | Description | +| ------ | ----------- | +| [`addFilter`](#addfilter) | Adds a result filter to process the captured results. | +| [`addResultReceiver`](#addresultreceiver) | Adds a result receiver that listens for any captured results. | +| [`removeAllResultFilters`](#removeallresultfilters) | Removes all the result filters from the Capture Vision Router instance. | +| [`removeAllResultReceivers`](#removeallresultreceivers) | Removes all result receivers from the Capture Vision Router instance. | +| [`removeResultFilter`](#removeresultfilter) | Removes a previously added result filter. | +| [`removeResultReceiver`](#removeresultreceiver) | Removes a previously added result receiver. | +| [`setInput`](#setinput) | Sets up an image source to provide images for continuous processing. | +| [`startCapturing`](#startcapturing) | Starts the capturing process using the specified template. | +| [`stopCapturing`](#stopcapturing) | Stops the capturing process and closes the camera. | +| [`switchCapturingTemplate`](#switchcapturingtemplate) | Switches the template used by the Capture Vision Router instance to the specified template name. | + +Settings + +| Method | Description | +| ------ | ----------- | +| [`clearDLModelBuffers`](#cleardlmodelbuffers) | Clears the buffer used by deep learning models to free up memory. | +| [`getSimplifiedSettings`](#getsimplifiedsettings) | Returns a simplified version of the Capture Vision settings for a specific template. | +| [`getTemplateNames`](#gettemplatenames) | Returns An array of all currently available Capture Vision template names. | +| [`initSettings`](#initsettings) | Initializes the settings using a JSON template string. | +| [`initSettingsFromFile`](#initsettingsfromfile) | Initializes the settings using a JSON template file. | +| [`outputSettings`](#outputsettings) | Outputs the specified template's settings as a JSON string. | +| [`outputSettingsToFile`](#outputsettingstofile) | Outputs the specified template's settings to a JSON file. | +| [`resetSettings`](#resetsettings) | Resets all settings to their default values. | +| [`updateSettings`](#updatesettings) | Updates the specified template settings using a `SimplifiedCaptureVisionSettings` object. | +| [`setGlobalIntraOpNumThreads`](#setglobalintraopnumthreads) | Sets the global number of threads used internally by the library for model execution. | + +Intermediate Results + +| Method | Description | +| ------ | ----------- | +| [`getIntermediateResultManager`](#getintermediateresultmanager) | Retrieves the IntermediateResultManager instance. | + +### getInstance + +Returns the singleton instance of `CaptureVisionRouter`. + +```js +getInstance(): CaptureVisionRouter +``` + +**Returns** + +The singleton instance of `CaptureVisionRouter`. + +### capture + +Processes an image using the specified template. + +```js +capture( + imageData: ImageData, + template?: string, +): undefined | null | CapturedResult +``` + +**Parameters** + +`[in] imageData`: A [`ImageData`]({{ site.dcv_react_native_api }}core/image-data.html) object that contains image info. + +`[in] templateName`: Specifies a "CaptureVisionTemplate" to use. The following value are available for this parameter: + +- One of the [`EnumPresetTemplate`]({{ site.dcv_react_native_api }}core/enum/preset-template.html) member. This is available only if you have never upload a new template via `initSettings` or `initSettingsFromFile`. +- A string that represents one of the template name that you have uploaded via `initSettings` or `initSettingsFromFile`. +- "" (empty string) to use the default template. The first template will be used if you have uploaded a template file via `initSettingsFromFile` or `initSettings`. + +### captureFile + +Processes an image from a file (specified by a file path) using the specified template. + +```js +captureFile( + filePath: string, + template?: string, +): undefined | null | CapturedResult +``` + +**Parameters** + +`[in] filePath`: The file path and name that you want to capture data from. You have to specify the file name with extension name in the `filePath`. Supported file type includes ".bmp", ".jpg", ".png", ".gif" or one-page ".tiff". + +`[in] templateName`: Specifies a "CaptureVisionTemplate" to use. The following value are available for this parameter: + +- One of the [`EnumPresetTemplate`]({{ site.dcv_react_native_api }}core/enum/preset-template.html) member. This is available only if you have never upload a new template via `initSettings` or `initSettingsFromFile`. +- A string that represents one of the template name that you have uploaded via `initSettings` or `initSettingsFromFile`. +- "" (empty string) to use the default template. The first template will be used if you have uploaded a template file via `initSettingsFromFile` or `initSettings`. + +### captureFileBytes + +Processes an image from a byte array using the specified template. + +```js +captureFileBytes( + fileBytes: ArrayBuffer, + template?: string, +): undefined | null | CapturedResult +``` + +**Parameters** + +`[in] bytes`: A byte array that points to a file in memory. + +`[in] templateName`: Specifies a "CaptureVisionTemplate" to use. The following value are available for this parameter: + +- One of the [`EnumPresetTemplate`]({{ site.dcv_react_native_api }}core/enum/preset-template.html) member. This is available only if you have never upload a new template via `initSettings` or `initSettingsFromFile`. +- A string that represents one of the template name that you have uploaded via `initSettings` or `initSettingsFromFile`. +- "" (empty string) to use the default template. The first template will be used if you have uploaded a template file via `initSettingsFromFile` or `initSettings`. + +### addFilter + +Adds a result filter to process the captured results. This filter is of type [`MultiFrameResultCrossFilter`](multi-frame-cross-filter.md). Supported filters: + +- Cross-Verification: Improve the accuracy by cross-verifying the results. +- De-duplication: Removes the duplicated results. +- Overlapping: Improve the read-rate of multiple barcode scanning by overlaping the results. + +```js +addFilter(filter: CapturedResultFilter): CapturedResultFilter +``` + +### addResultReceiver + +Adds a [`CapturedResultReceiver`]({{ site.dcv_react_native_api }}capture-vision-router/captured-result-receiver.html) object as the receiver of captured results. + +```js +addResultReceiver(receiver: CapturedResultReceiver): CapturedResultReceiver +``` + +### removeAllResultListeners + +Removes all result listeners from the Capture Vision Router instance. + +```js +removeAllResultListeners(): void +``` + +### removeFilter + +Removes a previously added result filter. + +```js +removeFilter(filter: CapturedResultFilter): void +``` + +### removeResultReceiver + +Removes a previously added result receiver. + +```js +removeResultReceiver(receiver: CapturedResultReceiver): void +``` + +### setInput + +Sets up an image source to provide images for continuous processing. This method is mainly used when configuring a camera (via the [`CameraEnhancer`]({{ site.dce_react_native_api }}camera-enhancer.html)) as an input source. + +```js +setInput(input: ImageSourceAdapter): void +``` + +**Parameters** + +`[in] imageSourceAdapter`: An object of [`ImageSourceAdapter`]({{ site.dcv_react_native_api }}core/image-source-adapter.html). + +You can use the following officially implemented `ImageSourceAdapter` classes: + +- [`CameraEnhancer`]({{ site.dce_react_native_api }}camera-enhancer.html): A camera class that can capture video frames continuously. + +**Exception** + +| Error Code | Value | Description | +| :--------- | :---- | :---------- | +| EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. | + +### startCapturing + +Starts the capturing process using the specified template. Any result(s) that are received while the capture process is underway will be relayed by a result receiver, which is a callback function that is triggered once a captured result is found. + +```js +startCapturing(templateName?: undefined | null | string): Promise +``` + +**Parameters** + +`[in] templateName`: Specifies a "CaptureVisionTemplate" to use. The following value are available for this parameter: + +- One of the [`EnumPresetTemplate`]({{ site.dcv_react_native_api }}core/enum/preset-template.html) member. This is available only if you have never upload a new template via `initSettings` or `initSettingsFromFile`. +- A string that represents one of the template name that you have uploaded via `initSettings` or `initSettingsFromFile`. +- "" (empty string) to use the default template. The first template will be used if you have uploaded a template file via `initSettingsFromFile` or `initSettings`. + +### stopCapturing + +Stops the capturing process. + +```js +stopCapturing(): Promise +``` + +### switchCapturingTemplate + +Switch the image processing settings with the CaptureVisionTemplate name during the image processing workflow. + +```js +switchCapturingTemplate(templateName: string): Promise +``` + +**Parameters** + +`[in] templateName`: Specifies a "CaptureVisionTemplate" to use. The following value are available for this parameter: + +- One of the [`EnumPresetTemplate`]({{ site.dcv_react_native_api }}core/enum/preset-template.html) member. This is available only if you have never upload a new template via `initSettings` or `initSettingsFromFile`. +- A string that represents one of the template name that you have uploaded via `initSettings` or `initSettingsFromFile`. +- "" (empty string) to use the default template. The first template will be used if you have uploaded a template file via `initSettingsFromFile` or `initSettings`. + +**Exception** + +| Error Code | Value | Description | +| :--------- | :---- | :---------- | +| EC_TEMPLATE_NAME_INVALID | -10036 | The target template name is invalid. | + +### getSimplifiedSettings + +Returns a subset of the full applied settings as a [`SimplifiedCaptureVisionSettings`](simplified-capture-vision-settings.md) object. This object contains the simplified settings of the Capture Vision Router instance, which in turn contains the simplified settings of the functional product used. + +```js +getSimplifiedSettings( + templateName?: undefined | null | string, +): Promise +``` + +**Parameters** + +`[in] templateName`: Specifies a "CaptureVisionTemplate" to use. The following value are available for this parameter: + +- One of the [`EnumPresetTemplate`]({{ site.dcv_react_native_api }}core/enum/preset-template.html) member. This is available only if you have never upload a new template via `initSettings` or `initSettingsFromFile`. +- A string that represents one of the template name that you have uploaded via `initSettings` or `initSettingsFromFile`. +- "" (empty string) to use the default template. The first template will be used if you have uploaded a template file via `initSettingsFromFile` or `initSettings`. + +**Exception** + +| Error Code | Value | Description | +| :--------- | :---- | :---------- | +| EC_TEMPLATE_NAME_INVALID | -10036 | The target template name is invalid. | +| EC_CONVERT_COMPLEX_TEMPLATE_ERROR | -10061 | The template you specified is a complex template which can not be output as a `SimplifiedCaptureVisionSettings` object. | +| EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. | + +### initSettings + +Initializes the settings of the `CaptureVisionRouter` instance using a JSON template (as a JSON string). To learn how to use a customized JSON template, please refer to this [section of the Foundational User Guide]({{ site.dbr_react_native }}foundational-user-guide.html#using-a-json-template). + +```js +initSettings(content: string): Promise +``` + +**Parameters** + +`[in] content`: A JSON string that contains Capture Vision settings. + +**Exception** + +| Error Code | Value | Description | +| :--------- | :---- | :---------- | +| EC_JSON_PARSE_FAILED | -10030 | Failed to parse the JSON data. | +| EC_JSON_TYPE_INVALID | -10031 | One or more parameters are allocated with wrong data type. | +| EC_JSON_KEY_INVALID | -10032 | There exists invalid key in your JSON data. | +| EC_JSON_VALUE_INVALID | -10033 | There exists invalid parameter value in your JSON data. | +| EC_JSON_NAME_KEY_MISSING | -10034 | One or more `name` parameters are missing in your JSON data. Each section of the JSON data requires a unique `name` parameter. | +| EC_JSON_NAME_VALUE_DUPLICATED | -10035 | There exists duplicated `name` parameters in your JSON data. The `name` parameter should be unique. | +| EC_JSON_NAME_REFERENCE_INVALID | -10037 | You have referenced an invalid `name` value in your JSON data. | +| EC_PARAMETER_VALUE_INVALID | -10038 | There exists invalid parameter value in your JSON data. | +| EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. | + +### initSettingsFromFile + +Initializes the settings of the `CaptureVisionRouter` instance using a JSON template (as a JSON file). To learn how to use a customized JSON template, please refer to this [section of the Foundational User Guide]({{ site.dbr_react_native }}foundational-user-guide.html#using-a-json-template). + +```js +initSettingsFromFile(file: string): Promise +``` + +**Parameters** + +`[in] filePath`: A JSON file that contains Capture Vision settings. + +**Exception** + +| Error Code | Value | Description | +| :--------- | :---- | :---------- | +| EC_FILE_NOT_FOUND | -10005 | The file is not found. | +| EC_JSON_PARSE_FAILED | -10030 | Failed to parse the JSON data. | +| EC_JSON_TYPE_INVALID | -10031 | One or more parameters are allocated with wrong data type. | +| EC_JSON_KEY_INVALID | -10032 | There exists invalid key in your JSON data. | +| EC_JSON_VALUE_INVALID | -10033 | There exists invalid parameter value in your JSON data. | +| EC_JSON_NAME_KEY_MISSING | -10034 | One or more `name` parameters are missing in your JSON data. Each section of the JSON data requires a unique `name` parameter. | +| EC_JSON_NAME_VALUE_DUPLICATED | -10035 | There exists duplicated `name` parameters in your JSON data. The `name` parameter should be unique. | +| EC_JSON_NAME_REFERENCE_INVALID | -10037 | You have referenced an invalid `name` value in your JSON data. | +| EC_PARAMETER_VALUE_INVALID | -10038 | There exists invalid parameter value in your JSON data. | +| EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. | + +### outputSettings + +Outputs the specified Capture Vision template's settings as a JSON string. If `includeDefaultValues` is set to true, the output will include the default settings values. + +```js +outputSettings( + templateName: string, + includeDefaultValues: boolean, +): Promise +``` + +**Parameters** + +`[in] templateName`: The name of the template that you want to output. + +- One of the [`EnumPresetTemplate`]({{ site.dcv_react_native_api }}core/enum/preset-template.html) member. This is available only if you have never upload a new template via `initSettings` or `initSettingsFromFile`. +- A string that represents one of the template name that you have uploaded via `initSettings` or `initSettingsFromFile`. +- "" (empty string) to use the default template. The first template will be used if you have uploaded a template file via `initSettingsFromFile` or `initSettings`. + +`[in] includeDefaultValues`: A boolean value that indicates whether to include default values in the output. + +**Exception** + +| Error Code | Value | Description | +| :--------- | :---- | :---------- | +| EC_TEMPLATE_NAME_INVALID | -10036 | The target template name is invalid. | +| EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. | + +### outputSettingsToFile + +Outputs the specified Capture Vision template's settings to a JSON file. If `includeDefaultValues` is set to true, the output will include the default settings values. + +```js +outputSettingsToFile( + templateName: string, + file: string, + includeDefaultValues: boolean, +): Promise +``` + +**Parameters** + +`[in] templateName`: The name of the template that you want to output. + +- One of the [`EnumPresetTemplate`]({{ site.dcv_react_native_api }}core/enum/preset-template.html) member. This is available only if you have never upload a new template via `initSettings` or `initSettingsFromFile`. +- A string that represents one of the template name that you have uploaded via `initSettings` or `initSettingsFromFile`. +- "" (empty string) to use the default template. The first template will be used if you have uploaded a template file via `initSettingsFromFile` or `initSettings`. + +`[in] file`: The file path and name that you want to save the template. + +`[in] includeDefaultValues`: A boolean value that indicates whether to include default values in the output. + +**Exception** + +| Error Code | Value | Description | +| :--------- | :---- | :---------- | +| EC_FILE_SAVE_FAILED | -10058 | The file path is unavailable or the file can't be created for any other reasons. | +| EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. | + +### resetSettings + +Resets all of the settings to their default values. + +```js +resetSettings(): Promise +``` + +**Exception** + +| Error Code | Value | Description | +| :--------- | :---- | :---------- | +| EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. | + +### updateSettings + +Updates the specified template settings of the `CaptureVisionRouter` instance using a [`SimplifiedCaptureVisionSettings`](simplified-capture-vision-settings.md) object. To learn how to update the settings using the SimplifiedCaptureVisionSettings class - please refer to this [section of the Foundational User Guide]({{ site.dbr_react_native }}foundational-user-guide.html#using-simplifiedcapturevisionsettings). + +```js +updateSettings( + settings?: null | SimplifiedCaptureVisionSettings, + templateName?: undefined | null | string, +): Promise +``` + +**Parameters** + +`[in] templateName`: Specify the name of the template that you want to update. + +- One of the [`EnumPresetTemplate`]({{ site.dcv_react_native_api }}core/enum/preset-template.html) member. This is available only if you have never upload a new template via `initSettings` or `initSettingsFromFile`. +- A string that represents one of the template name that you have uploaded via `initSettings` or `initSettingsFromFile`. +- "" (empty string) to use the default template. The first template will be used if you have uploaded a template file via `initSettingsFromFile` or `initSettings`. + +`[in] settings`: An object of `SimplifiedCaptureVisionSettings`. + +**Exception** + +| Error Code | Value | Description | +| :--------- | :---- | :---------- | +| EC_TEMPLATE_NAME_INVALID | -10036 | The target template name is invalid. | +| EC_PARAMETER_VALUE_INVALID | -10038 | There exists invalid parameter value in your `SimplifiedCaptureVisionSettings`. | +| EC_CONVERT_COMPLEX_TEMPLATE_ERROR | -10061 | The template you specified is a complex template which can not be updated via a `SimplifiedCaptureVisionSettings` object. | +| EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. | + +### setGlobalIntraOpNumThreads + +Sets the global number of threads used internally by the library for model execution. This parameter could help regulate the resources needed to operate the Capture Vision Router instance. + +```js +static setGlobalIntraOpNumThreads(intraOpNumThreads: number) +``` + +**Parameters** + +`intraOpNumThreads`: Number of threads used internally for model execution. Valid range: [0, 256]. Default: 2. + +### clearDLModelBuffers + +Clears the buffer used by deep learning models to free up memory and resources used by the Capture Vision Router instance for its operation. + +```js +static clearDLModelBuffers() +``` + +### getIntermediateResultManager + +Retrieves the [`IntermediateResultManager`](intermediate-result-manager.md) instance. + +```js +getIntermediateResultManager(): IntermediateResultManager +``` diff --git a/programming/react-native/api-reference/capture-vision-router/captured-result-filter.md b/programming/react-native/api-reference/capture-vision-router/captured-result-filter.md new file mode 100644 index 0000000..4f67a82 --- /dev/null +++ b/programming/react-native/api-reference/capture-vision-router/captured-result-filter.md @@ -0,0 +1,21 @@ +--- +layout: default-layout +title: CapturedResultFilter - Dynamsoft Capture Vision React Native +description: CapturedResultFilter interface of DCV React Native provides a filter for managing and filtering results. +keywords: filter, capture vision, barcode reader, react native, multiframeresultcrossfilter, result +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# CapturedResultFilter + +Interface `CapturedResultFilter` is responsible for filtering captured results. It is officially implemented as [MultiFrameResultCrossFilter](../utility/multi-frame-cross-filter.md). + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +interface CapturedResultFilter +``` diff --git a/programming/react-native/api-reference/capture-vision-router/captured-result-receiver.md b/programming/react-native/api-reference/capture-vision-router/captured-result-receiver.md new file mode 100644 index 0000000..759a30f --- /dev/null +++ b/programming/react-native/api-reference/capture-vision-router/captured-result-receiver.md @@ -0,0 +1,91 @@ +--- +layout: default-layout +title: CapturedResultReceiver Interface - Dynamsoft Capture Vision React Native +description: CapturedResultReceiver interface of DCV React Native edition is designed as a standardized way for retrieving captured results. +keywords: decoded barcodes, parsed results, captured results, CRR, result receiver, output, react native, barcode reader +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# CapturedResultReceiver + +The `CapturedResultReceiver` interface is designed as a standardized way for retrieving captured results in the Dynamsoft Capture Vision architecture. By implementing the `CapturedResultReceiver`, you will receive the callback of the various types of *captured results*, such a decoded barcode (Barcode Reader), a recognized text line (Label Recognizer), a detected quad (Document Normalizer), a normalized image (Document Normalizer), or parsed data (Code Parser). The `CapturedResultReceiver` can add a receiver for any type of captured result or for a specific type of captured result, based on the method that is implemented. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +interface CapturedResultReceiver +``` + +## Methods + +| Method | Description | +| ------ | ----------- | +| [`onCapturedResultReceived`](#oncapturedresultreceived) | The callback invoked when captured results become available. It is triggered once for each image after its processing is completed. | +| [`onDecodedBarcodesReceived`](#ondecodedbarcodesreceived) | The callback invoked when decoded barcodes become available. It is triggered once for each image after its processing is completed. | +| [`onParsedResultsReceived`](#onparsedreultsreceived) | The callback invoked when parsed results become available. It is triggered once for each image after its processing is completed.| +| [`onProcessedDocumentResultReceived`](#onparsedreultsreceived) | The callback invoked when processed document results become available. It is triggered once for each image after its processing is completed. | +| [`onRecognizedTextLinesReceived`](#onparsedreultsreceived) | The callback invoked when recognized text lines become available. It is triggered once for each image after its processing is completed. | + +### onCapturedResultReceived + +This callback method delivers a [`CapturedResult`](captured-result.md) - an object representing any kind of captured result item that is captured from an image or a video frame. The callback is triggered each time an image finishes processing, regardless of whether there is a valid result or not. + +```js +onCapturedResultReceived?: (result: CapturedResult) => void; +``` + +**Parameters** + +`result`: The captured result, an instance of [`CapturedResult`](captured-result.md). + +### onDecodedBarcodesReceived + +This callback method delivers a [`DecodedBarcodesResult`]({{ site.dbr_react_native_api }}barcode-reader/decoded-barcodes-result.html), which is an object representing any captured result of type `barcode` that is taken from an image or a video frame. The callback is triggered each time an image finishes processing, regardless of whether there is a valid result or not. + +```js +onDecodedBarcodesReceived?: (result: DecodedBarcodesResult) => void; +``` + +**Parameters** + +`result`: The decoded barcode result, an instance of [`DecodedBarcodesResult`]({{ site.dbr_react_native_api }}barcode-reader/decoded-barcodes-result.html). + +### onParsedReultsReceived + +This callback method delivers a [`ParsedResult`]({{ site.dcp_react_native_api }}parsed-result.html), which is an object representing any captured result of type `parsedResult` that is taken from an image or a video frame. The callback is triggered each time an image finishes processing, regardless of whether there is a valid result or not. + +```js +onParsedResultsReceived?: (result: ParsedResult) => void; +``` + +**Parameters** + +`result`: The parsed result, an instance of [`ParsedResult`]({{ site.dcp_react_native_api }}parsed-result.html). + +### onProcessedDocumentResultReceived + +This callback method delivers a [`ProcessedDocumentResult`]({{ site.ddn_react_native_api }}processed-document-result.html), which is an object representing any captured result of type `detectedQuad`, `deskewedImage` and `enhancedImage` that is taken from an image or a video frame. The callback is triggered each time an image finishes processing, regardless of whether there is a valid result or not. + +```js +onProcessedDocumentResultReceived?: (result: ProcessedDocumentResult) => void; +``` + +**Parameters** + +`result`: The document processing results, an instance of [`ProcessedDocumentResult`]({{ site.ddn_react_native_api }}processed-document-result.html). + +### onRecognizedTextLinesReceived + +This callback method delivers a [`RecognizedTextLinesResult`]({{ site.dlr_react_native_api }}recognized-text-lines-result.html), which is an object representing any captured result of type `recognizedTextLines` that is taken from an image or a video frame. The callback is triggered each time an image finishes processing, regardless of whether there is a valid result or not. + +```js +onRecognizedTextLinesReceived?: (result: RecognizedTextLinesResult) => void; +``` + +**Parameters** + +`result`: The text recognition result, an instance of [`RecognizedTextLinesResult`]({{ site.dlr_react_native_api }}recognized-text-lines-result.html). diff --git a/programming/react-native/api-reference/capture-vision-router/captured-result.md b/programming/react-native/api-reference/capture-vision-router/captured-result.md new file mode 100644 index 0000000..8cd925b --- /dev/null +++ b/programming/react-native/api-reference/capture-vision-router/captured-result.md @@ -0,0 +1,112 @@ +--- +layout: default-layout +title: CapturedResult - Dynamsoft Capture Vision React Native +description: CapturedResult interface of DCV React Native edition represents the result of a capture operation on an image. +keywords: decoded barcode, parsed result, error code, output, captured result, react native, barcode reader +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# CapturedResult + +Interface `CapturedResult` represents the result of a capture operation on an image. Internally, `CapturedResult` stores an array of [`CapturedResultItem`](../core/captured-result-item.md), each of which may be a barcode, text line, detected quad, normalized image, original image, or parsed item depending on the functional product that is used. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +interface CapturedResult extends CapturedResultBase +``` + +## Properties + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`decodedBarcodesResult`](#decodedbarcodesresult) | [*DecodedBarcodesResult*]({{ site.dbr_react_native_api }}barcode-reader/decoded-barcodes-result.html) | All results of type `barcode` in the `CapturedResult` as a `DecodedBarcodesResult` object. | +| [`items`](#items) | *Array\ * | The rotation transformation matrix of the original image relative to the rotated image. | + +### decodedBarcodesResult + +All results of type `barcode` in the `CapturedResult` as a `DecodedBarcodesResult` object. + +```js +decodedBarcodesResult?: DecodedBarcodesResult; +``` + +### items + +An array of [`CapturedResultItem`]({{ site.dcv_react_native_api }}captured-result-item.html) objects. + +```js +items?: CapturedResultItem[]; +``` + +### parsedResult + +All results of type `parsedResult` in the `CapturedResult` as a `ParsedResult` object. + +```js +parsedResult?: ParsedResult; +``` + +#### processedDocumentResult + +All results of type `detectedQuad`, `deskewedImage` and `enhancedImage` in the `CapturedResult` as a `ProcessedDocumentResult` object. + +```js +processingDocumentResult?: ProcessedDocumentResult; +``` + +### recognizedTextLinesResult + +All results of type `textLine` in the `CapturedResult` as a `RecognizedTextLinesResult` object. + +```js +recognizedTextLinesResult?: RecognizedTextLinesResult; +``` + +### errorCode + +The error code of this result. + +```js +errorCode: number; +``` + +### errorMessage + +The error message of this result. + +```js +errorMessage: string; +``` + +### originalImageHashId + +The hash id of the original image. + +```js +originalImageHashId: string; +``` + +### rotationTransformMatrix + +The rotation transformation matrix of the original image relative to the rotated image. + +```js +rotationTransformMatrix: number[]; +``` diff --git a/programming/react-native/api-reference/capture-vision-router/enum/preset-template.md b/programming/react-native/api-reference/capture-vision-router/enum/preset-template.md new file mode 100644 index 0000000..21fa6a6 --- /dev/null +++ b/programming/react-native/api-reference/capture-vision-router/enum/preset-template.md @@ -0,0 +1,56 @@ +--- +layout: default-layout +title: EnumPresetTemplate - Dynamsoft Capture Vision Router Lite React Native +description: The enumeration PresetTemplate of Dynamsoft Capture Vision Router describes the preset template. +keywords: CaptureVisionTemplate, EnumPresetTemplate, single barcode template, speed first, read-rate first, template, preset +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: EnumPresetTemplate +--- + +# EnumPresetTemplate + +`EnumPresetTemplate` is an enumeration of preset templates that are configured for different recognition tasks, depending on the functional product as well as the desired performance from that functional product. These strings can be used when specifying template name with the [`startCapturing`](../../capture-vision-router/capture-vision-router.md#startcapturing) or [`capture`](../../capture-vision-router/capture-vision-router.md#capture) methods of the [`CaptureVisionRouter`](../../capture-vision-router/capture-vision-router.md). + +## Definition + +*Assembly:* dynamsoft-barcode-reader-bundle-react-native + +```js +enum EnumPresetTemplate { + PT_DEFAULT = "Default", + PT_READ_BARCODES = "ReadBarcodes_Default", + PT_RECOGNIZE_TEXT_LINES = "RecognizeTextLines_Default", + PT_DETECT_DOCUMENT_BOUNDARIES = "DetectDocumentBoundaries_Default", + PT_DETECT_AND_NORMALIZE_DOCUMENT = "DetectAndNormalizeDocument_Default", + PT_NORMALIZE_DOCUMENT = "NormalizeDocument_Default", + PT_READ_BARCODES_SPEED_FIRST = "ReadBarcodes_SpeedFirst", + PT_READ_BARCODES_READ_RATE_FIRST = "ReadBarcodes_ReadRateFirst", + PT_READ_SINGLE_BARCODE = "ReadSingleBarcode", + PT_RECOGNIZE_NUMBERS = "RecognizeNumbers", + PT_RECOGNIZE_LETTERS = "RecognizeLetters", + PT_RECOGNIZE_NUMBERS_AND_LETTERS = "RecognizeNumbersAndLetters", + PT_RECOGNIZE_NUMBERS_AND_UPPERCASE_LETTERS = "RecognizeNumbersAndUppercaseLetters", + PT_RECOGNIZE_UPPERCASE_LETTERS = "RecognizeUppercaseLetters", +} +``` + +## Members + +| Member | Description | +| ------ | ----------- | +| `PT_DEFAULT` | The default template that performs barcode decoding, label recognizing, boundary detecting and document normalizing. The template name is "Default". | +| `PT_READ_BARCODES` | The default template for the Barcode Reader that offers a balance between speed and read rate. | +| `PT_READ_BARCODES_SPEED_FIRST` | The speed first template prioritizes speed over read rate when reading barcodes. | +| `PT_READ_BARCODES_READ_RATE_FIRST` | The read rate first template prioritizes read rate over speed when reading barcodes. | +| `PT_READ_SINGLE_BARCODE` | The single barcode template focuses on the single-scan barcode reading mode and should not be used when reading multiple barcodes at a time as it is more speed focused. | +| `PT_RECOGNIZE_TEXT_LINES` | The default template for the Text Line Recognizer. | +| `PT_DETECT_DOCUMENT_BOUNDARIES` | The default template for the Document Boundary Detector. | +| `PT_DETECT_AND_NORMALIZE_DOCUMENT` | The default template for the Document Normalizer. | +| `PT_NORMALIZE_DOCUMENT` | The default template for the Document Normalizer. | +| `PT_RECOGNIZE_NUMBERS` | The default template for the Number Recognizer. | +| `PT_RECOGNIZE_LETTERS` | The default template for the Letter Recognizer. | +| `PT_RECOGNIZE_NUMBERS_AND_LETTERS` | The default template for the Number and Letter Recognizer. | +| `PT_RECOGNIZE_NUMBERS_AND_UPPERCASE_LETTERS` | The default template for the Number and Uppercase Letter Recognizer. | +| `PT_RECOGNIZE_UPPERCASE_LETTERS` | The default template for the Uppercase Letter Recognizer. | diff --git a/programming/react-native/api-reference/capture-vision-router/intermediate-result-manager.md b/programming/react-native/api-reference/capture-vision-router/intermediate-result-manager.md new file mode 100644 index 0000000..8a6e201 --- /dev/null +++ b/programming/react-native/api-reference/capture-vision-router/intermediate-result-manager.md @@ -0,0 +1,54 @@ +--- +layout: default-layout +title: IntermediateResultManager Class - Dynamsoft Capture Vision React Native +description: IntermediateResultManager class of DCV React Native provides API to retrieve the intermediate results taken during the capture process. +keywords: intermediate, result, capture vision, original image, manager +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# IntermediateResultManager + +The `IntermediateResultManager` class provides the API needed to manage the intermediate results that are produced during the capture process. Currently, the `IntermediateResultManager` is mainly used for when the user wants to retrieve the original image or frame that the captured result is taken from, especially in an interactive video scenario where the input is a camera feed. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +class IntermediateResultManager +``` + +## Methods + +| Method | Description | +| ------ | ----------- | +| [`getOriginalImage`](#getoriginalimage) | Retrieves the original image (as an ImageData object) associated with the captured result. | + +### getOriginalImage + +Retrieves the original image (as an ImageData object) associated with the captured result, based on the `originalImageHashId` of the [`CapturedResult`](captured-result.md). + +```js +getOriginalImage(imageHashId: string): ImageData +``` + +**Remarks** + +In order to get the hashID input parameter, please access the `originalImageHashId` of the [`CapturedResult`](captured-result.md). The `CapturedResult` can be a [`DecodedBarcodesResult`]({{ site.dbr_react_native_api }}barcode-reader/decoded-barcodes-result.html) (if the Barcode Reader is used) and so the `originalImageHashId` can be obtained from the `DecodedBarcodesResult` object directly since it extends the `CapturedResult` class. + +The method returns a [`ImageData`]({{ site.dcv_react_native_api }}core/image-data.html) object which contains all the info of the original image, including a byte array to represent the raw image. + +## Code Snippet + +```js +let router = CaptureVisionRouter.getInstance(); +let intermediateResultManager = router.getIntermediateResultManager() +router.addResultReceiver({ + onCaptureResultReceive: result => { + let imageData = intermediateResultManager.getOriginalImage(result.originalImageHashId) + //... + } +}); +``` diff --git a/programming/react-native/api-reference/capture-vision-router/simplified-capture-vision-settings.md b/programming/react-native/api-reference/capture-vision-router/simplified-capture-vision-settings.md new file mode 100644 index 0000000..e22a369 --- /dev/null +++ b/programming/react-native/api-reference/capture-vision-router/simplified-capture-vision-settings.md @@ -0,0 +1,107 @@ +--- +layout: default-layout +title: SimplifiedCaptureVisionSettings - Dynamsoft Capture Vision React Native +description: SimplifiedCaptureVisionSettings interface of DCV React Native edition provides settings for capturing and recognizing images with the CaptureVisionRouter class. +keywords: roi, result item type, min interval, timeout, react native, settings, foundational +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# SimplifiedCaptureVisionSettings + +Interface `SimplifiedCaptureVisionSettings` contains the general settings for all of the Capture Vision functional products (Barcode Reader, Label Recognizer, Document Normalizer, Code Parser). These settings can help for capturing and recognizing images with the `CaptureVisionRouter` class. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +interface SimplifiedCaptureVisionSettings +``` + +## Properties + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`barcodeSettings`](#barcodesettings) | *[SimplifiedBarcodeReaderSettings]({{ site.dbr_react_native_api }}barcode-reader/simplified-barcode-reader-settings.html)* | The settings for the `DynamsoftBarcodeReader` tasks. | +| [`documentSettings`](#documentsettings) | *[SimplifiedDocumentNormalizerSettings]({{ site.ddn_react_native_api }}simplified-document-normalizer-settings.html)* | The settings for the `DynamsoftBarcodeReader` tasks. | +| [`labelSettings`](#labelsettings) | *[SimplifiedLabelRecognizerSettings]({{ site.dlr_react_native_api }}simplified-label-recognizer-settings.html)* | The settings for the `DynamsoftBarcodeReader` tasks. | +| [`maxParallelTasks`](#maxparalleltasks) | *number* | Determines the maximum number of parallel tasks allowed for image capture and recognition. | +| [`minImageCaptureInterval`](#minimagecaptureinterval) | *number* | Sets the minimum interval (in milliseconds) between image captures. | +| [`outputOriginalImage`](#outputoriginalimage) | *boolean* | Specifies whether to output the original image. | +| [`roi`](#roi) | *Quadrilateral* | Sets the region of interest (ROI) when reading from a camera or a static image. | +| [`roiMeasuredInPercentage`](#roimeasuredinpercentage) | *boolean* | Establishes whether the ROI is measured in pixels or as a percentage of the image/frame size. | +| [`timeout`](#timeout) | *number* | Specifies the maximum time (in milliseconds) allowed for image capture and recognition. | + +### barcodeSettings + +The settings for the `DynamsoftBarcodeReader` tasks as a [`SimplifiedBarcodeReaderSettings`]({{ site.dbr_react_native_api }}barcode-reader/simplified-barcode-reader-settings.html) object. + +```js +barcodeSettings?: SimplifiedBarcodeReaderSettings; +``` + +### documentSettings + +The settings for the `DynamsoftDocumentNormalizer` tasks as a [`SimplifiedDocumentNormalizerSettings`]({{ site.ddn_react_native_api }}simplified-document-normalizer-settings.html) object. + +```js +documentSettings?: SimplifiedDocumentNormalizerSettings; +``` + +### labelSettings + +The settings for the `DynamsoftLabelRecognizer` tasks as a [`SimplifiedLabelRecognizerSettings`]({{ site.dlr_react_native_api }}simplified-label-recognizer-settings.html) object. + +```js +labelSettings?: SimplifiedLabelRecognizerSettings; +``` + +### maxParallelTasks + +Determines the maximum number of parallel tasks allowed for image capture and recognition. + +```js +maxParallelTasks?: number; +``` + +### minImageCaptureInterval + +Sets the minimum interval (in milliseconds) between image captures. + +```js +minImageCaptureInterval?: number; +``` + +### outputOriginalImage + +Specifies whether to output the original image. + +```js +outputOriginalImage?: boolean; +``` + +### roi + +Sets the region of interest (ROI) when reading from a camera or a static image. If the camera is being used, any scan region that is set will be represented visually on the camera view. + +```js +roi?: Quadrilateral; +``` + +### roiMeasuredInPercentage + +Specifies whether the region of interest (ROI) is measured in pixels or as a percentage of the image size. + +```js +roiMeasuredInPercentage?: boolean; +``` + +### timeout + +Specifies the maximum time (in milliseconds) allowed for image capture and recognition. + +```js +timeout?: number; +``` diff --git a/programming/react-native/api-reference/core/captured-result-base.md b/programming/react-native/api-reference/core/captured-result-base.md new file mode 100644 index 0000000..3af2393 --- /dev/null +++ b/programming/react-native/api-reference/core/captured-result-base.md @@ -0,0 +1,71 @@ +--- +layout: default-layout +title: CapturedResultBase - Dynamsoft Capture Vision React Native +description: Interface CapturedResultBase of Dynamsoft Capture Vision Module React Native edition is the base interface of all types of captured results. +keywords: captured result base, React Native +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# CapturedResultBase + +Interface `CapturedResultBase` is the base interface of all types of captured results. + +> [!NOTE] +> Hierarchy: +> - `CapturedResultBase` +> - [`CapturedResult`](../capture-vision-router/captured-result.md) +> - [`DecodedBarcodesResult`]({{ site.dbr_react_native_api }}barcode-reader/decoded-barcodes-result.html) +> - [`RecognizedTextLinesResult`]({{ site.dlr_react_native_api }}recognized-text-lines-result.html) +> - [`ProcessedDocumentResult`]({{ site.ddn_react_native_api }}processed-document-result.html) +> - [`ParsedResult`]({{ site.dcp_react_native_api }}parsed-result.html) + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +interface CapturedResultBase +``` + +## Properties + +| Properties | Types | Description | +| ---------- | ----- | ----------- | +| [`originalImageHashId`](#originalimagehashid) | *string* | The hash id of the original image. | +| [`rotationTransformMatrix`](#rotationtransformmatrix) | *number[]* | The rotation transformation matrix of the original image relative to the rotated image. | +| [`errorCode`](#errorcode) | *number* | The error code of this result. | +| [`errorMessage`](#errormessage) | *string* | The error message of this result. | + +### originalImageHashId + +The hash id of the original image. + +```js +originalImageHashId: string; +``` + +### rotationTransformMatrix + +The rotation transformation matrix of the original image relative to the rotated image. + +```js +rotationTransformMatrix: number[]; +``` + +### errorCode + +The error code of this result. + +```js +errorCode: number; +``` + +### errorMessage + +The error message of this result. + +```js +errorMessage: string; +``` diff --git a/programming/react-native/api-reference/core/captured-result-item.md b/programming/react-native/api-reference/core/captured-result-item.md new file mode 100644 index 0000000..1dc3068 --- /dev/null +++ b/programming/react-native/api-reference/core/captured-result-item.md @@ -0,0 +1,82 @@ +--- +layout: default-layout +title: CapturedResultItem - Dynamsoft Capture Vision React Native +description: Interface CapturedResultItem of DCV React Native edition represents the result of a capture operation on an image. +keywords: decoded barcode, parsed result, error code, output, captured result, react native, barcode reader +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# CapturedResultItem + +Interface `CapturedResultItem` represents the most basic item in the captured result. Depending on the type of the [`CapturedResult`](../capture-vision-router/captured-result.md), the captured result item can be a barcode, a text line, a normalized image, a detected quad, a parsed item, or an original image. + +> [!NOTE] +> Hierarchy: +> - `CapturedResultItem` +> - [`BarcodeResultItem`]({{ site.dbr_react_native_api }}barcode-reader/barcode-result-item.html) +> - [`TextLineResultItem`]({{ site.dlr_react_native_api }}text-line-result-item.html) +> - [`DeskewedImageResultItem`]({{ site.ddn_react_native_api }}deskewed-image-result-item.html) +> - [`DetectedQuadResultItem`]({{ site.ddn_react_native_api }}detected-quad-result-item.html) +> - [`EnhancedImageResultItem`]({{ site.ddn_react_native_api }}enhanced-image-result-item.html) +> - [`ParsedResultItem`]({{ site.dcp_react_native_api }}parsed-result-item.html) + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +interface CapturedResultItem +``` + +## Properties + +| Property | Type | Description | +| --------- | ---- | ----------- | +| [`targetROIDefName`](#targetroidefname) | *string* | The name of the target region of interest (ROI) where the captured result was found. | +| [`taskName`](#taskname) | *string* | The name of the recognition task that produced the CapturedResultItem. | +| [`type`](#type) | [*EnumCapturedResultItemType*](enum/captured-result-item-type.md) | The type of the captured result item. | + +### targetROIDefName + +Returns a string that represents the name of the target region of interest (ROI) where the captured result was found. The target ROI is where the recognition task is run, and it is defined in the Capture Vision template. + +```js +targetROIDefName?: string; +``` + +**Remarks** + +To learn more about the `TargetROIDef` object, please visit this [page]({{ site.parameter }}file/target-roi-definition/index.html?product=dbr&lang=objectivec-swift). + +### taskName + +Returns the name of the recognition task that produced the CapturedResultItem. The task name sets the functional product that will be used for the recognition task, and it is defined in the Capture Vision template. + +```js +taskName?: string; +``` + +**Remarks** + +To learn more about how the tasks are set in the TargetROIDef object, please visit this [page]({{ site.parameter }}reference/target-roi-def/task-setting-name-array.html?product=dbr&lang=objectivec-swift). + +### type + +The type of the captured result item represented as a [`EnumCapturedResultItemType`](enum/captured-result-item-type.md). Depending on the functional product used, the captured result item can be a barcode, a text line, a normalized image, a detected quad, a parsed item, or an original image. + +```js +type: EnumCapturedResultItemType | number; +``` + +**Remarks** + +| CapturedResultItemType | Interface | +| ---------------------- | --------- | +| `CRIT_BARCODE` | [`BarcodeResultItem`]({{ site.dbr_react_native_api }}barcode-reader/barcode-result-item.html) | +| `CRIT_TEXT_LINE` | [`TextLineResultItem`]({{ site.dlr_react_native_api }}text-line-result-item.html) | +| `CRIT_DETECTED_QUAD` | [`DetectedQuadResultItem`]({{ site.ddn_react_native_api }}detected-quad-result-item.html) | +| `CRIT_DESKEWED_IMAGE` | [`DeskewedImageResultItem`]({{ site.ddn_react_native_api }}deskewed-image-result-item.html) | +| `CRIT_PARSED_RESULT` | [`ParsedResultItem`]({{ site.dcp_react_native_api }}parsed-result-item.html) | +| `CRIT_ENHANCED_IMAGE` | [`EnhancedImageResultItem`]({{ site.ddn_react_native_api }}enhanced-image-result-item.html) | diff --git a/programming/react-native/api-reference/core/dsrect.md b/programming/react-native/api-reference/core/dsrect.md new file mode 100644 index 0000000..98b6190 --- /dev/null +++ b/programming/react-native/api-reference/core/dsrect.md @@ -0,0 +1,70 @@ +--- +layout: default-layout +title: DSRect - Dynamsoft Capture Vision React Native +description: Interface DSRect of DCV React Native is used to define a rectangular region. +keywords: region, DSRect, barcode reader, react native, capture vision +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# DSRect + +Interface `DSRect` is used to define a rectangular region. +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +interface DSRect +``` + +## Properties + +| Property | Type | Description | +| --------- | ---- | ----------- | +| [`left`](#left) | *number* | The left edge of the rectangle, set in pixels or as a percentage of the width of the frame. | +| [`top`](#top) | *number* | The top edge of the rectangle, set in pixels or as a percentage of the length of the frame. | +| [`right`](#right) | *number* | The right edge of the rectangle, set in pixels or as a percentage of the width of the frame. | +| [`bottom`](#bottom) | *number* | The bottom edge of the rectangle, set in pixels or as a percentage of the length of the frame. | +| [`measuredInPercentage`](#measuredinpercentage) | *number* | Determines whether the rectangle's dimensions are measured as a percentage of the total image/frame dimensions or not. | + +### left + +The left edge of the rectangle, set in pixels or as a percentage of the width of the frame. + +```js +left: number; +``` + +### top + +The top edge of the rectangle, set in pixels or as a percentage of the length of the frame. + +```js +top: number; +``` + +### right + +The right edge of the rectangle, set in pixels or as a percentage of the width of the frame. + +```js +right: number; +``` + +### bottom + +The bottom edge of the rectangle, set in pixels or as a percentage of the length of the frame. + +```js +bottom: number; +``` + +### measuredInPercentage + +Determines whether the rectangle's dimensions are measured as a percentage of the total image/frame dimensions or not. + +```js +measuredInPercentage: number | boolean; +``` diff --git a/programming/react-native/api-reference/core/enum/captured-result-item-type.md b/programming/react-native/api-reference/core/enum/captured-result-item-type.md new file mode 100644 index 0000000..7ae4661 --- /dev/null +++ b/programming/react-native/api-reference/core/enum/captured-result-item-type.md @@ -0,0 +1,44 @@ +--- +layout: default-layout +title: EnumCapturedResultItemType - Dynamsoft Capture Vision React Native +description: Enumeration EnumCapturedResultItemType of Dynamsoft Capture Vision React Native Edition defines the accepted result types that the Capture Vision instance will output. +keywords: captured result, react native, capture vision, settings, barcode reader +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: EnumCapturedResultItemType +--- + +# EnumCapturedResultItemType + +`EnumCapturedResultItemType` is an enumeration that specifies the different types of results that a `CaptureVisionRouter` instance can output. Each functional product under the Capture Vision umbrella has its own unique result type(s). For instance, the Barcode Reader outputs the result type `barcode`, while the Document Normalizer outputs a `detectedQuad` or a `deskewedImage`. + +> [!NOTE] +> Although most of the result types are unique to a certain functional product, the `originalImage` result type is shared between all of the functional products. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +enum EnumCapturedResultItemType { + CRIT_ORIGINAL_IMAGE = 0x1, + CRIT_BARCODE = 0x2, + CRIT_TEXT_LINE = 0x4, + CRIT_DETECTED_QUAD = 0x8, + CRIT_DESKEWED_IMAGE = 0x10, + CRIT_PARSED_RESULT = 0x20, + CRIT_ENHANCED_IMAGE = 0x40, +} +``` + +## Members + +| Member | Description | +| ------ | ----------- | +| `CRIT_ORIGINAL_IMAGE` | The original image. | +| `CRIT_BARCODE` | The decoded barcode. | +| `CRIT_TEXT_LINE` | The recognized text line. | +| `CRIT_DETECTED_QUAD` | The detected quadrilateral. | +| `CRIT_DESKEWED_IMAGE` | The deskewed image. | +| `CRIT_PARSED_RESULT` | The parsed result. | +| `CRIT_ENHANCED_IMAGE` | The enhanced image. | diff --git a/programming/react-native/api-reference/core/enum/colour-channel-usage-type.md b/programming/react-native/api-reference/core/enum/colour-channel-usage-type.md new file mode 100644 index 0000000..d4028de --- /dev/null +++ b/programming/react-native/api-reference/core/enum/colour-channel-usage-type.md @@ -0,0 +1,39 @@ +--- +layout: default-layout +title: EnumColourChannelUsageType - Dynamsoft Capture Vision React Native +description: Enumeration EnumColourChannelUsageType of Dynamsoft Capture Vision React Native Edition defines the available colour channels for the image source to use when capturing images or frames +keywords: colour channel, capture vision, camera, enhancer, pixel, format +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: EnumColourChannelUsageType +--- + +# EnumColourChannelUsageType + +`EnumColourChannelUsageType` is an enumeration that specifies the different colour channels that are available to the Camera Enhancer. The colour channel affects the pixel type that the captured images or frames will come out in, so it can output grayscale or colour images. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +enum EnumColourChannelUsageType { + CCUT_AUTO = 0, + CCUT_FULL_CHANNEL = 1, + CCUT_Y_CHANNEL_ONLY = 2, + CCUT_RGB_R_CHANNEL_ONLY = 3, + CCUT_RGB_G_CHANNEL_ONLY = 4, + CCUT_RGB_B_CHANNEL_ONLY = 5 +} +``` + +## Members + +| Member | Description | +| ------ | ----------- | +| `CCUT_AUTO` | Automatic colour channel usage determination based on image pixel format and scene. | +| `CCUT_FULL_CHANNEL` | Uses all colour channels to output a full colour image. | +| `CCUT_Y_CHANNEL_ONLY` | Uses only the luminance channel to output a grayscale image. | +| `CCUT_RGB_R_CHANNEL_ONLY` | Uses only the red channel of the RGB space. | +| `CCUT_RGB_G_CHANNEL_ONLY` | Uses only the green channel of the RGB space. | +| `CCUT_RGB_B_CHANNEL_ONLY` | Uses only the blue channel of the RGB space. | diff --git a/programming/react-native/api-reference/core/enum/cross-verification-status.md b/programming/react-native/api-reference/core/enum/cross-verification-status.md new file mode 100644 index 0000000..42529b2 --- /dev/null +++ b/programming/react-native/api-reference/core/enum/cross-verification-status.md @@ -0,0 +1,35 @@ +--- +layout: default-layout +title: CrossVerificationStatus - Dynamsoft Capture Vision React Native +description: The enumeration CrossVerificationStatus of Dynamsoft Capture Vision React Native describes the status of the captured results. +keywords: cross verification status +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: CrossVerificationStatus +codeAutoHeight: true +--- + +# Enumeration CrossVerificationStatus + +`CrossVerificationStatus` describes the status of the captured results. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +enum EnumCrossVerificationStatus { + CVS_NOT_VERIFIED = 0, + CVS_PASSED = 1, + CVS_FAILED = 2 +} +``` + +## Members + +| Member | Description | +| ------ | ----------- | +| `CVS_NOT_VERIFIED` | The item has not been verified. | +| `CVS_PASSED` | The item has passed verification. | +| `CVS_FAILED` | The item has failed verification. | diff --git a/programming/react-native/api-reference/core/enum/grayscale-enhancement-mode.md b/programming/react-native/api-reference/core/enum/grayscale-enhancement-mode.md new file mode 100644 index 0000000..35659ca --- /dev/null +++ b/programming/react-native/api-reference/core/enum/grayscale-enhancement-mode.md @@ -0,0 +1,39 @@ +--- +layout: default-layout +title: EnumGrayscaleEnhancementMode - Dynamsoft Capture Vision React Native +description: Enumeration EnumGrayscaleEnhancementMode of Dynamsoft Capture Vision React Native Edition describes all available grayscale enhancement modes. +keywords: Grayscale enhancement modes +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: EnumGrayscaleEnhancementMode +--- + +# EnumGrayscaleEnhancementMode + +`EnumGrayscaleEnhancementMode` is an enumeration that determines which grayscale enhancement modes the library will apply before the detection process to improve the read rate of the barcodes in a given image or frame. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +enum EnumGrayscaleEnhancementMode { + GEM_SKIP = 0x0, + GEM_AUTO = 0x1, + GEM_GENERAL = 0x2, + GEM_GRAY_EQUALIZE = 0x4, + GEM_GRAY_SMOOTH = 0x8, + GEM_SHARPEN_SMOOTH = 0x10 +} +``` + +## Members + +| Member | Description | +| ------ | ----------- | +| `GEM_SKIP` | Disables any grayscale image preprocessing. Selecting this mode skips the preprocessing step, passing the image through to subsequent operations without modification. | +| `GEM_AUTO` | Automatic selection of grayscale enhancement mode which is currently not supported. Future implementations may automatically choose the most suitable enhancement based on image analysis. | +| `GEM_GENERAL` | Uses the original, unprocessed image for subsequent operations. This mode is selected when no specific grayscale enhancement is required, maintaining the image in its natural state. | +| `GEM_GRAY_EQUALIZE` | Applies a grayscale equalization algorithm to the image, enhancing contrast and detail in gray level. Suitable for images with poor contrast. | +| `GEM_GRAY_SMOOTH` | Implements a grayscale smoothing algorithm to reduce noise and smooth the image. This can be beneficial for images with high levels of grain or noise. | +| `GEM_SHARPEN_SMOOTH` | Enhances the image by applying both sharpening and smoothing algorithms. This mode aims to increase clarity and detail while reducing noise, offering a balanced approach to image preprocessing. | diff --git a/programming/react-native/api-reference/core/enum/grayscale-transformation-mode.md b/programming/react-native/api-reference/core/enum/grayscale-transformation-mode.md new file mode 100644 index 0000000..b65fe50 --- /dev/null +++ b/programming/react-native/api-reference/core/enum/grayscale-transformation-mode.md @@ -0,0 +1,35 @@ +--- +layout: default-layout +title: EnumGrayscaleTransformationMode - Dynamsoft Capture Vision React Native +description: Enumeration EnumGrayscaleTransformationMode of Dynamsoft Capture Vision React Native Edition describes all available grayscale transformation modes. +keywords: Grayscale transformation modes +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: EnumGrayscaleTransformationMode +--- + +# EnumGrayscaleTransformationMode + +`EnumGrayscaleTransformationMode` is an enumeration that determines which grayscale enhancement modes the library will apply before the detection process to improve the read rate of the barcodes in a given image or frame. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +enum EnumGrayscaleTransformationMode { + GTM_SKIP = 0x0, + GTM_INVERTED = 0x1, + GTM_ORIGINAL = 0x2, + GTM_AUTO = 0x4 +} +``` + +## Members + +| Member | Description | +| ------ | ----------- | +| `GTM_SKIP` | Bypasses grayscale transformation, leaving the image in its current state without any modification to its grayscale values. This mode is selected when no alteration of the grayscale data is desired, passing the image through to subsequent operations without modification. | +| `GTM_INVERTED` | Applies an inversion to the grayscale values of the image, effectively transforming light elements to dark and vice versa. This mode is particularly useful for images with light text on dark backgrounds, enhancing visibility for further processing. | +| `GTM_ORIGINAL` | Maintains the original grayscale values of the image without any transformation. This mode is suited for images with dark elements on light backgrounds, ensuring the natural contrast and detail are preserved for subsequent analysis. | +| `GTM_AUTO` | Delegates the choice of grayscale transformation to the library's algorithm, which automatically determines the most suitable transformation based on the image's characteristics. This mode is beneficial when the optimal transformation is not known in advance or varies across different images. | diff --git a/programming/react-native/api-reference/core/enum/image-file-format.md b/programming/react-native/api-reference/core/enum/image-file-format.md new file mode 100644 index 0000000..f4553c1 --- /dev/null +++ b/programming/react-native/api-reference/core/enum/image-file-format.md @@ -0,0 +1,35 @@ +--- +layout: default-layout +title: EnumImageFileFormat - Dynamsoft Capture Vision React Native +description: Enumeration EnumImageFileFormat of Dynamsoft Capture Vision React Native Edition `ImageFileFormat` defines the file format of the image file. +keywords: Image file format +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: EnumImageFileFormat +--- + +# EnumImageFileFormat + +`EnumImageFileFormat` defines the file format of the image file. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +enum EnumImageFileFormat { + IFF_JPEG = 0, + IFF_PNG = 1, + IFF_BMP = 2, + IFF_PDF = 3 +} +``` + +## Members + +| Member | Description | +| ------ | ----------- | +| IFF_JPEG | JPEG | +| IFF_PNG | PNG | +| IFF_BMP | BMP | +| IFF_PDF | PDF | diff --git a/programming/react-native/api-reference/core/enum/image-pixel-format.md b/programming/react-native/api-reference/core/enum/image-pixel-format.md new file mode 100644 index 0000000..cc34b1e --- /dev/null +++ b/programming/react-native/api-reference/core/enum/image-pixel-format.md @@ -0,0 +1,59 @@ +--- +layout: default-layout +title: EnumImagePixelFormat - Dynamsoft Capture Vision React Native +description: Enumeration EnumImagePixelFormat of Dynamsoft Capture Vision React Native Edition describes all supported image pixel formats. +keywords: Image pixel format +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: EnumImagePixelFormat +--- + +# EnumImagePixelFormat + +`EnumImagePixelFormat` is an enumeration that specifies the different pixel formats of an image. From this enumeration, you can determine if an image is binary, grayscale, or colour. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +enum EnumPixelFormat { + IPF_BINARY = 0, + IPF_BINARYINVERTED = 1, + IPF_GRAYSCALED = 2, + IPF_NV21 = 3, + IPF_RGB_565 = 4, + IPF_RGB_555 = 5, + IPF_RGB_888 = 6, + IPF_ARGB_8888 = 7, + IPF_RGB_161616 = 8, + IPF_ARGB_16161616 = 9, + IPF_ABGR_8888 = 10, + IPF_ABGR_16161616 = 11, + IPF_BGR_888 = 12, + IPF_BINARY_8 = 13, + IPF_NV12 = 14, + IPF_BINARY_8_INVERTED = 15, +} +``` + +## Members + +| Member | Description | +| ------ | ----------- | +| `IPF_BINARY` | Each pixel is represented by a single bit. | +| `IPF_BINARYINVERTED` | Each pixel is represented by a single bit and the bits are inverted. | +| `IPF_GRAYSCALED` | Each pixel is represented by a single byte indicating the intensity of gray. | +| `IPF_NV21` | A YUV format with a specific arrangement of chroma and luma components. | +| `IPF_RGB_565` | Each pixel is represented by 16 bits: 5 bits for red, 6 bits for green, and 5 bits for blue. | +| `IPF_RGB_555` | Each pixel is represented by 15 bits: 5 bits each for red, green, and blue. | +| `IPF_RGB_888` | Each pixel is represented by 24 bits: 8 bits each for red, green, and blue. | +| `IPF_ARGB_8888` | Each pixel is represented by 32 bits: 8 bits each for alpha, red, green, and blue. | +| `IPF_RGB_161616` | Each pixel is represented by 48 bits: 16 bits each for red, green, and blue. | +| `IPF_ARGB_16161616` | Each pixel is represented by 64 bits: 16 bits each for alpha, red, green, and blue. | +| `IPF_ABGR_8888` | ABGR8888 pixel format, where each pixel is represented by 32 bits: 8 bits each for alpha, blue, green, and red. | +| `IPF_ABGR_16161616` | ABGR16161616 pixel format, where each pixel is represented by 64 bits: 16 bits each for alpha, blue, green, and red. | +| `IPF_BGR_888` | Each pixel is represented by 24 bits: 8 bits each for blue, green, and red. | +| `IPF_BINARY_8` | Each pixel is represented by 8 bits in a binary format. | +| `IPF_NV12` | NV12 pixel format, a YUV format with a specific arrangement of chroma and luma components. | +| `IPF_BINARY_8_INVERTED` | Inverted Binary8 pixel format, where each pixel is represented by 8 bits in a binary format and the bits are inverted. | diff --git a/programming/react-native/api-reference/core/image-data.md b/programming/react-native/api-reference/core/image-data.md new file mode 100644 index 0000000..ad0792a --- /dev/null +++ b/programming/react-native/api-reference/core/image-data.md @@ -0,0 +1,92 @@ +--- +layout: default-layout +title: ImageData - Dynamsoft Capture Vision React Native +description: Interface ImageData of DCV React Native represents an image with its raw attributes. +keywords: image data, intermediate, capture vision, original image, result +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# ImageData + +Interface `ImageData` encapsulates all of an image's data, as well as metadata. It is used to represent an image, and the image's data can then be used for further operations such as analysis, viewing, or saving. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +interface ImageData +``` + +## Properties & Methods + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`bytes`](#bytes) | *ArrayBuffer* | Represents the raw bytes of the image. | +| [`width`](#width) | *number* | Represents the width of the image in *pixels*. | +| [`height`](#height) | *number* | Represents the height of the image in *pixels*. | +| [`orientation`](#orientation) | *number* | Represents the orientation of the image as an angle. | +| [`format`](#format) | *EnumImagePixelFormat* | Represents the pixel format of the image as a [`EnumImagePixelFormat`](enum/image-pixel-format.md). | +| [`stride`](#stride) | *number* | Represents the number of bytes in a single row of the image. | + +| Method | Description | +| ------ | ----------- | +| [`release`](#release) | Release the native memory. Data cannot be used after release. | + +### bytes + +Represents the raw bytes of the image. + +```js +buffer: ArrayBuffer; +``` + +### width + +Represents the width of the image in *pixels*. + +```js +width: number; +``` + +### height + +Represents the height of the image in *pixels*. + +```js +height: number; +``` + +### orientation + +Represents the orientation of the image as an angle. + +```js +orientation: number; +``` + +### format + +Represents the pixel format of the image as a [`EnumImagePixelFormat`](enum/image-pixel-format.md). + +```js +format: EnumPixelFormat | number; +``` + +### stride + +Represents the number of bytes in a single row of the image. + +```js +stride: number; +``` + +### release + +Release the native memory. Data cannot be used after release. + +```js +release(): void; +``` \ No newline at end of file diff --git a/programming/react-native/api-reference/core/image-source-adapter.md b/programming/react-native/api-reference/core/image-source-adapter.md new file mode 100644 index 0000000..2c2d344 --- /dev/null +++ b/programming/react-native/api-reference/core/image-source-adapter.md @@ -0,0 +1,139 @@ +--- +layout: default-layout +title: ImageSourceAdapter - Dynamsoft Capture Vision React Native API Reference +description: The class ImageSourceAdapter of Dynamsoft Capture Vision React Native represents an interface for fetching and buffering images. +keywords: image source adapter, Java, Kotlin +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# ImageSourceAdapter + +The abstract class `ImageSourceAdapter` is an abstract class for implementing image fetching and delivering features. + +> [!Note] +> Default implementations: +> - [CameraEnhancer]({{ site.dce_react_native_api }}camera-enhancer.html): Use the camera as the image source for scanning from the video input. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +abstract class ImageSourceAdapter +``` + +## Methods + +| Method | Description | +| ------ | ----------- | +| [`addImageToBuffer`](#addimagetobuffer) | Adds an image to the internal buffer. | +| [`clearBuffer`](#clearbuffer) | Clears all images from the buffer. | +| [`destroy`](#destroy) | Destroy native instance. This object is no longer available after destroy(). | +| [`getColourChannelUsageType`](#getcolourchannelusagetype) | Get the current usage type for color channels in images. | +| [`getImageCount`](#getimagedata) | Get the current number of images in the buffer. | +| [`getImageData`](#getimagedata) | Get a buffered image. | +| [`getMaximumImageCount`](#getmaximumimagecount) | Get the maximum number of images that can be buffered. | +| [`isBufferEmpty`](#isbufferempty) | Determines whether the buffer is empty. | +| [`setColourChannelUsageType`](#setcolourchannelusagetype) | Sets the usage type for color channels in images. | +| [`setMaximumImageCount`](#setmaximumimagecount) | Sets the maximum number of images that can be buffered at any time. | +| [`startFetching`](#startfetching) | Start fetching images from the source to the Video Buffer of `ImageSourceAdapter`. | +| [`stopFetching`](#stopfetching) | Stop fetching images from the source to the Video Buffer of `ImageSourceAdapter`. | + +### addImageToBuffer + +Adds an image to the internal buffer. + +```js +addImageToBuffer(imageData: ImageData): void +``` + +### clearBuffer + +Clears all images from the buffer. + +```js +clearBuffer(): Promise +``` + +### destroy + +Destroy native instance. This object is no longer available after destroy(). + +```js +destroy(): void +``` + +### getColourChannelUsageType + +Get the current usage type for color channels in images. + +```js +getColourChannelUsageType(): Promise +``` + +### getImageCount + +Get the current number of images in the buffer. + +```js +getImageCount(): Promise +``` + +### getImageData + +Get a buffered image. + +```js +getImageData(): undefined | null | ImageData +``` + +### getMaximumImageCount + +Get the maximum number of images that can be buffered. + +```js +getMaximumImageCount(): Promise +``` + +### isBufferEmpty + +Determines whether the buffer is empty. + +```js +isBufferEmpty(): Promise +``` + +### setColourChannelUsageType + +Sets the usage type for color channels in images. + +```js +setColourChannelUsageType(type: EnumColourChannelUsageType): Promise +``` + +### setMaximumImageCount + +Sets the maximum number of images that can be buffered at any time. + +```js +setMaximumImageCount(count: number): Promise +``` + +### startFetching + +Start fetching images from the source to the Video Buffer of `ImageSourceAdapter`. + +```js +startFetching(): void +``` + +### stopFetching + +Stop fetching images from the source to the Video Buffer of `ImageSourceAdapter`. + +```js +stopFetching(): void +``` + diff --git a/programming/react-native/api-reference/core/point.md b/programming/react-native/api-reference/core/point.md new file mode 100644 index 0000000..6ab4467 --- /dev/null +++ b/programming/react-native/api-reference/core/point.md @@ -0,0 +1,44 @@ +--- +layout: default-layout +title: Point - Dynamsoft Capture Vision React Native +description: Interface Point of DCV React Native is used to define a point. +keywords: region, Point, barcode reader, react native, capture vision +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# Point + +Interface `Point` is used to define a point. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +interface Point +``` + +## Properties + +| Property | Type | Description | +| --------- | ---- | ----------- | +| [`x`](#x) | *number* | X coordinate of the point. | +| [`y`](#y) | *number* | Y coordinate of the point. | + +### x + +X coordinate of the point. + +```js +x: number; +``` + +### y + +Y coordinate of the point. + +```js +y: number; +``` diff --git a/programming/react-native/api-reference/core/quadrilateral.md b/programming/react-native/api-reference/core/quadrilateral.md new file mode 100644 index 0000000..bd14336 --- /dev/null +++ b/programming/react-native/api-reference/core/quadrilateral.md @@ -0,0 +1,39 @@ +--- +layout: default-layout +title: Quadrilateral - Dynamsoft Capture Vision React Native +description: Interface Quadrilateral of DCV React Native is used to define a quadrilateral shape. +keywords: region, Quadrilateral, barcode reader, react native, capture vision +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# Quadrilateral + +Interface `Quadrilateral` is used to define a quadrilateral shape. This interface is mainly used by the `roi` parameter of [`SimplifiedCaptureVisionSettings`](../capture-vision-router/simplified-capture-vision-settings.md). + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +interface Quadrilateral +``` + +## Properties + +| Property | Type | Description | +| --------- | ---- | ----------- | +| [`points`](#points) | *Array\ +``` + +**Code Snippet** + +```js +const License = 'DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9'; +LicenseManager.initLicense(License).catch(e => { + Alert.alert('License error', e.message); +}); +``` \ No newline at end of file diff --git a/programming/react-native/api-reference/utility/enum/filter-type.md b/programming/react-native/api-reference/utility/enum/filter-type.md new file mode 100644 index 0000000..556c8d4 --- /dev/null +++ b/programming/react-native/api-reference/utility/enum/filter-type.md @@ -0,0 +1,33 @@ +--- +layout: default-layout +title: EnumFilterType - Dynamsoft Capture Vision React Native +description: Enumeration EnumFilterType of Dynamsoft Capture Vision React Native Edition defines the types of filters that can be applied to an image. +keywords: filter type, capture vision, image, processor +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: EnumFilterType +--- + +# EnumFilterType + +`EnumFilterType` is an enumeration that specifies the different types of filters that can be applied to an image for further processing. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +enum EnumFilterType { + FT_HIGH_PASS = 0, + FT_SHARPEN = 1, + FT_SMOOTH = 2 +} +``` + +## Members + +| Member | Description | +| ------ | ----------- | +| `FT_HIGH_PASS` | Enhances the edges and fine details by attenuating low-frequency components. | +| `FT_SHARPEN` | Increases contrast along edges to make the image appear more defined. | +| `FT_SMOOTH` | Reduces noise and detail by averaging pixel values, creating a softening effect. | diff --git a/programming/react-native/api-reference/utility/image-drawer.md b/programming/react-native/api-reference/utility/image-drawer.md new file mode 100644 index 0000000..5e8c600 --- /dev/null +++ b/programming/react-native/api-reference/utility/image-drawer.md @@ -0,0 +1,49 @@ +--- +layout: default-layout +title: ImageDrawer Class - Dynamsoft Capture Vision React Native +description: ImageDrawer class of DCV React Native provides API to render shapes on images. +keywords: image drawer, intermediate, capture vision, original image, result, draw +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# ImageDrawer + +The `ImageDrawer` class provides API to render geometric shapes such as quadrilaterals on images. This class comes in handy when you want to add annotations to an image obtained from a `CapturedResult` or from the `IntermediateResultManager`. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +class ImageDrawer +``` + +## Methods + +| Method | Description | +| ------ | ----------- | +| [`drawOnImage`](#drawonimage) | Draws quadrilaterals on the image with the specified style parameters. | + +### drawOnImage + +Draws quadrilaterals on the image with the specified style parameters. + +```js +drawOnImage(imageData: ImageData | null | undefined, quads: Quadrilateral[] | null | undefined, colour: number | ColorValue, thickness: number): ImageData | null | undefined +``` + +**Parameters** + +`imageData`: The source image to draw on. + +`quads`: List of Quadrilateral objects to render onto the image. + +`colour`: ARGB colour value (0xAARRGGBB format) + +`thickness`: The line thickness in pixels. + +**Returns** + +An [`ImageData`](../core/image-data.md) object that represents the new image with the rendered shapes. diff --git a/programming/react-native/api-reference/utility/image-io.md b/programming/react-native/api-reference/utility/image-io.md new file mode 100644 index 0000000..179637a --- /dev/null +++ b/programming/react-native/api-reference/utility/image-io.md @@ -0,0 +1,89 @@ +--- +layout: default-layout +title: ImageIO Class - Dynamsoft Capture Vision React Native +description: ImageIO class of DCV React Native provides API to read and write image data to the file system. +keywords: image io, intermediate, capture vision, original image, result, file system, save +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# ImageIO + +The `ImageIO` class provides API to handle image input/output operations such as saving images to the file system. This class allows the library to read and write image data to the file system. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +class ImageIO +``` + +## Methods + +| Method | Description | +| ------ | ----------- | +| [`readFromFile`](#readfromfile) | Reads an image from a file at the specified file path and returns an [`ImageData`](../core/image-data.md) object that represents the image. | +| [`readFromMemory`](#readfrommemory) | Reads an image from ArrayBuffer memory. | +| [`saveToFile`](#savetofile) | Saves the provided [`ImageData`](../core/image-data.md) object (which represents an image) to a file at the specified file path. | +| [`saveToMemory`](#savetomemory) | Saves the provided [`ImageData`](../core/image-data.md) object (which represents an image) to ArrayBuffer memory. | + +### readFromFile + +Reads an image from a file at the specified file path and returns an [`ImageData`](../core/image-data.md) object that represents the image. + +```js +readFromFile(path: string | null | undefined): ImageData | null | undefined +``` + +**Parameters** + +`path`: The absolute file path, name and extension name, as a string, of the image to be read. + +**Returns** + +The image data, of type [`ImageData`](../core/image-data.md), or null if the image cannot be read. + +### readFromMemory + +Reads an image from ArrayBuffer memory. + +```js +readFromMemory(data: ArrayBuffer | null | undefined): ImageData | null | undefined +``` + +**Parameters** + +`data`: The image data, of type ArrayBuffer. + +**Returns** + +The image data, of type [`ImageData`](../core/image-data.md), or null if the image cannot be read. + +### saveToFile + +Saves the provided [`ImageData`](../core/image-data.md) object (which represents an image) to a file at the specified file path. + +```js +saveToFile(imageData: ImageData | null | undefined, path: string | null | undefined, overWrite: boolean): void +``` + +**Parameters** + +`imageData`: The image data, of type [`ImageData`](../core/image-data.md). + +`path`: The absolute file path, name and extension name, as a string, of the image to be saved. + +`overWrite`: Whether to overwrite the file if it already exists. + +### saveToMemory + +Saves an image to the specified path and format. The desired file format is inferred from the file extension provided in the path parameter. + +```js +saveToMemory(imageData: ImageData | null | undefined, format: EnumImageFileFormat): ArrayBuffer | null | undefined +``` + +`imageData`: The image to be saved, of type [`ImageData`](../core/image-data.md). +`format`: The format of the image data, of type [`EnumImageFileFormat`](../core/enum/image-file-format.md). diff --git a/programming/react-native/api-reference/utility/image-processor.md b/programming/react-native/api-reference/utility/image-processor.md new file mode 100644 index 0000000..90c8bcb --- /dev/null +++ b/programming/react-native/api-reference/utility/image-processor.md @@ -0,0 +1,137 @@ +--- +layout: default-layout +title: ImageProcessor Class - Dynamsoft Capture Vision React Native +description: ImageProcessor class of DCV React Native provides API to crop images based on specified regions. +keywords: image processor, intermediate, capture vision, original image, crop +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# ImageProcessor + +The `ImageProcessor` class provides API to crop images based on specified regions. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +class ImageProcessor +``` + +## Methods + +| Method | Description | +| ------ | ----------- | +| [`cropImage`](#cropimage) | Crops the image (as an [`ImageData`](../core/image-data.md) object) to the region defined by the rectangle. | +| [`cropAndDeskewImage`](#cropanddeskewimage) | Crops the image (as an [`ImageData`](../core/image-data.md) object) to the region defined by the Quadrilateral. | +| [`adjustBrightness`](#adjustbrightness) | Adjusts the brightness of the image (as an [`ImageData`](../core/image-data.md) object) based on the specified brightness value. | +| [`adjustContrast`](#adjustcontrast) | Adjusts the contrast of the image (as an [`ImageData`](../core/image-data.md) object) based on the specified contrast value. | +| [`filterImage`](#filterimage) | Applies a filter (represented with [`EnumFilterType`](enum/filter-type.md)) to the image (as an [`ImageData`](../core/image-data.md) object). | +| [`convertToGray`](#converttogray) | Converts the image (as an [`ImageData`](../core/image-data.md) object) to grayscale using specified channel weights. | +| [`convertToBinaryGlobal`](#converttobinaryglobal) | Converts the image (as an [`ImageData`](../core/image-data.md) object) to a binary (black and white) format using global thresholding. | +| [`convertToBinaryLocal`](#converttobinarylocal) | Converts the image (as an [`ImageData`](../core/image-data.md) object) to a binary (black and white) format using local adaptive thresholding. | + +### cropImage + +Crops the image (as an [`ImageData`](../core/image-data.md) object) to the region defined by the rectangle. + +```js +cropImage(imageData: ImageData | null | undefined, rect: DSRect | null | undefined): ImageData | null | undefined +``` + +**Remarks** + +The method returns an [`ImageData`](../core/image-data.md) object that represents the newly cropped image. The method returns `null` if the cropping fails (invalid rectangle, out of bounds, a null `ImageData` object, etc.). + +### cropAndDeskewImage + +Crops the image (as an [`ImageData`](../core/image-data.md) object) to the region defined by the Quadrilateral. + +```js +cropAndDeskewImage(imageData: ImageData | null | undefined, quad: Quadrilateral | null | undefined, dstWidth: number = 0, dstHeight: number = 0, padding: number = 0): ImageData | undefined | null +``` + +**Remarks** + +The `quadrilateral` input parameter defines the region to extract as four corner points. The method returns an [`ImageData`](../core/image-data.md) object that represents the newly cropped image. The method returns `null` if the cropping fails (invalid Quadrilateral, out of bounds, a null `ImageData` object, etc.). + +### adjustBrightness + +Adjusts the brightness of the image (as an [`ImageData`](../core/image-data.md) object) based on the specified brightness value. + +```js +adjustBrightness(imageData: ImageData | null | undefined, brightness: number): ImageData | null | undefined +``` + +**Remarks** + +The `brightness` input parameter ranges from -100 to 100. Positive values increase brightness while negative values decrease it. The method returns `null` if the adjustment fails. + +### adjustContrast + +Adjusts the contrast of the image (as an [`ImageData`](../core/image-data.md) object) based on the specified contrast value. + +```js +adjustContrast(imageData: ImageData | null | undefined, contrast: number): ImageData | null | undefined +``` + +**Remarks** + +The `contrast` input parameter ranges from -100 to 100. Positive values increase brightness while negative values decrease it. The method returns `null` if the adjustment fails. + +### filterImage + +Applies a filter (represented with [`EnumFilterType`](enum/filter-type.md)) to the image (as an [`ImageData`](../core/image-data.md) object). + +```js +filterImage(imageData: ImageData | null | undefined, filterType: EnumFilterType): ImageData | null | undefined +``` + +**Remarks** + +The method returns `null` if the filtering fails. + +### convertToGray + +Converts the image (as an [`ImageData`](../core/image-data.md) object) to grayscale using specified channel weights. + +```js +convertToGray(imageData: ImageData | null | undefined, r: number = 0.3, g: number = 0.59, b: number = 0.11): ImageData | null | undefined +``` + +**Remarks** + +- `r`: Weight of the red channel (default value is 0.3). +- `g`: Weight of the green channel (default value is 0.59). +- `b`: Weight of the blue channel (default value is 0.11). + +The method returns `null` if the conversion fails. + +### convertToBinaryGlobal + +Converts the image (as an [`ImageData`](../core/image-data.md) object) to a binary (black and white) format using global thresholding. + +```js +convertToBinaryGlobal(imageData: ImageData | null | undefined, threshold: number = -1, invert: boolean = false) +``` + +Remarks + +- `threshold`: A value that ranges between 0 and 255. If -1, Otsu's method is used to determine the optimal threshold. +- `inverse`: If `true`, inverts the binary colours, resulting in a negative filter on the image. + +### convertToBinaryLocal + +Converts the image (as an [`ImageData`](../core/image-data.md) object) to a binary (black and white) format using local adaptive thresholding. + +```js +convertToBinaryLocal(imageData: ImageData | null | undefined, blockSize: number = 0, compensation: number = 0, invert: boolean = false) +``` + +**Remarks** + +- `blockSize`: Size of the local region (must be odd and >= 3). +- `compensation`: Value to adjust the threshold (typically 0-10). +- `inverse`: If `true`, inverts the binary colours, resulting in a negative filter on the image. diff --git a/programming/react-native/api-reference/utility/multi-frame-cross-filter.md b/programming/react-native/api-reference/utility/multi-frame-cross-filter.md new file mode 100644 index 0000000..8a00036 --- /dev/null +++ b/programming/react-native/api-reference/utility/multi-frame-cross-filter.md @@ -0,0 +1,185 @@ +--- +layout: default-layout +title: MultiFrameResultCrossFilter Class - Dynamsoft Capture Vision React Native +description: MultiFrameResultCrossFilter class of DCV React Native provides a filter for managing and filtering results. +keywords: filter, capture vision, barcode reader, react native, multiframeresultcrossfilter, result +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# MultiFrameResultCrossFilter + +The `MultiFrameResultCrossFilter` class is an officially implemented `CapturedResultFilter` that provides: + +- **Overlapping**: Improves the read rate of multi-barcode scanning. +- **Cross Verification**: Improves the accuracy. +- **Deduplication**: Removes the duplicated results. + +## Definition + +*Assembly:* dynamsoft-capture-vision-react-native + +```js +class MultiFrameResultCrossFilter implements CapturedResultFilter +``` + +## Constructor + +```js +new MultiFrameResultCrossFilter(): MultiFrameResultCrossFilter +``` + +## Methods + +| Method | Description | +| ------ | ----------- | +| [`destroy`](#destroy) | Destroys the `MultiFrameResultCrossFilter` instance and releases the related resources on the native side. | +| [`enableLatestOverlapping`](#enablelatestoverlapping) | Enables or disables the latest overlap result filtering. | +| [`enableResultCrossVerification`](#enableresultcrossverification) | Enables or disables result cross verification for the specified result item types. | +| [`enableResultDeduplication`](#enableresultdeduplication) | Enables or disables result deduplication for the specified result item types. | +| [`getDuplicateForgetTime`](#getduplicateforgettime) | Returns the amount of time that the deduplication filter takes effect for the specified result item type(s). | +| [`getMaxOverlappingFrames`](#getmaxoverlappingframes) | Returns the maximum number of overlapping frames to check for the specified result item type(s). | +| [`isLatestOverlappingEnabled`](#islatestoverlappingenabled) | Checks if the latest overlapping filter is on for the specified result item type(s). | +| [`isResultCrossVerificationEnabled`](#isresultcrossverificationenabled) | Checks if the cross verification filter is on for the specified result item type(s). | +| [`isResultDeduplicationEnabled`](#isresultdeduplicationenabled) | Checks if the deduplication filter is on for the specified result item type(s). | +| [`setDuplicateForgetTime`](#setduplicateforgettime) | Defines the amount of time that the deduplication filter takes effect for the specified result item type(s). | +| [`setMaxOverlappingFrames`](#setmaxoverlappingframes) | Sets the maximum number of overlapping frames to check when the latest overlap filter is on. | + +### destroy + +Destroys the `MultiFrameResultCrossFilter` instance and releases the related resources on the native side. + +```js +destroy(): void +``` + +### enableLatestOverlapping + +Enables or disables the latest overlap result filtering. Latest overlap filtering helps in managing results that overlap in the most recent frames. + +```js +enableLatestOverlapping(resultItemTypes: number, enable: boolean): any +``` + +**Parameters** + +`resultItemTypes`: [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md) value that specifies one or multiple specific result item types. + +`enable`: Whether to enable the overlapping feature. + +### enableResultCrossVerification + +Enables or disables result cross verification for the specified result item types (represented as a combination of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md)). Cross verification helps in validating results across multiple frames, improving accuracy as a result. + +```js +enableResultCrossVerification(resultItemTypes: number, enable: boolean): void +``` + +**Parameters** + +`resultItemTypes`: [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md) value that specifies one or multiple specific result item types. + +`enable`: Whether to enable the result cross verification. + +### enableResultDeduplication + +Enables or disables result deduplication for the specified result item types (represented as a combination of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md)). If this filter is activated, the library will not scan a barcode for an amount of time again after it is scanned successfully for the first time. In order to set the amount of time that the barcode is remembered, please refer to `setDuplicateForgetTime`. + +```js +enableResultDeduplication(resultItemTypes: number, enable: boolean): void +``` + +**Parameters** + +`resultItemTypes`: [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md) value that specifies one or multiple specific result item types. + +`enable`: Whether to enable the result deduplication. + +### getDuplicateForgetTime + +Returns the amount of time, in *milliseconds*, that the deduplication filter takes effect for the specified result item type. + +```js +getMaxOverlappingFrames(type: number): Promise +``` + +**Parameters** + +`type`: [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md) value that specifies a target result item type. + +### getMaxOverlappingFrames + +Returns the maximum number of overlapping frames to check for the specified result item type. + +```js +getMaxOverlappingFrames(type: number): Promise +``` + +**Parameters** + +`type`: [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md) value that specifies a target result item type. + +### isLatestOverlappingEnabled + +Checks if the latest overlapping filter is on for the specified result item type. + +```js +isLatestOverlappingEnabled(type: number): Promise +``` + +**Parameters** + +`type`: [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md) value that specifies a target result item type. + +### isResultCrossVerificationEnabled + +Checks if the cross verification filter is on for the specified result item type. + +```js +isResultCrossVerificationEnabled(type: number): Promise +``` + +**Parameters** + +`type`: [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md) value that specifies a target result item type. + +### isResultDeduplicationEnabled + +Checks if the deduplication filter is on for the specified result item type(s). + +```js +isResultDeduplicationEnabled(type: number): Promise +``` + +**Parameters** + +`type`: [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md) value that specifies a target result item type. + +### setDuplicateForgetTime + +Defines the amount of time, in *milliseconds*, that the deduplication filter takes effect for the specified result item type(s). During this time, the library will not scan a certain barcode for the specified time after it has been scanned successfully for the first time. + +```js +setDuplicateForgetTime(types: number, time: number): void +``` + +**Parameters** + +`resultItemTypes`: [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md) value that specifies one or multiple specific result item types. + +`time`: Time in milliseconds during which duplicates are disregarded. + +### setMaxOverlappingFrames + +Sets the maximum number of overlapping frames to check when the latest overlap filter is on for the specified result item type(s). + +```js +setMaxOverlappingFrames(types: number, maxOverlappingFrames: number): void +``` + +**Parameters** + +`resultItemTypes`: [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md) value that specifies one or multiple specific result item types. + +`maxOverlappingFrames`: The maximum overlapping frame count for the overlapping. diff --git a/programming/react-native/release-notes/index.md b/programming/react-native/release-notes/index.md new file mode 100644 index 0000000..bac64f3 --- /dev/null +++ b/programming/react-native/release-notes/index.md @@ -0,0 +1,15 @@ +--- +layout: default-layout +title: React Native Release Notes - Dynamsoft Capture Vision React Native SDK +description: This is the release notes page of Dynamsoft Capture Vision for React Native SDK. +keywords: release notes, React Native +needAutoGenerateSidebar: false +breadcrumbText: Release Notes +--- + +# Dynamsoft Capture Vision React Native SDK - Release Notes + +- [3.2.3000 (12/04/2025)]({{ site.dcv_react_native }}release-notes/react-native-3.html#323000-12042025) +- [3.0.5200 (08/18/2025)]({{ site.dcv_react_native }}release-notes/react-native-3.html#305200-08182025) +- [3.0.5100 (08/12/2025)]({{ site.dcv_react_native }}release-notes/react-native-3.html#305100-08122025) +- [3.0.3100 (06/17/2025)]({{ site.dcv_react_native }}release-notes/react-native-3.html#303100-06172025) diff --git a/programming/react-native/release-notes/react-native-3.md b/programming/react-native/release-notes/react-native-3.md new file mode 100644 index 0000000..1f96815 --- /dev/null +++ b/programming/react-native/release-notes/react-native-3.md @@ -0,0 +1,113 @@ +--- +layout: default-layout +title: Release Notes v3.x - Dynamsoft Capture Vision React Native Edition +description: The release notes of Dynamsoft Capture Vision React Native Edition v3.x. +keywords: release notes, capture vision bundle, React Native, dcv +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# Release Notes v3.x - dynamsoft-capture-vision-react-native + +## 3.2.3000 (12/04/2025) + +### πMilestone Release + +Version 3.2.3000 introduces a series of AI-driven improvements designed to enhance barcode and MRZ detection accuracy, processing speed, and configuration flexibility. + +This release focuses on practical performance gains for production environments across retail, logistics, manufacturing, and identity verification workflows. + +### β¨ Key Highlights + +#### AI-Powered Barcode Detection and Decoding + +- New Localization Models β Introduces [`OneDLocalization`]({{ site.dcv_parameters_reference }}barcode-reader-task-settings/localization-modes.html#modelnamearray) and [`DataMatrixQRCodeLocalization`]({{ site.dcv_parameters_reference }}barcode-reader-task-settings/localization-modes.html#modelnamearray) neural network models for improved detection of **blurred / low-resolution 1D codes**, or **partially damaged DataMatrix/QR codes**. +- Specialized Decoders β Adds [`EAN13Decoder`]({{ site.dcv_parameters_reference }}barcode-reader-task-settings/deblur-modes.html#modelnamearray) and [`Code128Decoder`]({{ site.dcv_parameters_reference }}barcode-reader-task-settings/deblur-modes.html#modelnamearray) models optimized for **long-distance** and **motion-blurred** decoding scenarios. +- Redesigned Deblur Model β The [`OneDDeblur`]({{ site.dcv_parameters_reference }}barcode-reader-task-settings/deblur-modes.html#modelnamearray) model now provides more effective recovery from **motion and focus blur**. +- Configurable Model Selection β The new `ModelNameArray` parameter supports flexible model loading and fine-grained control for specific barcode types. + +#### Precision and Processing Control + +- Enhanced Deblur Methods β [`DM_DEEP_ANALYSIS`]({{ site.dcv_parameters_reference }}barcode-reader-task-settings/deblur-modes.html#dm_deep_analysis) now includes sub-level control with `OneDGeneral`, `TwoDGeneral`, and `EAN13Enhanced` options. +- Barcode Count Expectation β The new [`ExpectedBarcodesCount`]({{ site.dcv_parameters_reference }}barcode-format-specification/expected-barcodes-count.html) parameter enables **format-specific quantity control** and **early termination** in fixed-count workflows. +- Improved Region Detection β The new [`RPM_GRAY_CONSISTENCY`]({{ site.dcv_parameters_reference }}image-parameter/region-predetection-modes.html#rpm_gray_consistency) mode provides more precise region extraction based on **grayscale uniformity** and **local consistency** for document and label processing. + +#### AI-Powered MRZ Detection + +- Neural MRZ Localization β The new [`MRZLocalization`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/localization-modes.html#modelnamearray) model improves region detection accuracy and delivers up to **42.7%** faster processing for MRZ-based document workflows. +- Configurable Localization Control β The new [`LocalizationModes`]({{ site.dcv_parameters_reference }}label-recognizer-task-settings/localization-modes.html) parameter allows configuration for text line detection. + +#### Smart Document Capture + +- Clarity-Based Frame Selection β Automatically selects the sharpest and highest-quality frame in live capture workflows. +- Cross-Frame Verification β Updated verification algorithms enhance result reliability. + +### Performance Highlights + +#### Barcode Workflows + +- Up to **26.5%** higher read rates under blur conditions with as much as **44%** faster processing. +- Reliable decoding of DataMatrix and QR codes with missing or damaged finder patterns. +- Extended operational range beyond 75 cm for long-distance barcode scanning. + +#### Document Workflows + +- Improved performance in live video capture environments. +- Consistent document quality through clarity-based frame evaluation. +- Faster MRZ processing for high-throughput identity verification + +### Developer Notes + +- Backward Compatibility β Fully compatible with existing integrations; no code-level changes required for upgrade. +- Configuration Flexibility β Expanded parameter set allows comprehensive model configuration for scenario-specific tuning. +- Production Stability β All new models validated in enterprise environments. + +### New + +- Added a new method, [`switchCapturingTemplate`]({{ site.dcv_react_native_api }}capture-vision-router.html#switchcapturingtemplate), which allows switching templates dynamically during the image processing workflow. +- Added a new method, [`clearDLModelBuffers`]({{ site.dcv_react_native_api }}capture-vision-router.html#cleardlmodelbuffers), to release memory by clearing buffered deep learning models. +- Added a new method, [`setGlobalIntraOpNumThreads`]({{ site.dcv_react_native_api }}capture-vision-router.html#setglobalintraopnumthreads), to configure the global number of threads used for model execution. +- Added a new button, `cameraToggleButton`, to the `CameraView`, allowing users to switch between the front and back cameras. +The following APIs are provided for configuring the `cameraToggleButton`: + - [`cameraToggleButton`]({{ site.dce_react_native_api }}camera-view.html#cameratogglebutton) + - [`cameraToggleButtonVisible`]({{ site.dce_react_native_api }}camera-view.html#cameratogglebuttonvisible) +- Added new methods to class `ImageIO` for reading and saving images: + - [`readFromMemory`]({{ site.dcv_react_native_api }}utility/image-io.html#readfrommemory) + - [`saveToMemory`]({{ site.dcv_react_native_api }}utility/image-io.html#savetomemory) +- Added a new method [`cropAndDeskewImage`]({{ site.dcv_react_native_api }}utility/image-processor.html#cropanddeskewimage) to class `ImageProcessor` for cropping & deskewing images. + +## 3.0.5200 (08/18/2025) + +### Fixed + +- Fixed an xcframework signature issue. + +## 3.0.5100 (08/12/2025) + +### Fixed + +- Small fixes and tweaks. + +## 3.0.3100 (06/17/2025) + +### [Highlights](https://www.dynamsoft.com/release-highlights/?product=dcv3.0) + +- Workflow Improvements + - Restructured the parameter control hierarchy at all levels for finer scope definition and more granular process management, with the stage level newly added. + - Enabled custom combinations and sequences of sections, increasing flexibility and operational customization under specific conditions. + - Redesigned document normalization sections to better accommodate diverse document processing operations. + +- Deep Learning Integration + - Improved the reading rate of 1D barcode by introducing a new deblurring deep-learning model. + - Enhanced text recognition capabilities with deep learning-based text-line recognition. + +- Algorithm Enhancements + - Enabled deduplication at the Region of Interest (ROI) level to consolidate results from multiple tasks. + - Enhanced the text recognition workflow by integrating improved multi-step recognition processes and validation methods. + - Improved the CODE_128 and DataMatrix DeepAnalysis algorithms for better decoding accuracy and performance. + - Added support for new barcode types: CODE_32, MATRIX_25, KIX, and TELEPEN. + - Added GS1 Application Identifiers (AI) support for improved code parsing capabilities. + +- Engineering Optimizations + - Unified template-loading logic to reduce I/O overhead. + - Implemented conversion functionality between `ImageData` and image files, including both on-disk and in-memory files. diff --git a/programming/react-native/samples/index.md b/programming/react-native/samples/index.md new file mode 100644 index 0000000..8236766 --- /dev/null +++ b/programming/react-native/samples/index.md @@ -0,0 +1,56 @@ +--- +layout: default-layout +title: Demo & Samples - Dynamsoft Capture Vision React Native Edition +description: The index of Dynamsoft Capture Vision React Native demo & samples. +keywords: demo, sample, index, React Native, capture vision +needAutoGenerateSidebar: true +noTitleIndex: true +--- + +# Demo and Samples + +All of the samples that have been created for the Dynamsoft Capture Vision React Native Edition are hosted in this Github repo. Feel free to use these samples as reference when building your own React Native app. + +## Read Barcodes + +### ScanBarcodes_FoundationalAPI + +This is a sample that demonstrates the simplest implementation of the Capture Vision to allow for barcode decoding via the camera using the [Foundational API]({{ site.dbr_react_native_api }}). + +[Check code on GitHub](https://github.com/Dynamsoft/barcode-reader-react-native-samples/tree/main/ScanBarcodes_FoundationalAPI){:target="_blank"} + +### ScanDriverLicense + +This sample demonstrates the simplest implementation of the Capture Vision for recognizing a PDF417 barcode from video streaming and extracting structured data from its encoded data. + +[Check code on GitHub](https://github.com/Dynamsoft/barcode-reader-react-native-samples/tree/main/ScanDriversLicense){:target="_blank"} + +## Scan Documents + +Detect & Deskew the document pages. You can edit the document boundaries if required. + +[Check code on GitHub](https://github.com/Dynamsoft/capture-vision-react-native-samples/tree/main/ScanDocument) + +## Scan MRZ + +Scan the MRZ code of a passport or an ID card and parse the information. + +[Check code on GitHub](https://github.com/Dynamsoft/capture-vision-react-native-samples/tree/main/ScanMRZ) + +## Scan VIN + +Scan the vin barcode or text and extract the vehicle information. + +[Check code on GitHub](https://github.com/Dynamsoft/capture-vision-react-native-samples/tree/main/ScanVIN) + +## Demos + +If you would like to see the Capture Vision in action before starting the development journey, we have a demo app available on both the App Store as well as the Google Play Store. + +- Barcode Scanner Demo + - [View in Google Play Store](https://play.google.com/store/apps/details?id=com.dynamsoft.demo.dynamsoftbarcodereaderdemo&pli=1){:target="_blank"} + - [Download APK](https://download2.dynamsoft.com/dbr/android/DynamsoftBarcodeReaderDemoAndroid.apk) + - [View in App Store](https://apps.apple.com/us/app/dynamsoft-barcode-scanner-demo/id1120581630){:target="_blank"} +- MRZ Scanner Demo + - [View in Google Play Store](https://play.google.com/store/apps/details?id=com.dynamsoft.mrzscanner){:target="_blank"} + - [View in Apple Store](https://apps.apple.com/us/app/dynamsoft-mrz-scanner/id6736854735){:target="_blank"} From 13c6ea3f9150edb5d74f78dceaae383481c5c5ca Mon Sep 17 00:00:00 2001 From: Dynamsoft-Henry <78675724+Dynamsoft-Henry@users.noreply.github.com> Date: Thu, 4 Dec 2025 15:32:56 +0800 Subject: [PATCH 2/2] Updating side list --- .../programming-react-native.html | 9 +- .../react-native/api-reference/index.md | 97 +++++++++++++++++++ programming/react-native/index.md | 51 ++++++++++ 3 files changed, 149 insertions(+), 8 deletions(-) create mode 100644 programming/react-native/api-reference/index.md create mode 100644 programming/react-native/index.md diff --git a/_includes/sidelist-programming/programming-react-native.html b/_includes/sidelist-programming/programming-react-native.html index 2879c59..83ed396 100644 --- a/_includes/sidelist-programming/programming-react-native.html +++ b/_includes/sidelist-programming/programming-react-native.html @@ -3,17 +3,10 @@