diff --git a/programming/android/api-reference/capture-vision-router/auxiliary-classes/capture-state-listener.md b/programming/android/api-reference/capture-vision-router/auxiliary-classes/capture-state-listener.md
index 66d5a83a..8ee60789 100644
--- a/programming/android/api-reference/capture-vision-router/auxiliary-classes/capture-state-listener.md
+++ b/programming/android/api-reference/capture-vision-router/auxiliary-classes/capture-state-listener.md
@@ -33,7 +33,7 @@ interface CaptureStateListener
The method for monitoring the capture state.
```java
-void onCaptureStateChanged(EnumCaptureState state);
+void onCaptureStateChanged(@EnumCaptureState int state);
```
**Parameters**
diff --git a/programming/android/api-reference/capture-vision-router/auxiliary-classes/captured-result-filter.md b/programming/android/api-reference/capture-vision-router/auxiliary-classes/captured-result-filter.md
index 83e312b9..c70256ca 100644
--- a/programming/android/api-reference/capture-vision-router/auxiliary-classes/captured-result-filter.md
+++ b/programming/android/api-reference/capture-vision-router/auxiliary-classes/captured-result-filter.md
@@ -37,7 +37,7 @@ interface CapturedResultFilter
The method for monitoring the output of [`OriginalImageResultItem`]({{ site.dcv_android_api }}core/basic-structures/original-image-result-item.html).
```java
-void onOriginalImageResultReceived(OriginalImageResultItem result);
+default void onOriginalImageResultReceived(@NonNull OriginalImageResultItem result);
```
**Parameters**
@@ -49,7 +49,7 @@ void onOriginalImageResultReceived(OriginalImageResultItem result);
The method for monitoring the output of DecodedBarcodesResult.
```java
-void onDecodedBarcodesReceived(DecodedBarcodesResult result);
+default void onDecodedBarcodesReceived(@NonNull DecodedBarcodesResult result);
```
**Parameters**
@@ -61,7 +61,7 @@ void onDecodedBarcodesReceived(DecodedBarcodesResult result);
The method for monitoring the output of RecognizedTextLinesResult.
```java
-void onRecognizedTextLinesReceived(RecognizedTextLinesResult result);
+default void onRecognizedTextLinesReceived(@NonNull RecognizedTextLinesResult result);
```
**Parameters**
@@ -73,7 +73,7 @@ void onRecognizedTextLinesReceived(RecognizedTextLinesResult result);
The method for monitoring the output of `ProcessedDocumentResult`, which includes the detected quad, deskewed image and enhanced image.
```java
-void onProcessedDocumentResultReceived(ProcessedDocumentResult result);
+default void onProcessedDocumentResultReceived(@NonNull ProcessedDocumentResult result);
```
**Parameters**
@@ -85,7 +85,7 @@ void onProcessedDocumentResultReceived(ProcessedDocumentResult result);
The method for monitoring the output of ParsedResult.
```java
-void onParsedResultsReceived(ParsedResult result);
+default void onParsedResultsReceived(@NonNull ParsedResult result);
```
**Parameters**
diff --git a/programming/android/api-reference/capture-vision-router/auxiliary-classes/captured-result-receiver.md b/programming/android/api-reference/capture-vision-router/auxiliary-classes/captured-result-receiver.md
index 16ff515e..eeb8c06f 100644
--- a/programming/android/api-reference/capture-vision-router/auxiliary-classes/captured-result-receiver.md
+++ b/programming/android/api-reference/capture-vision-router/auxiliary-classes/captured-result-receiver.md
@@ -38,7 +38,7 @@ interface CapturedResultReceiver
The callback method triggered when a generic captured result is available, occurring each time an image finishes its processing. This callback can be used for any result that does not fit into the specific categories of the other callbacks.
```java
-void onCapturedResultReceived(CapturedResult result);
+default void onCapturedResultReceived(@NonNull CapturedResult result);
```
**Parameters**
@@ -50,7 +50,7 @@ void onCapturedResultReceived(CapturedResult result);
The callback method triggered when the original image result is available, occurring each time an image finishes its processing. This callback is used to handle the original image that used as the input of this capture process.
```java
-void onOriginalImageResultReceived(OriginalImageResultItem result);
+default void onOriginalImageResultReceived(@NonNull OriginalImageResultItem result);
```
**Parameters**
@@ -62,7 +62,7 @@ void onOriginalImageResultReceived(OriginalImageResultItem result);
The callback triggered when decoded barcodes are available, occurring each time an image finishes its processing.
```java
-void onDecodedBarcodesReceived(DecodedBarcodesResult result);
+default void onDecodedBarcodesReceived(@NonNull DecodedBarcodesResult result);
```
**Parameters**
@@ -74,7 +74,7 @@ void onDecodedBarcodesReceived(DecodedBarcodesResult result);
The callback triggered when recognized text lines are available, occurring each time an image finishes its processing.
```java
-void onRecognizedTextLinesReceived(RecognizedTextLinesResult result);
+default void onRecognizedTextLinesReceived(@NonNull RecognizedTextLinesResult result);
```
**Parameters**
@@ -86,7 +86,7 @@ void onRecognizedTextLinesReceived(RecognizedTextLinesResult result);
The callback triggered when processed document results are available, occurring each time an image finishes its processing.
```java
-void onProcessedDocumentResultReceived(ProcessedDocumentResult result);
+default void onProcessedDocumentResultReceived(@NonNull ProcessedDocumentResult result);
```
**Parameters**
@@ -98,7 +98,7 @@ void onProcessedDocumentResultReceived(ProcessedDocumentResult result);
The callback triggered when parsed results are available, occurring each time an image finishes its processing.
```java
-void onParsedResultsReceived(ParsedResult result);
+default void onParsedResultsReceived(@NonNull ParsedResult result);
```
**Parameters**
diff --git a/programming/android/api-reference/capture-vision-router/auxiliary-classes/captured-result.md b/programming/android/api-reference/capture-vision-router/auxiliary-classes/captured-result.md
index 6588c9cc..d3761ea5 100644
--- a/programming/android/api-reference/capture-vision-router/auxiliary-classes/captured-result.md
+++ b/programming/android/api-reference/capture-vision-router/auxiliary-classes/captured-result.md
@@ -54,6 +54,8 @@ The following methods are inherited from [`CapturedResultBase`]({{ site.dcv_andr
Get an array of [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html), which is the basic unit of the captured results. A [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html) can be a original image, a decoded barcode, a recognized text, a detected quad, a normalized image, or a parsed result. View [`CapturedResultItemType`]({{ site.dcv_android_api }}core/enum/captured-result-item-type.html) for all available types.
```java
+@Size(min = 0)
+@NonNull
CapturedResultItem[] getItems();
```
@@ -66,6 +68,7 @@ An array containing the [`CapturedResultItem`]({{ site.dcv_android_api }}core/ba
Get all the barcode decoding results of the `CapturedResult`.
```java
+@Nullable
DecodedBarcodesResult getDecodedBarcodesResult();
```
@@ -78,6 +81,7 @@ A [`DecodedBarcodesResult`]({{ site.dbr_android_api }}decoded-barcodes-result.ht
Get all the text line recognition results of the `CapturedResult`.
```java
+@Nullable
RecognizedTextLinesResult getRecognizedTextLinesResult();
```
@@ -90,6 +94,7 @@ A [`RecognizedTextLinesResult`]({{ site.dlr_android_api }}recognized-text-lines-
Get a [`ProcessedDocumentResult`]({{ site.ddn_android_api }}processed-document-result.html) object that contains all the results with the type of deskewed image, detected quads, and enhanced images.
```java
+@Nullable
ProcessedDocumentResult getProcessedDocumentResult();
```
@@ -106,6 +111,7 @@ A [`ProcessedDocumentResult`]({{ site.ddn_android_api }}processed-document-resul
Get all the parsed results of the `CapturedResult`.
```java
+@Nullable
ParsedResult getParsedResult();
```
diff --git a/programming/android/api-reference/capture-vision-router/auxiliary-classes/image-source-state-listener.md b/programming/android/api-reference/capture-vision-router/auxiliary-classes/image-source-state-listener.md
index bc414182..d65828d9 100644
--- a/programming/android/api-reference/capture-vision-router/auxiliary-classes/image-source-state-listener.md
+++ b/programming/android/api-reference/capture-vision-router/auxiliary-classes/image-source-state-listener.md
@@ -33,7 +33,7 @@ interface ImageSourceStateListener
The methods for monitoring the state of the ImageSourceAdapter.
```java
-void onImageSourceStateReceived(EnumImageSourceState status);
+void onImageSourceStateReceived(@EnumImageSourceState int status);
```
**Parameters**
diff --git a/programming/android/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md b/programming/android/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md
index 87132971..28e11659 100644
--- a/programming/android/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md
+++ b/programming/android/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md
@@ -66,7 +66,7 @@ interface IntermediateResultReceiver
Gets the observed parameters of the intermediate result receiver.
```java
-ObservationParameters getObservationParameters();
+default ObservationParameters getObservationParameters();
```
**Return Value**
@@ -78,7 +78,7 @@ An `ObservationParameters` object.
The callback triggered when the processing of a target-ROI is finished.
```java
-void onTargetROIResultsReceived(@NonNull IntermediateResult result, IntermediateResultExtraInfo info);
+default void onTargetROIResultsReceived(@NonNull IntermediateResult result, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -95,7 +95,7 @@ The callback triggered when the processing of a task is finished.
> This callback may be invoked on different threads. Ensure that any shared resources accessed within the callback are properly synchronized to avoid data corruption or crashes.
```java
-void onTaskResultsReceived(@NonNull IntermediateResult result, IntermediateResultExtraInfo info);
+default void onTaskResultsReceived(@NonNull IntermediateResult result, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -109,7 +109,7 @@ void onTaskResultsReceived(@NonNull IntermediateResult result, IntermediateResul
The callback triggered when pre-detected regions are received.
```java
-void onPredetectedRegionsReceived(@NonNull PredetectedRegionsUnit unit, IntermediateResultExtraInfo info);
+default void onPredetectedRegionsReceived(@NonNull PredetectedRegionsUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -123,7 +123,7 @@ void onPredetectedRegionsReceived(@NonNull PredetectedRegionsUnit unit, Intermed
The callback triggered when localized barcodes are received.
```java
-void onLocalizedBarcodesReceived(@NonNull LocalizedBarcodesUnit unit, IntermediateResultExtraInfo info);
+default void onLocalizedBarcodesReceived(@NonNull LocalizedBarcodesUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -137,7 +137,7 @@ void onLocalizedBarcodesReceived(@NonNull LocalizedBarcodesUnit unit, Intermedia
The callback triggered when decoded barcodes are received.
```java
-void onDecodedBarcodesReceived(@NonNull DecodedBarcodesUnit unit, IntermediateResultExtraInfo info);
+default void onDecodedBarcodesReceived(@NonNull DecodedBarcodesUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -151,7 +151,7 @@ void onDecodedBarcodesReceived(@NonNull DecodedBarcodesUnit unit, IntermediateRe
The callback triggered when localized text lines are received.
```java
-void onLocalizedTextLinesReceived(@NonNull LocalizedTextLinesUnit unit, IntermediateResultExtraInfo info);
+default void onLocalizedTextLinesReceived(@NonNull LocalizedTextLinesUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -165,7 +165,7 @@ void onLocalizedTextLinesReceived(@NonNull LocalizedTextLinesUnit unit, Intermed
The callback triggered when recognized text lines are received.
```java
-void onRecognizedTextLinesReceived(@NonNull RecognizedTextLinesUnit unit, IntermediateResultExtraInfo info);
+default void onRecognizedTextLinesReceived(@NonNull RecognizedTextLinesUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -179,7 +179,7 @@ void onRecognizedTextLinesReceived(@NonNull RecognizedTextLinesUnit unit, Interm
The callback triggered when detected quads are received.
```java
-void onDetectedQuadsReceived(@NonNull DetectedQuadsUnit unit, IntermediateResultExtraInfo info);
+default void onDetectedQuadsReceived(@NonNull DetectedQuadsUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -193,7 +193,7 @@ void onDetectedQuadsReceived(@NonNull DetectedQuadsUnit unit, IntermediateResult
The callback triggered when deskewed images are received.
```java
-void onDeskewedImagesReceived(@NonNull DeskewedImagesUnit unit, IntermediateResultExtraInfo info);
+default void onDeskewedImagesReceived(@NonNull DeskewedImagesUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -207,7 +207,7 @@ void onDeskewedImagesReceived(@NonNull DeskewedImagesUnit unit, IntermediateResu
The callback triggered when enhanced images are received.
```java
-void onEnhancedImagesReceived(@NonNull EnhancedImagesUnit unit, IntermediateResultExtraInfo info);
+default void onEnhancedImagesReceived(@NonNull EnhancedImagesUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -221,7 +221,7 @@ void onEnhancedImagesReceived(@NonNull EnhancedImagesUnit unit, IntermediateResu
The callback triggered when colour images are received.
```java
-void onColourImageUnitReceived(@NonNull ColourImageUnit unit, IntermediateResultExtraInfo info);
+default void onColourImageUnitReceived(@NonNull ColourImageUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -235,7 +235,7 @@ void onColourImageUnitReceived(@NonNull ColourImageUnit unit, IntermediateResult
The callback triggered when scaled-down colour images are received.
```java
-void onScaledColourImageUnitReceived(@NonNull ScaledColourImageUnit unit, IntermediateResultExtraInfo info);
+default void onScaledColourImageUnitReceived(@NonNull ScaledColourImageUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -249,7 +249,7 @@ void onScaledColourImageUnitReceived(@NonNull ScaledColourImageUnit unit, Interm
The callback triggered when grayscale images are received.
```java
-void onGrayscaleImageUnitReceived(@NonNull GrayscaleImageUnit unit, IntermediateResultExtraInfo info);
+default void onGrayscaleImageUnitReceived(@NonNull GrayscaleImageUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -263,7 +263,7 @@ void onGrayscaleImageUnitReceived(@NonNull GrayscaleImageUnit unit, Intermediate
The callback triggered when transformed grayscale images are received.
```java
-void onTransformedGrayscaleImageUnitReceived(@NonNull TransformedGrayscaleImageUnit unit, IntermediateResultExtraInfo info);
+default void onTransformedGrayscaleImageUnitReceived(@NonNull TransformedGrayscaleImageUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -277,7 +277,7 @@ void onTransformedGrayscaleImageUnitReceived(@NonNull TransformedGrayscaleImageU
The callback triggered when enhanced grayscale images are received.
```java
-void onEnhancedGrayscaleImageUnitReceived(@NonNull EnhancedGrayscaleImageUnit unit, IntermediateResultExtraInfo info);
+default void onEnhancedGrayscaleImageUnitReceived(@NonNull EnhancedGrayscaleImageUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -291,7 +291,7 @@ void onEnhancedGrayscaleImageUnitReceived(@NonNull EnhancedGrayscaleImageUnit un
The callback triggered when binary images are received.
```java
-void onBinaryImageUnitReceived(@NonNull BinaryImageUnit unit, IntermediateResultExtraInfo info);
+default void onBinaryImageUnitReceived(@NonNull BinaryImageUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -305,7 +305,7 @@ void onBinaryImageUnitReceived(@NonNull BinaryImageUnit unit, IntermediateResult
The callback triggered when texture detection results are received.
```java
-void onTextureDetectionResultUnitReceived(@NonNull TextureDetectionResultUnit unit, IntermediateResultExtraInfo info);
+default void onTextureDetectionResultUnitReceived(@NonNull TextureDetectionResultUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -319,7 +319,7 @@ void onTextureDetectionResultUnitReceived(@NonNull TextureDetectionResultUnit un
The callback triggered when texture removed grayscale images are received.
```java
-void onTextureRemovedGrayscaleImageUnitReceived(@NonNull TextureRemovedGrayscaleImageUnit unit, IntermediateResultExtraInfo info);
+default void onTextureRemovedGrayscaleImageUnitReceived(@NonNull TextureRemovedGrayscaleImageUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -333,7 +333,7 @@ void onTextureRemovedGrayscaleImageUnitReceived(@NonNull TextureRemovedGrayscale
The callback triggered when texture removed binary images are received.
```java
-void onTextureRemovedBinaryImageUnitReceived(@NonNull TextureRemovedBinaryImageUnit unit, IntermediateResultExtraInfo info);
+default void onTextureRemovedBinaryImageUnitReceived(@NonNull TextureRemovedBinaryImageUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -347,7 +347,7 @@ void onTextureRemovedBinaryImageUnitReceived(@NonNull TextureRemovedBinaryImageU
The callback triggered when contours are received.
```java
-void onContoursUnitReceived(@NonNull ContoursUnit unit, IntermediateResultExtraInfo info);
+default void onContoursUnitReceived(@NonNull ContoursUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -361,7 +361,7 @@ void onContoursUnitReceived(@NonNull ContoursUnit unit, IntermediateResultExtraI
The callback triggered when line segments are received.
```java
-void onLineSegmentsUnitReceived(@NonNull LineSegmentsUnit unit, IntermediateResultExtraInfo info);
+default void onLineSegmentsUnitReceived(@NonNull LineSegmentsUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -375,7 +375,7 @@ void onLineSegmentsUnitReceived(@NonNull LineSegmentsUnit unit, IntermediateResu
The callback triggered when text zones are received.
```java
-void onTextZonesUnitReceived(@NonNull TextZonesUnit unit, IntermediateResultExtraInfo info);
+default void onTextZonesUnitReceived(@NonNull TextZonesUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -389,7 +389,7 @@ void onTextZonesUnitReceived(@NonNull TextZonesUnit unit, IntermediateResultExtr
The callback triggered when text removed binary images are received.
```java
-void onTextRemovedBinaryImageUnitReceived(@NonNull TextRemovedBinaryImageUnit unit, IntermediateResultExtraInfo info);
+default void onTextRemovedBinaryImageUnitReceived(@NonNull TextRemovedBinaryImageUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -403,7 +403,7 @@ void onTextRemovedBinaryImageUnitReceived(@NonNull TextRemovedBinaryImageUnit un
The callback triggered when short lines are received.
```java
-void onShortLinesUnitReceived(@NonNull ShortLinesUnit unit IntermediateResultExtraInfo info);
+default void onShortLinesUnitReceived(@NonNull ShortLinesUnit unit IntermediateResultExtraInfo info);
```
**Parameters**
@@ -417,7 +417,7 @@ void onShortLinesUnitReceived(@NonNull ShortLinesUnit unit IntermediateResultExt
The callback triggered when logic lines are received.
```java
-void onLogicLinesUnitReceived(@NonNull LongLinesUnit unit, IntermediateResultExtraInfo info);
+default void onLogicLinesUnitReceived(@NonNull LongLinesUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -431,7 +431,7 @@ void onLogicLinesUnitReceived(@NonNull LongLinesUnit unit, IntermediateResultExt
The callback triggered when long lines are received.
```java
-void onLongLinesUnitReceived(@NonNull LongLinesUnit unit, IntermediateResultExtraInfo info);
+default void onLongLinesUnitReceived(@NonNull LongLinesUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -445,7 +445,7 @@ void onLongLinesUnitReceived(@NonNull LongLinesUnit unit, IntermediateResultExtr
The callback triggered when corners are received.
```java
-void onCornersUnitReceived(@NonNull CornersUnit unit, IntermediateResultExtraInfo info);
+default void onCornersUnitReceived(@NonNull CornersUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -459,7 +459,7 @@ void onCornersUnitReceived(@NonNull CornersUnit unit, IntermediateResultExtraInf
The callback triggered when candidate quad edges are received.
```java
-void onCandidateQuadEdgesUnitReceived(@NonNull CandidateQuadEdgesUnit unit, IntermediateResultExtraInfo info);
+default void onCandidateQuadEdgesUnitReceived(@NonNull CandidateQuadEdgesUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -473,7 +473,7 @@ void onCandidateQuadEdgesUnitReceived(@NonNull CandidateQuadEdgesUnit unit, Inte
The callback triggered when candidate barcode zones are received.
```java
-void onCandidateBarcodeZonesUnitReceived(@NonNull CandidateBarcodeZonesUnit unit, IntermediateResultExtraInfo info);
+default void onCandidateBarcodeZonesUnitReceived(@NonNull CandidateBarcodeZonesUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -487,7 +487,7 @@ void onCandidateBarcodeZonesUnitReceived(@NonNull CandidateBarcodeZonesUnit unit
The callback triggered when scaled up barcode images are received.
```java
-void onScaledBarcodeImageUnitReceived(@NonNull ScaledBarcodeImageUnit unit, IntermediateResultExtraInfo info);
+default void onScaledBarcodeImageUnitReceived(@NonNull ScaledBarcodeImageUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -501,7 +501,7 @@ void onScaledBarcodeImageUnitReceived(@NonNull ScaledBarcodeImageUnit unit, Inte
The callback triggered when deformation resisted barcode images are received.
```java
-void onDeformationResistedBarcodeImageUnitReceived(@NonNull DeformationResistedBarcodeImageUnit unit, IntermediateResultExtraInfo info);
+default void onDeformationResistedBarcodeImageUnitReceived(@NonNull DeformationResistedBarcodeImageUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -515,7 +515,7 @@ void onDeformationResistedBarcodeImageUnitReceived(@NonNull DeformationResistedB
The callback triggered when complemented barcode images are received.
```java
-void onComplementedBarcodeImageUnitReceived(@NonNull ComplementedBarcodeImageUnit unit, IntermediateResultExtraInfo info);
+default void onComplementedBarcodeImageUnitReceived(@NonNull ComplementedBarcodeImageUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
@@ -529,7 +529,7 @@ void onComplementedBarcodeImageUnitReceived(@NonNull ComplementedBarcodeImageUni
The callback triggered when a raw text lines unit is received.
```java
-void onRawTextLinesUnitReceived(@NonNull RawTextLinesUnit unit, IntermediateResultExtraInfo info);
+default void onRawTextLinesUnitReceived(@NonNull RawTextLinesUnit unit, IntermediateResultExtraInfo info);
```
**Parameters**
diff --git a/programming/android/api-reference/capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.md b/programming/android/api-reference/capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.md
index 0edb64b4..88e492d4 100644
--- a/programming/android/api-reference/capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.md
+++ b/programming/android/api-reference/capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.md
@@ -22,16 +22,19 @@ The `SimplifiedCaptureVisionSettings` class contains settings for capturing and
class SimplifiedCaptureVisionSettings
```
-## Methods & Attributes
+## Attributes & Methods
| Method | Description |
|----------------------|-------------|
| [`toJSON`](#tojson) | Generate the current `SimplifiedCaptureVisionSettings` object to a JSON string. |
| [`fromJSON`](#fromjson) | Generate a `SimplifiedCaptureVisionSettings` object from a JSON string. |
+| [`toString`](#tostring) | Generate the current `SimplifiedCaptureVisionSettings` object to a string. |
+
+
| Attribute | Type | Description |
| --------- | ---- | ----------- |
-| [`outputOriginalImage`](#capturedresultitemtypes) | *int* | Specifies whether to output the original image or not. |
+| [`outputOriginalImage`](#capturedresultitemtypes) | *boolean* | Specifies whether to output the original image or not. |
| [`roi`](#roi) | *[Quadrilateral](../../core/basic-structures/quadrilateral.md)* | Specifies the region of interest (ROI) of the image or frame where the capture and recognition will take place. |
| [`roiMeasuredInPercentage`](#roimeasuredinpercentage) | *boolean* | Specifies whether the ROI is measured in pixels (false) or as a percentage of the image dimensions (true). |
| [`maxParallelTasks`](#maxparalleltasks) | *int* | Specifies the maximum number of parallel tasks that can be used for image capture and recognition. |
@@ -65,6 +68,20 @@ static SimplifiedCaptureVisionSettings fromJSON(String jsonString);
The generated `SimplifiedCaptureVisionSettings` object.
+### toString
+
+Generate the current `SimplifiedCaptureVisionSettings` object to a string.
+
+```java
+@NonNull
+@Override
+public String toString();
+```
+
+**Return Value**
+
+A string representation of the current `SimplifiedCaptureVisionSettings` object.
+
### outputOriginalImage
Specifies whether to output the original image or not.
diff --git a/programming/android/api-reference/capture-vision-router/enum/capture-state.md b/programming/android/api-reference/capture-vision-router/enum/capture-state.md
index 481d0bcd..ccbe8966 100644
--- a/programming/android/api-reference/capture-vision-router/enum/capture-state.md
+++ b/programming/android/api-reference/capture-vision-router/enum/capture-state.md
@@ -14,12 +14,17 @@ breadcrumbText: CaptureState
`CaptureState` describes the state of data capturing.
```java
-@Retention(RetentionPolicy.CLASS)
+@Retention(SOURCE)
+@IntDef({CS_STARTED, CS_STOPPED, CS_PAUSED, CS_RESUME})
public @interface EnumCaptureState
{
/** The data capturing is started. */
public static final int CS_STARTED = 0;
/** The data capturing is stopped. */
public static final int CS_STOPPED = 1;
+ /** The data capturing is paused. */
+ public static final int CS_PAUSED = 2;
+ /** The data capturing is resumed. */
+ public static final int CS_RESUME = 3;
}
```
diff --git a/programming/android/api-reference/capture-vision-router/enum/image-source-state.md b/programming/android/api-reference/capture-vision-router/enum/image-source-state.md
index adc18c11..8a2bed74 100644
--- a/programming/android/api-reference/capture-vision-router/enum/image-source-state.md
+++ b/programming/android/api-reference/capture-vision-router/enum/image-source-state.md
@@ -16,7 +16,8 @@ codeAutoHeight: true
`ImageSourceState` describes the state of an object that conforms to the `ImageSourceAdapter` interface and is designated as the image source in a `CaptureVisionRouter` object.
```java
-@Retention(RetentionPolicy.CLASS)
+@Retention(SOURCE)
+@IntDef({CS_STARTED, CS_STOPPED, CS_PAUSED, CS_RESUME})
public @interface EnumImageSourceState
{
/** Indicates that the buffer of the image source is currently empty. */
diff --git a/programming/android/api-reference/core/basic-structures/captured-result-filter.md b/programming/android/api-reference/core/basic-structures/captured-result-filter.md
deleted file mode 100644
index a3debc1c..00000000
--- a/programming/android/api-reference/core/basic-structures/captured-result-filter.md
+++ /dev/null
@@ -1,109 +0,0 @@
----
-layout: default-layout
-title: CapturedResultFilter - Dynamsoft Core Module Android Edition API Reference
-description: The interface CapturedResultFilter of Dynamsoft Core Module represents a captured result filter, which is responsible for filtering different types of captured results, including original image, decoded barcodes, recognized text lines, detected quads, normalized images, and parsed results.
-keywords: captured result filter, Java, Kotlin
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-ignore: true
----
-
-# CapturedResultFilter
-
-> You are reading a history page of `DynamsoftCore`. Start from v3.2.10, the `CapturedResultFilter` class is moved to the `DynamsoftCaptureVisionRouter` module. View the [`DynamsoftCaptureVisionRouter.CapturedResultFilter`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-filter.html) for the latest version.
-
-The `CapturedResultFilter` interface represents a captured result filter, which is responsible for filtering different types of captured results, including original image, decoded barcodes, recognized text lines, detected quads, normalized images, and parsed results.
-
-## Definition
-
-*Namespace:* com.dynamsoft.core.basic_structures
-
-*Assembly:* DynamsoftCaptureVisionBundle.aar
-
-```java
-interface CapturedResultFilter
-```
-
-## Methods
-
-| Method | Description |
-| ------ | ----------- |
-| [`onOriginalImageResultReceived`](#onoriginalimageresultreceived) | The method for monitoring the output of `OriginalImageResultItem`. |
-| [`onDecodedBarcodesReceived`](#ondecodedbarcodesreceived) | The method for monitoring the output of `DecodedBarcodesResult`. |
-| [`onRecognizedTextLinesReceived`](#onrecognizedtextlinesreceived) | The method for monitoring the output of `RecognizedTextLinesResult`. |
-| [`onDetectedQuadsReceived`](#ondetectedquadsreceived) | The method for monitoring the output of `DetectedQuadsResult`. |
-| [`onNormalizedImagesReceived`](#onnormalizedimagesreceived) | The method for monitoring the output of `NormalizedImagesResult`. |
-| [`onParsedResultsReceived`](#onparsedresultsreceived) | The method for monitoring the output of `ParsedResult`. |
-
-### onOriginalImageResultReceived
-
-The method for monitoring the output of [`OriginalImageResultItem`](original-image-result-item.md).
-
-```java
-void onOriginalImageResultReceived(OriginalImageResultItem result);
-```
-
-**Parameters**
-
-`[in] result`: A [`OriginalImageResultItem`](original-image-result-item.md) object as a original image result.
-
-### onDecodedBarcodesReceived
-
-The method for monitoring the output of DecodedBarcodesResult.
-
-```java
-void onDecodedBarcodesReceived(DecodedBarcodesResult result);
-```
-
-**Parameters**
-
-`[in] result`: A `DecodedBarcodesResult` object as a decoded barcode result.
-
-### onRecognizedTextLinesReceived
-
-The method for monitoring the output of RecognizedTextLinesResult.
-
-```java
-void onRecognizedTextLinesReceived(RecognizedTextLinesResult result);
-```
-
-**Parameters**
-
-`[in] result`: A `RecognizedTextLinesResult` object as a recognized text line result.
-
-### onDetectedQuadsReceived
-
-The method for monitoring the output of [`DetectedQuadsResult`]({{site.ddn_android_api}}detected-quads-result.html).
-
-```java
-void onDetectedQuadsReceived(DetectedQuadsResult result);
-```
-
-**Parameters**
-
-`[in] result`: A [`DetectedQuadsResult`]({{site.ddn_android_api}}detected-quads-result.html) object as a detected quad result.
-
-### onNormalizedImagesReceived
-
-The method for monitoring the output of [`NormalizedImagesResult`]({{site.ddn_android_api}}normalized-images-result.html).
-
-```java
-void onNormalizedImagesReceived(NormalizedImagesResult result);
-```
-
-**Parameters**
-
-`[in] result`: A [`NormalizedImagesResult`]({{site.ddn_android_api}}normalized-images-result.html) object as a normalized image result.
-
-### onParsedResultsReceived
-
-The method for monitoring the output of ParsedResult.
-
-```java
-void onParsedResultsReceived(ParsedResult result);
-```
-
-**Parameters**
-
-`[in] result`: A `ParsedResult` object as a parsed result.
diff --git a/programming/android/api-reference/core/basic-structures/captured-result-receiver.md b/programming/android/api-reference/core/basic-structures/captured-result-receiver.md
deleted file mode 100644
index f95946fe..00000000
--- a/programming/android/api-reference/core/basic-structures/captured-result-receiver.md
+++ /dev/null
@@ -1,122 +0,0 @@
----
-layout: default-layout
-title: CapturedResultReceiver - Dynamsoft Core Module Android Edition API Reference
-description: The interface CapturedResultReceiver of Dynamsoft Core Module Android Edition provides methods for monitoring the output of captured results, including captured result, original image result, decoded barcode result, recognized text line result, detected quad result, normalized image result, and parsed result.
-keywords: captured result, original image result, decoded barcode result, recognized text line result, detected quad result, normalized image result, parsed result, Java, Kotlin
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-ignore: true
----
-
-# CapturedResultReceiver
-
-> You are reading a history page of `DynamsoftCore`. Start from v3.2.10, the `CapturedResultReceiver` class is moved to the `DynamsoftCaptureVisionRouter` module. View the [`DynamsoftCaptureVisionRouter.CapturedResultReceiver`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) for the latest version.
-
-The `CapturedResultReceiver` interface provides methods for monitoring the output of captured results, which can consist of original image result(s), decoded barcode result(s), recognized text line result(s), detected quad result(s), normalized image result(s), or parsed result(s). 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
-
-*Namespace:* com.dynamsoft.core.basic_structures
-
-*Assembly:* DynamsoftCaptureVisionBundle.aar
-
-```java
-interface CapturedResultReceiver
-```
-
-## Methods
-
-| Method | Description |
-| ------ | ----------- |
-| [`onCapturedResultReceived`](#oncapturedresultreceived) | The method for monitoring the output of `CapturedResult`. |
-| [`onOriginalImageResultReceived`](#onoriginalimageresultreceived) | The method for monitoring the output of `OriginalImageResultItem`. |
-| [`onDecodedBarcodesReceived`](#ondecodedbarcodesreceived) | The method for monitoring the output of `DecodedBarcodesResult`. |
-| [`onRecognizedTextLinesReceived`](#onrecognizedtextlinesreceived) | The method for monitoring the output of `RecognizedTextLinesResult`. |
-| [`onDetectedQuadsReceived`](#ondetectedquadsreceived) | The method for monitoring the output of `DetectedQuadsResult`. |
-| [`onNormalizedImagesReceived`](#onnormalizedimagesreceived) | The method for monitoring the output of `NormalizedImagesResult`. |
-| [`onParsedResultsReceived`](#onparsedresultsreceived) | The method for monitoring the output of `ParsedResult`. |
-
-### onCapturedResultReceived
-
-The method for monitoring the output of [`CapturedResult`](captured-result.md).
-
-```java
-void onCapturedResultReceived(CapturedResult result);
-```
-
-**Parameters**
-
-`[in] result`: A [`CapturedResult`](captured-result.md) object as a captured result.
-
-### onOriginalImageResultReceived
-
-The method for monitoring the output of [`OriginalImageResultItem`](original-image-result-item.md).
-
-```java
-void onOriginalImageResultReceived(OriginalImageResultItem result);
-```
-
-**Parameters**
-
-`[in] result`: A [`OriginalImageResultItem`](original-image-result-item.md) object as a original image result.
-
-### onDecodedBarcodesReceived
-
-The method for monitoring the output of `DecodedBarcodesResult`.
-
-```java
-void onDecodedBarcodesReceived(DecodedBarcodesResult result);
-```
-
-**Parameters**
-
-`[in] result`: A `DecodedBarcodesResult` object as a decoded barcode result.
-
-### onRecognizedTextLinesReceived
-
-The method for monitoring the output of `RecognizedTextLinesResult`.
-
-```java
-void onRecognizedTextLinesReceived(RecognizedTextLinesResult result);
-```
-
-**Parameters**
-
-`[in] result`: A `RecognizedTextLinesResult` object as a recognized text line result.
-
-### onDetectedQuadsReceived
-
-The method for monitoring the output of [`DetectedQuadsResult`]({{site.ddn_android_api}}detected-quads-result.html).
-
-```java
-void onDetectedQuadsReceived(DetectedQuadsResult result);
-```
-
-**Parameters**
-
-`[in] result`: A [`DetectedQuadsResult`]({{site.ddn_android_api}}detected-quads-result.html) object as a detected quad result.
-
-### onNormalizedImagesReceived
-
-The method for monitoring the output of [`NormalizedImagesResult`]({{site.ddn_android_api}}normalized-images-result.html).
-
-```java
-void onNormalizedImagesReceived(NormalizedImagesResult result);
-```
-
-**Parameters**
-
-`[in] result`: A [`NormalizedImagesResult`]({{site.ddn_android_api}}normalized-images-result.html) object as a normalized image result.
-
-### onParsedResultsReceived
-
-The method for monitoring the output of `ParsedResult`.
-
-```java
-void onParsedResultsReceived(ParsedResult result);
-```
-
-**Parameters**
-
-`[in] result`: A `ParsedResult` object as a parsed result.
diff --git a/programming/android/api-reference/core/basic-structures/captured-result.md b/programming/android/api-reference/core/basic-structures/captured-result.md
deleted file mode 100644
index c1be958b..00000000
--- a/programming/android/api-reference/core/basic-structures/captured-result.md
+++ /dev/null
@@ -1,101 +0,0 @@
----
-layout: default-layout
-title: CapturedResult - Dynamsoft Core Module Android Edition API Reference
-description: The class CapturedResult of Dynamsoft Core Module represents the result of a capture operation on an image, which contains multiple items such as barcode, text line, detected quad, normalized image, original image, parsed item, etc.
-keywords: captured result, Java, Kotlin
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-ignore: true
----
-
-# CapturedResult
-
-> You are reading a history page of `DynamsoftCore`. Start from v3.2.10, the `CapturedResult` class is moved to the `DynamsoftCaptureVisionRouter` module. View the [`DynamsoftCaptureVisionRouter.CapturedResult`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result.html) for the latest version.
-
-The `CapturedResult` class represents the result of a capture operation on an image. Internally, `CapturedResult` stores an array that contains multiple items, each of which may be a barcode, text line, detected quad, normalized image, original image, parsed item, etc.
-
-## Definition
-
-*Namespace:* com.dynamsoft.core.basic_structures
-
-*Assembly:* DynamsoftCaptureVisionBundle.aar
-
-```java
-class CapturedResult
-```
-
-## Attributes
-
-| Method | Description |
-| ------ | ----------- |
-| [`getOriginalImageHashId`](#getoriginalimagehashid) | Get the hash id of the original image. You can use this ID to get the original image via `IntermediateResultManager` class. |
-| [`getOriginalImageTag`](#getoriginalimagetag) | Get the [ImageTag](image-tag.md) of the original image that records information such as the image ID of the original image. |
-| [`getItems`](#getitems) | Get an array of `CapturedResultItems`, which are the basic unit of the captured results. A `CapturedResultItem` can be a original image, a decoded barcode, a recognized text, a detected quad, a normalized image or a parsed result. View CapturedResultItemType for all available types. |
-| [`getrotationTransformMatrix`](#getrotationtransformmatrix) | Get the rotation transformation matrix of the original image relative to the rotated image. |
-| [`getErrorCode`](#geterrorcode) | Get the error code if an error occurs when processing the image. |
-| [`getErrorMessage`](#geterrormessage) | Get the error message if an error occurs when processing the image. |
-
-### getOriginalImageHashId
-
-Get the hash ID of the original image which can be used to get the original image via the [IntermediateResultManager](../intermediate-results/intermediate-result-manager.md) class.
-
-```java
-String getOriginalImageHashId();
-```
-
-**Return Value**
-
-The hash id of the original image.
-
-### getOriginalImageTag
-
-Get the [ImageTag](image-tag.md) of the original image that records information such as the image ID of the original image.
-
-```java
-ImageTag getOriginalImageTag();
-```
-
-**Return Value**
-
-The tag of the original image that records the information of the original image.
-
-### getItems
-
-Get an array of [`CapturedResultItem`](captured-result-item.md), which is the basic unit of the captured results. A [`CapturedResultItem`](captured-result-item.md) can be a original image, a decoded barcode, a recognized text, a detected quad, a normalized image, or a parsed result. View [`CapturedResultItemType`]({{ site.dcv_android_api }}core/enum/captured-result-item-type.html) for all available types.
-
-```java
-CapturedResultItem[] getItems();
-```
-
-**Return Value**
-
-An array containing the [`CapturedResultItem`](captured-result-item.md) objects within the captured result.
-
-### getRotationTransformMatrix
-
-Get the rotation transformation matrix of the original image relative to the rotated image.
-
-```java
-Matrix getRotationTransformMatrix();
-```
-
-**Return Value**
-
-Return the rotation transformation matrix of the original image relative to the rotated image.
-
-### getErrorCode
-
-Get the error code if an error occurs when processing the image.
-
-```java
-int getErrorCode();
-```
-
-### getErrorMessage
-
-Get the error message if an error occurs when processing the image.
-
-```java
-String getErrorMessage();
-```
diff --git a/programming/android/api-reference/core/basic-structures/completion-listener.md b/programming/android/api-reference/core/basic-structures/completion-listener.md
index d4feb826..b080e276 100644
--- a/programming/android/api-reference/core/basic-structures/completion-listener.md
+++ b/programming/android/api-reference/core/basic-structures/completion-listener.md
@@ -42,14 +42,14 @@ void onSuccess();
The methods is triggered when the `startCapturing` failed.
```java
-void onFailure(int errorCode, String errorMessage);
+void onFailure(int errorCode, String errorString);
```
**Parameters**
`[in] errorCode`: The error code that describes why the `startCapturing` failed.
-`[in] errorMessage`: The error message that describes why the `startCapturing` failed.
+`[in] errorString`: The error message that describes why the `startCapturing` failed.
Possible Errors:
diff --git a/programming/android/api-reference/core/basic-structures/contour.md b/programming/android/api-reference/core/basic-structures/contour.md
index e0ce4c4d..9d77e244 100644
--- a/programming/android/api-reference/core/basic-structures/contour.md
+++ b/programming/android/api-reference/core/basic-structures/contour.md
@@ -22,12 +22,18 @@ The `Contour` class represents a contour made up of multiple points.
class Contour
```
-## Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
| [`points`](#points) | *android.graphics.Point[]* | An array of `Point` objects defining the vertices of the contour. |
+| Method | Description |
+|------- |-------------|
+| [`Contour`](#contour-1) | The default constructor. |
+| [`Contour(Point[])`](#contourpoint-points) | Constructs a contour from an array of points. |
+| [`transformByMatrix`](#transformbymatrix) | Transforms the coordinates of the contour by a transformation matrix. |
+
### points
An array of `android.graphics.Point` objects defining the vertices of the contour.
@@ -35,3 +41,33 @@ An array of `android.graphics.Point` objects defining the vertices of the contou
```java
Point[] points;
```
+
+### Contour
+
+The default constructor.
+
+```java
+Contour();
+```
+
+### Contour(Point[] points)
+
+Constructs a contour from an array of points.
+
+```java
+Contour(Point[] points);
+```
+
+### transformByMatrix
+
+```java
+Contour transformByMatrix(Matrix matrix);
+```
+
+**Parameters**
+
+`matrix`: The transformation matrix.
+
+**Return Value**
+
+The transformed contour.
diff --git a/programming/android/api-reference/core/basic-structures/core-module.md b/programming/android/api-reference/core/basic-structures/core-module.md
index cbcb56e5..8f42b0f7 100644
--- a/programming/android/api-reference/core/basic-structures/core-module.md
+++ b/programming/android/api-reference/core/basic-structures/core-module.md
@@ -47,7 +47,7 @@ The version of the `DynamsoftCore` module.
Enable the output of logs.
```java
-static void enableLogging(int logMode);
+static void enableLogging(Context context, @EnumLogMode int logMode);
```
**Parameters**
diff --git a/programming/android/api-reference/core/basic-structures/corner.md b/programming/android/api-reference/core/basic-structures/corner.md
index c2cfc7a1..18340712 100644
--- a/programming/android/api-reference/core/basic-structures/corner.md
+++ b/programming/android/api-reference/core/basic-structures/corner.md
@@ -22,23 +22,34 @@ The `Corner` class represents a corner, typically where two line segments meet
class Corner
```
-## Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
-| [`type`](#type) | *[EnumCornerType]({{ site.dcv_android_api }}core/enum/corner-type.html?lang=android)* | The type of the corner. The types are availabled as normal-intersected, T-intersected, cross-intersected, not-intersected. |
+| [`type`](#type) | *int* | The type of the corner. The types are availabled as normal-intersected, T-intersected, cross-intersected, not-intersected. |
| [`intersection`](#intersection) | *android.graphics.Point* | The coordinate of the intersection point of the corner. |
| [`line1`](#line1) | *[LineSegment](line-segment.md)* | One of the lines of the corner. Defined in LineSegment. |
| [`line2`](#line2) | *[LineSegment](line-segment.md)* | One of the lines of the corner. Defined in LineSegment. |
+| Method | Description |
+|------- |-------------|
+| [`Corner`](#corner-1) | The default constructor. |
+| [`Corner(type,insection,line1,line2)`](#cornertypeinsectionline1line2) | Constructs a corner from the type, intersection, and lines. |
+| [`transformByMatrix`](#transformbymatrix) | Transforms the coordinates of the corner by a transformation matrix. |
+
### type
The type of the corner. The types are availabled as normal-intersected, T-intersected, cross-intersected, not-intersected.
```java
-EnumCornerType type;
+@EnumCornerType
+int type;
```
+Related APIs:
+
+- [EnumCornerType]({{ site.dcv_android_api }}core/enum/corner-type.html?lang=android)
+
### intersection
The coordinate of the intersection point of the corner.
@@ -62,3 +73,35 @@ One of the lines of the corner. Defined in `LineSegment`.
```java
LineSegment line2;
```
+
+### Corner
+
+The default constructor.
+
+```java
+Corner();
+```
+
+### Corner(type,insection,line1,line2)
+
+Constructs a corner from the type, intersection, and lines.
+
+```java
+Corner(int type,Point intersection,LineSegment line1,LineSegment line2);
+```
+
+### transformByMatrix
+
+Transforms the coordinates of the corner by a transformation matrix.
+
+```java
+Corner transformByMatrix(Matrix matrix);
+```
+
+**Parameters**
+
+`matrix`: The transformation matrix.
+
+**Return Value**
+
+The transformed corner.
diff --git a/programming/android/api-reference/core/basic-structures/edge.md b/programming/android/api-reference/core/basic-structures/edge.md
index f1d9ba11..03d720b6 100644
--- a/programming/android/api-reference/core/basic-structures/edge.md
+++ b/programming/android/api-reference/core/basic-structures/edge.md
@@ -22,13 +22,19 @@ The `Edge` class represents an edge defined by two `Corners`.
class Edge
```
-## Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
| [`startCorner`](#startcorner) | *[Corner](corner.md)* | The starting corner of the edge. |
| [`endCorner`](#endcorner) | *[Corner](corner.md)* | The ending corner of the edge. |
+| Method | Description |
+|------- |-------------|
+| [`Edge`](#edge-1) | The default constructor. |
+| [`Edge(startCorner,endCorner)`](#edgestartcornerendcorner) | Constructs a corner from the type, intersection, and lines. |
+| [`transformByMatrix`](#transformbymatrix) | Transforms the coordinates of the corner by a transformation matrix. |
+
### startCorner
The starting corner of the edge.
@@ -44,3 +50,29 @@ The ending corner of the edge.
```java
Corner endCorner;
```
+
+### Edge
+
+```java
+Edge();
+```
+
+### Edge(startCorner,endCorner)
+
+```java
+Edge(Corner startCorner, Corner endCorner);
+```
+
+### transformByMatrix
+
+```java
+Edge transformByMatrix(Matrix matrix);
+```
+
+**Parameters**
+
+`matrix`: The transformation matrix.
+
+**Return Value**
+
+The transformed edge.
diff --git a/programming/android/api-reference/core/basic-structures/image-data.md b/programming/android/api-reference/core/basic-structures/image-data.md
index 84d13017..462dc32e 100644
--- a/programming/android/api-reference/core/basic-structures/image-data.md
+++ b/programming/android/api-reference/core/basic-structures/image-data.md
@@ -30,7 +30,7 @@ class ImageData
| [`width`](#width) | *int* | The width of the image in pixels. |
| [`height`](#height) | *int* | The height of the image in pixels. |
| [`stride`](#stride) | *int* | The stride (or scan width) of the image. |
-| [`format`](#format) | *[EnumImagePixelFormat]({{ site.dcv_android_api }}core/enum/image-pixel-format.html?lang=android)* | The image pixel format used in the image byte array. |
+| [`format`](#format) | *int* | The image pixel format used in the image byte array. |
| [`orientation`](#orientation) | *int* | The orientation information of the image. The library is able to read the orientation information from the EXIF data of the image file. |
| [`tag`](#tag) | *[ImageTag](image-tag.md)* | The tag of the image. |
@@ -38,7 +38,9 @@ class ImageData
| Method | Description |
| ------ | ----------- |
+| [`ImageData`](#imagedata-1) | The constructor. |
| [`toBitmap`](#tobitmap) | Transform the ImageData to an `android.graphics.Bitmap`. |
+| [`fromBitmap`](#frombitmap) | Convert an `android.graphics.Bitmap` to an ImageData. |
| [`toString`](#tostring) | Transform the ImageData to a string. |
### bytes
@@ -78,9 +80,14 @@ int stride;
The image pixel format used in the image byte array.
```java
+@EnumImagePixelFormat
int format;
```
+Related APIs:
+
+- [EnumImagePixelFormat]({{ site.dcv_android_api }}core/enum/image-pixel-format.html?lang=android)
+
### orientation
The orientation information of the image. The library is able to read the orientation information from the EXIF data of the image file.
@@ -94,7 +101,15 @@ int orientation;
The tag of the image.
```java
-ImageTag tag;
+ImageTag imageTag;
+```
+
+### ImageData
+
+The constructor.
+
+```java
+ImageData();
```
### toBitmap
@@ -115,6 +130,14 @@ Bitmap toBitmap() throws CoreException;
An `android.graphics.Bitmap` that converted from the `ImageData`.
+### fromBitmap
+
+Convert an `android.graphics.Bitmap` to an ImageData.
+
+```java
+static ImageData fromBitmap(Bitmap bitmap);
+```
+
### toString
Transform the `ImageData` to a string.
diff --git a/programming/android/api-reference/core/basic-structures/image-source-adapter.md b/programming/android/api-reference/core/basic-structures/image-source-adapter.md
index d1270f2a..07ba3109 100644
--- a/programming/android/api-reference/core/basic-structures/image-source-adapter.md
+++ b/programming/android/api-reference/core/basic-structures/image-source-adapter.md
@@ -26,6 +26,7 @@ class ImageSourceAdapter
| Method | Description |
| ------ | ----------- |
+| [`ImageSourceAdapter`](#imagesourceadapter-1 ) | The constructor. |
| [`addImageToBuffer`](#addimagetobuffer) | Adds an image to the internal buffer. |
| [`clearBuffer`](#clearbuffer) | Clears all images from the buffer, resetting the state for new image fetching. |
| [`getBufferOverflowProtectionMode`](#getbufferoverflowprotectionmode) | Get the current mode for handling buffer overflow. |
@@ -45,6 +46,14 @@ class ImageSourceAdapter
| [`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. |
+### ImageSourceAdapter
+
+The constructor.
+
+```java
+ImageSourceAdapter();
+```
+
### addImageToBuffer
Adds an image to the internal buffer.
@@ -70,7 +79,8 @@ void clearBuffer();
Get the current mode for handling buffer overflow.
```java
-BufferOverflowProtectionMode getBufferOverflowProtectionMode();
+@EnumBufferOverflowProtectionMode
+int getBufferOverflowProtectionMode();
```
### getColourChannelUsageType
@@ -78,7 +88,8 @@ BufferOverflowProtectionMode getBufferOverflowProtectionMode();
Get the current usage type for color channels in images.
```java
-EnumColourChannelUsageType getColourChannelUsageType();
+@EnumColourChannelUsageType
+int getColourChannelUsageType();
```
### getImageCount
@@ -165,7 +176,7 @@ A boolean value that indicates whether the Video Buffer is empty.
Sets the behavior for handling new incoming images when the buffer is full.
```java
-void setBufferOverflowProtectionMode(BufferOverflowProtectionMode mode);
+void setBufferOverflowProtectionMode(@EnumBufferOverflowProtectionMode int mode);
```
**Parameters**
@@ -181,7 +192,7 @@ The buffer overflow protection mode.
Sets the usage type for color channels in images.
```java
-void setColourChannelUsageType(EnumColourChannelUsageType type);
+void setColourChannelUsageType(@EnumColourChannelUsageType int type);
```
**Parameters**
@@ -197,7 +208,7 @@ One of the [`EnumColourChannelUsageType`]({{ site.dcv_android_api }}core/enum/co
Sets an error listener to receive notifications about errors that occur during image source operations.
```java
-void setErrorListener(ImageSourceErrorListener* listener);
+void setErrorListener(ImageSourceErrorListener listener);
```
**Parameters**
diff --git a/programming/android/api-reference/core/basic-structures/image-source-error-listener.md b/programming/android/api-reference/core/basic-structures/image-source-error-listener.md
index 66110349..603587dd 100644
--- a/programming/android/api-reference/core/basic-structures/image-source-error-listener.md
+++ b/programming/android/api-reference/core/basic-structures/image-source-error-listener.md
@@ -33,11 +33,9 @@ interface ImageSourceErrorListener
The callback method for monitoring the errors that occur in the [`ImageSourceAdapter`](image-source-adapter.md).
```java
-void onErrorReceived(int errorCode, String errorMessage);
+void onErrorReceived(CoreException imageSourceError);
```
**Parameters**
-`errorCode`: An enumeration value of type `EnumErrorCode` indicating the type of error..
-
-`errorMessage`: A string containing the error message providing additional information about the error.
+`imageSourceError`: A CoreException containing the error code and error message.
diff --git a/programming/android/api-reference/core/basic-structures/image-tag.md b/programming/android/api-reference/core/basic-structures/image-tag.md
index b141b153..56246278 100644
--- a/programming/android/api-reference/core/basic-structures/image-tag.md
+++ b/programming/android/api-reference/core/basic-structures/image-tag.md
@@ -26,12 +26,21 @@ class ImageTag
| Methods | Description |
| ------- | ----------- |
+| [`ImageTag`](#imagetag-1) | The constructor. |
| [`setImageId`](#setimageid) | Set the ID of the image. The ID is the unique identifier of the image. |
| [`getImageId`](#getimageid) | Get the ID of the image. The ID is the unique identifier of the image. |
-| [`getType`](#gettype) | The type of the image tag. |
+| [`getTagType`](#gettagtype) | The type of the image tag. |
| [`setDistanceMode`](#setdistancemode) | Set the capture distance mode of the image. |
| [`getDistanceMode`](#getdistancemode) | Get the capture distance mode of the image. |
+### ImageTag
+
+The constructor.
+
+```java
+ImageTag();
+```
+
### setImageId
Set the ID of the image. The ID is the unique identifier of the image.
@@ -56,38 +65,38 @@ int getImageId();
The ID of the image.
-### getType
+### getTagType
The type of the image tag.
```java
-EnumImageTagType getType();
+int getTagType();
```
**Return Value**
-The [`EnumImageTagType`]({{ site.dcv_android_api }}core/enum/image-tag-type.html) of the image.
+The type of the image tag. Refer to [`EnumImageTagType`]({{ site.dcv_android_api }}core/enum/image-tag-type.html).
### setDistanceMode
Set the capture distance mode of the image.
```java
-void setDistanceMode(EnumImageCaptureDistanceMode distanceMode)
+void setDistanceMode(int distanceMode)
```
**Parameters**
-`[in] distanceMode`: The capture distance mode of the image.
+`[in] distanceMode`: The capture distance mode of the image. Refer to [`EnumImageCaptureDistanceMode`]({{ site.dcv_android_api }}core/enum/image-capture-distance-mode.html).
### getDistanceMode
Get the capture distance mode of the image.
```java
-EnumImageCaptureDistanceMode getDistanceMode()
+int getDistanceMode()
```
**Return Value**
-The [`EnumImageCaptureDistanceMode`]({{ site.dcv_android_api }}core/enum/image-capture-distance-mode.html) of the image.
+The distance mode of the image. Refer to [`EnumImageCaptureDistanceMode`]({{ site.dcv_android_api }}core/enum/image-capture-distance-mode.html).
diff --git a/programming/android/api-reference/core/basic-structures/line-segment.md b/programming/android/api-reference/core/basic-structures/line-segment.md
index 3323d6bb..5876d200 100644
--- a/programming/android/api-reference/core/basic-structures/line-segment.md
+++ b/programming/android/api-reference/core/basic-structures/line-segment.md
@@ -22,7 +22,7 @@ The `LineSegment` class represents a line segment in 2D space, which contains th
class LineSegment
```
-## Methods & Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
@@ -33,6 +33,9 @@ class LineSegment
| Method | Description |
| ------ | ----------- |
| [`LineSegment`](#linesegment-1) | The constructor. |
+| [`LineSegment(startPoint,endPoint)`](#linesegmentstartpointendpoint) | Constructs a line segment from the start point and end point. |
+| [`LineSegment(startPoint,endPoint,id)`](#linesegmentstartpointendpointid) | Constructs a line segment from the start point, end point, and ID. |
+| [`transformByMatrix`](#transformbymatrix) | Transforms the coordinates of the line segment by a transformation matrix. |
### startPoint
@@ -65,3 +68,27 @@ The constructor.
```java
LineSegment();
```
+
+### LineSegment(startPoint,endPoint)
+
+Constructs a line segment from the start point and end point.
+
+```java
+LineSegment(Point startPoint,Point endPoint);
+```
+
+### LineSegment(startPoint,endPoint,id)
+
+Constructs a line segment from the start point, end point, and ID.
+
+```java
+LineSegment(Point startPoint,Point endPoint,int id);
+```
+
+### transformByMatrix
+
+Transforms the coordinates of the line segment by a transformation matrix.
+
+```java
+LineSegment transformByMatrix(Matrix matrix);
+```
diff --git a/programming/android/api-reference/core/basic-structures/original-image-result-item.md b/programming/android/api-reference/core/basic-structures/original-image-result-item.md
index 92598bc4..4b15bd23 100644
--- a/programming/android/api-reference/core/basic-structures/original-image-result-item.md
+++ b/programming/android/api-reference/core/basic-structures/original-image-result-item.md
@@ -42,6 +42,7 @@ class OriginalImageResultItem extends CapturedResultItem
Get the image data of the captured original image result item.
```java
+@Nullable
ImageData getImageData();
```
diff --git a/programming/android/api-reference/core/basic-structures/pdf-reading-parameter.md b/programming/android/api-reference/core/basic-structures/pdf-reading-parameter.md
index 47a8f4fa..757a1077 100644
--- a/programming/android/api-reference/core/basic-structures/pdf-reading-parameter.md
+++ b/programming/android/api-reference/core/basic-structures/pdf-reading-parameter.md
@@ -36,6 +36,7 @@ class PDFReadingParameter
Set the processing mode of the PDF file. You can either read the PDF info from vector data or transform the PDF file into an image. The library will transform the PDF file into an image by default.
```java
+@EnumPDFReadingMode
int mode;
```
@@ -52,5 +53,6 @@ int dpi;
Set the raster data source type of the image. The default type is [`RDS_RASTERIZED_PAGES`]({{ site.dcv_android_api }}core/enum/raster-data-source.html).
```java
+@EnumRasterDataSource
int rasterDataSource;
```
diff --git a/programming/android/api-reference/core/basic-structures/quadrilateral.md b/programming/android/api-reference/core/basic-structures/quadrilateral.md
index f6a3644f..1bd0ccd0 100644
--- a/programming/android/api-reference/core/basic-structures/quadrilateral.md
+++ b/programming/android/api-reference/core/basic-structures/quadrilateral.md
@@ -22,7 +22,7 @@ The `Quadrilateral` class represents a quadrilateral shape in 2D space, which co
class Quadrilateral
```
-## Methods & Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
@@ -31,7 +31,12 @@ class Quadrilateral
| Method | Description |
| ------ | ----------- |
-| [`contains`](#contains) | Check whether the input point is contained by the quadrilateral. |
+| [`Quadrilateral`](#quadrilateral-1) | The constructor. |
+| [`Quadrilateral(quad)`](#quadrilateralquad) | Constructs a quadrilateral from another quadrilateral. |
+| [`Quadrilateral(point1,point2,point3,point4)`](#quadrilateralpoint1point2point3point4) | Constructs a quadrilateral from four points. |
+| [`Quadrilateral(point1,point2,point3,point4,id)`](#quadrilateralpoint1point2point3point4id) | Constructs a quadrilateral from four points and an ID. |
+| [`fromJson`](#fromjson) | Constructs a quadrilateral from a JSON string. |
+| [`transformByMatrix`](#transformbymatrix) | Transforms the coordinates of the quadrilateral by a transformation matrix. |
| [`getBoundingRect`](#getboundingrect) | Get the bounding rectangle of the quadrilateral. |
| [`getArea`](#getarea) | Get the area of the quadrilateral. |
@@ -51,6 +56,67 @@ The ID of the quadrilateral.
int id;
```
+### Quadrilateral
+
+The constructor.
+
+```java
+Quadrilateral();
+```
+
+### Quadrilateral(quad)
+
+Constructs a quadrilateral from another quadrilateral.
+
+```java
+Quadrilateral(Quadrilateral quad);
+```
+
+### Quadrilateral(point1,point2,point3,point4)
+
+Constructs a quadrilateral from four points.
+
+```java
+Quadrilateral(Point point1,Point point2,Point point3,Point point4);
+```
+
+### Quadrilateral(point1,point2,point3,point4,id)
+
+Constructs a quadrilateral from four points and an ID.
+
+```java
+Quadrilateral(Point point1,Point point2,Point point3,Point point4,int id);
+```
+
+### fromJson
+
+Constructs a quadrilateral from a JSON string.
+
+```java
+
+Quadrilateral fromJson(String jsonString);
+```
+
+**Return Value**
+
+The constructed quadrilateral.
+
+### transformByMatrix
+
+Transforms the coordinates of the quadrilateral by a transformation matrix.
+
+```java
+Quadrilateral transformByMatrix(Matrix matrix);
+```
+
+**Parameters**
+
+`matrix`: The transformation matrix.
+
+**Return Value**
+
+The transformed quadrilateral.
+
### contains
Check whether the input point is contained by the quadrilateral.
diff --git a/programming/android/api-reference/core/basic-structures/rect.md b/programming/android/api-reference/core/basic-structures/rect.md
index 03664bb9..3e7254fb 100644
--- a/programming/android/api-reference/core/basic-structures/rect.md
+++ b/programming/android/api-reference/core/basic-structures/rect.md
@@ -22,7 +22,7 @@ The `DSRect` class represents a rectangle in 2D space, which contains four integ
class DSRect
```
-## Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
@@ -32,6 +32,12 @@ class DSRect
| [`bottom`](#bottom) | *float* | The distance between the bottom of the rect and the x-axis. If measuredInPercentage = 1, the value specifies the percentage comparing with the height of the parent. If measuredInPercentage = 0, the value specifies a pixel length. |
| [`measuredInPercentage`](#measuredinpercentage) | *boolean* | Indicates if the rectangle's measurements are in percentages. |
+| Method | Description |
+| ------ | ----------- |
+| [`DSRect`](#dsrect-1) | The constructor. |
+| [`DSRect(left,top,right,bottom,measuredInPercentage)`](#dsrectlefttoprightbottommeasuredinpercentage) | Constructs a DSRect from the specified parameters. |
+| [`fromJson`](#fromjson) | Constructs a DSRect from a JSON string. |
+
### top
The distance between the top of the rect and the x-axis. If measuredInPercentage = 1, the value specifies the percentage comparing with the height of the parent. If measuredInPercentage = 0, the value specifies a pixel length.
@@ -71,3 +77,27 @@ Sets whether to use percentages to measure the region size.
```java
boolean isMeasuredInPercentage;
```
+
+### DSRect
+
+The constructor.
+
+```java
+DSRect();
+```
+
+### DSRect(left,top,right,bottom,measuredInPercentage)
+
+Constructs a DSRect from the specified parameters.
+
+```java
+DSRect(float left, float top, float right, float bottom, boolean measuredInPercentage);
+```
+
+### fromJson
+
+Constructs a DSRect from a JSON string.
+
+```java
+DSRect fromJson(String jsonString);
+```
diff --git a/programming/android/api-reference/core/basic-structures/vector4.md b/programming/android/api-reference/core/basic-structures/vector4.md
index 501a64ac..d6929b81 100644
--- a/programming/android/api-reference/core/basic-structures/vector4.md
+++ b/programming/android/api-reference/core/basic-structures/vector4.md
@@ -22,12 +22,18 @@ The `Vector4` class represents a four-dimensional vector.
class Vector4
```
-## Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
| [`value`](#value) | *int[4]* | The components value of a four-dimensional vector. |
+| Methods | Description |
+| ------- | ----------- |
+| [`Vector4`](#vector4-1) | The constructor. |
+| [`Vector4(v1,v2,v3,v4)`](#vector4v1v2v3v4) | Constructs a Vector4 from 4 integer values. |
+
+
### value
The components value of a four-dimensional vector.
@@ -35,3 +41,19 @@ The components value of a four-dimensional vector.
```java
public int[] value = new int[4];
```
+
+### Vector4
+
+The constructor.
+
+```java
+Vector4();
+```
+
+### Vector4(v1,v2,v3,v4)
+
+Constructs a Vector4 from 4 integer values.
+
+```java
+Vector4(int v1, int v2, int v3, int v4)
+```
\ No newline at end of file
diff --git a/programming/android/api-reference/core/basic-structures/video-frame-tag.md b/programming/android/api-reference/core/basic-structures/video-frame-tag.md
index 9f39ee64..b3698686 100644
--- a/programming/android/api-reference/core/basic-structures/video-frame-tag.md
+++ b/programming/android/api-reference/core/basic-structures/video-frame-tag.md
@@ -26,17 +26,20 @@ class VideoFrameTag extends ImageTag
| Methods | Description |
| ---------- | ----------- |
-| [`getClarity`](#getquality) | Get the clarity of the video frame. |
-| [`getQuality`](#getquality) | Get the quality of the video frame. |
-| [`isCropped`](#iscropped) | Check whether the video frame is cropped. |
-| [`getCropRegion`](#getcropregion) | Get the crop region of the video frame. |
-| [`getOriginalWidth`](#getoriginalwidth) | Get the original width of the video frame. |
-| [`getOriginalHeight`](#getoriginalheight) | Get the original height of the video frame. |
-| [`VideoFrameTag(frameID,quality,isCropped,cropRegion,originalWidth,originalHeight)`](#videoframetagframeidqualityiscroppedcropregionoriginalwidthoriginalheight) | The constructor. |
+| [`getClarity`](#getquality) | Gets the clarity of the video frame. |
+| [`getQuality`](#getquality) | Gets the quality of the video frame. |
+| [`isCropped`](#iscropped) | Checks whether the video frame is cropped. |
+| [`getCropRegion`](#getcropregion) | Gets the crop region of the video frame. |
+| [`getOriginalWidth`](#getoriginalwidth) | Gets the original width of the video frame. |
+| [`setOriginalWidth`](#setoriginalwidth) | Sets the original width of the video frame. |
+| [`getOriginalHeight`](#getoriginalheight) | Gets the original height of the video frame. |
+| [`setOriginalHeight`](#setoriginalheight) | Sets the original height of the video frame. |
+| [`VideoFrameTag`](#videoframetag) | The constructor. |
+| [`VideoFrameTag(imageID,distanceMode,quality,isCropped,cropRegion,originalWidth,originalHeight)`](#videoframetagframeidqualityiscroppedcropregionoriginalwidthoriginalheight) | Constructs a VideoFrameTag from the specified parameters. |
### getClarity
-The clarity of the video frame.
+Gets the clarity of the video frame.
```java
int getClarity();
@@ -44,10 +47,11 @@ int getClarity();
### getQuality
-The quality of the video frame.
+Gets the quality of the video frame.
```java
-EnumFrameQuality getQuality();
+@EnumVideoFrameQuality
+int getQuality();
```
### isCropped
@@ -60,7 +64,7 @@ boolean isCropped();
### getCropRegion
-The crop region of the video frame.
+Gets the crop region of the video frame.
```java
Rect getCropRegion();
@@ -68,26 +72,42 @@ Rect getCropRegion();
### getOriginalWidth
-The original width of the video frame.
+Gets the original width of the video frame.
```java
int getOriginalWidth();
```
+### setOriginalWidth
+
+Sets the original width of the video frame.
+
+```java
+void setOriginalWidth(int originalWidth);
+```
+
### getOriginalHeight
-The original height of the video frame.
+Gets the original height of the video frame.
```java
int getOriginalHeight();
```
-### VideoFrameTag(frameID,quality,isCropped,cropRegion,originalWidth,originalHeight)
+### setOriginalHeight
+
+Sets the original height of the video frame.
+
+```java
+void setOriginalHeight(int originalHeight);
+```
+
+### VideoFrameTag(imageID,distanceMode,quality,isCropped,cropRegion,originalWidth,originalHeight)
The constructor.
```java
-VideoFrameTag(int frameID, EnumFrameQuality quality, boolean isCropped, Rect cropRegion, int originalWidth, int originalHeight);
+VideoFrameTag(int imageId, @EnumImageCaptureDistanceMode int distanceMode, @EnumVideoFrameQuality int quality, boolean isCropped, Rect cropRegion, int originalWidth, int originalHeight);
```
**Parameters**
diff --git a/programming/android/api-reference/core/enum/binarization-mode.md b/programming/android/api-reference/core/enum/binarization-mode.md
new file mode 100644
index 00000000..2dafebff
--- /dev/null
+++ b/programming/android/api-reference/core/enum/binarization-mode.md
@@ -0,0 +1,33 @@
+---
+layout: default-layout
+title: BinarizationMode - Dynamsoft Core Enumerations
+description: The enumeration BinarizationMode of Dynamsoft Core describes how the corner is formed by its sides.
+keywords: Corner type
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+breadcrumbText: BinarizationMode
+codeAutoHeight: true
+---
+
+# Enumeration BinarizationMode
+
+`BinarizationMode` categorizes the nature of a corner based on the intersection of its adjoining sides.
+
+```java
+@Retention(RetentionPolicy.CLASS)
+public @interface EnumBinarizationMode
+{
+ /** Binarizes the image based on the local block. Check @ref BM for available argument settings.*/
+ int BM_LOCAL_BLOCK = 0x02;
+
+ /** Performs image binarization based on the given threshold. Check @ref BM for available argument settings.*/
+ int BM_THRESHOLD = 0x04;
+
+ /** Skips the binarization.*/
+ int BM_SKIP = 0x00;
+
+ /** Reserved settings for the binarization mode.*/
+ int BM_REV = -2147483648;
+}
+```
diff --git a/programming/android/api-reference/core/enum/buffer-overflow-protection-mode.md b/programming/android/api-reference/core/enum/buffer-overflow-protection-mode.md
index 01be36a8..c0344516 100644
--- a/programming/android/api-reference/core/enum/buffer-overflow-protection-mode.md
+++ b/programming/android/api-reference/core/enum/buffer-overflow-protection-mode.md
@@ -19,8 +19,8 @@ codeAutoHeight: true
public @interface EnumBufferOverflowProtectionMode
{
/** New images are blocked when the buffer is full.*/
- public static final int BOPM_BLOCK = 0;
+ int BOPM_BLOCK = 0;
/** New images are appended at the end, and oldest images are pushed out from the beginning if thebuffer is full.*/
- public static final int BOPM_UPDATE = 1;
+ int BOPM_UPDATE = 1;
}
```
diff --git a/programming/android/api-reference/core/enum/captured-result-item-type.md b/programming/android/api-reference/core/enum/captured-result-item-type.md
index 8ae7d74d..37cf1de8 100644
--- a/programming/android/api-reference/core/enum/captured-result-item-type.md
+++ b/programming/android/api-reference/core/enum/captured-result-item-type.md
@@ -19,18 +19,18 @@ codeAutoHeight: true
public @interface EnumCapturedResultItemType
{
/** The type of the CapturedResultItem is "original image". */
- public static final int CRIT_ORIGINAL_IMAGE = 1;
+ int CRIT_ORIGINAL_IMAGE = 1;
/** The type of the CapturedResultItem is "barcode". */
- public static final int CRIT_BARCODE = 2;
+ int CRIT_BARCODE = 2;
/** The type of the CapturedResultItem is "text line". */
- public static final int CRIT_TEXT_LINE = 4;
+ int CRIT_TEXT_LINE = 4;
/** The type of the CapturedResultItem is "detected quad". */
- public static final int CRIT_DETECTED_QUAD = 8;
+ int CRIT_DETECTED_QUAD = 8;
/** The type of the CapturedResultItem is "deskewed image". */
- public static final int CRIT_DESKEWED_IMAGE = 16;
+ int CRIT_DESKEWED_IMAGE = 16;
/** The type of the CapturedResultItem is "parsed result". */
- public static final int CRIT_PARSED_RESULT = 32;
+ int CRIT_PARSED_RESULT = 32;
/** The type of the CapturedResultItem is "enhanced image". */
- public static final int CRIT_ENHANCED_IMAGE = 16;
+ int CRIT_ENHANCED_IMAGE = 64;
}
```
diff --git a/programming/android/api-reference/core/enum/colour-channel-usage-type.md b/programming/android/api-reference/core/enum/colour-channel-usage-type.md
index a01cd259..40d644e5 100644
--- a/programming/android/api-reference/core/enum/colour-channel-usage-type.md
+++ b/programming/android/api-reference/core/enum/colour-channel-usage-type.md
@@ -19,16 +19,16 @@ codeAutoHeight: true
public @interface EnumColourChannelUsageType
{
/** Automatic color channel usage determination based on image pixel format and scene. */
- public static final int CCUT_AUTO = 0;
+ int CCUT_AUTO = 0;
/** Use all available color channels for processing. */
- public static final int CCUT_FULL_CHANNEL = 1;
+ int CCUT_FULL_CHANNEL = 1;
/** Use only the Y (luminance) channel for processing in images represented in the NV21 format. */
- public static final int CCUT_NV21_Y_CHANNEL_ONLY = 2;
+ int CCUT_Y_CHANNEL_ONLY = 2;
/** Use only the red channel for processing in RGB images.*/
- public static final int CCUT_RGB_R_CHANNEL_ONLY = 3;
+ int CCUT_RGB_R_CHANNEL_ONLY = 3;
/** Use only the green channel for processing in RGB images.*/
- public static final int CCUT_RGB_G_CHANNEL_ONLY = 4;
+ int CCUT_RGB_G_CHANNEL_ONLY = 4;
/** Use only the blue channel for processing in RGB images.*/
- public static final int CCUT_RGB_B_CHANNEL_ONLY = 5;
+ int CCUT_RGB_B_CHANNEL_ONLY = 5;
}
```
diff --git a/programming/android/api-reference/core/enum/corner-type.md b/programming/android/api-reference/core/enum/corner-type.md
index e1872c24..26cfddbc 100644
--- a/programming/android/api-reference/core/enum/corner-type.md
+++ b/programming/android/api-reference/core/enum/corner-type.md
@@ -19,12 +19,12 @@ codeAutoHeight: true
public @interface EnumCornerType
{
/** The corner is formed by two intersecting line segments. */
- public static final int CT_NORMAL_INTERSECTED = 0;
+ int CT_NORMAL_INTERSECTED = 0;
/** The corner is formed by two T intersecting line segments. */
- public static final int CT_T_INTERSECTED = 1;
+ int CT_T_INTERSECTED = 1;
/** The corner is formed by two cross intersecting line segments. */
- public static final int CT_CROSS_INTERSECTED = 2;
+ int CT_CROSS_INTERSECTED = 2;
/** The two line segments are not intersected but they definitely consist a corner. */
- public static final int CT_NOT_INTERSECTED = 3;
+ int CT_NOT_INTERSECTED = 3;
}
```
diff --git a/programming/android/api-reference/core/enum/cross-verification-status.md b/programming/android/api-reference/core/enum/cross-verification-status.md
index 6982dbe1..221dfa99 100644
--- a/programming/android/api-reference/core/enum/cross-verification-status.md
+++ b/programming/android/api-reference/core/enum/cross-verification-status.md
@@ -19,10 +19,10 @@ codeAutoHeight: true
public @interface EnumCrossVerificationStatus
{
/** The cross verification has not been performed yet. */
- public static final int CVS_NOT_VERIFIED;
+ int CVS_NOT_VERIFIED;
/** The cross verification has been passed successfully. */
- public static final int CVS_PASSED;
+ int CVS_PASSED;
/** The cross verification has failed. */
- public static final int CVS_FAILED;
+ int CVS_FAILED;
}
```
diff --git a/programming/android/api-reference/core/enum/error-code.md b/programming/android/api-reference/core/enum/error-code.md
index 4a44dd11..ed2221bb 100644
--- a/programming/android/api-reference/core/enum/error-code.md
+++ b/programming/android/api-reference/core/enum/error-code.md
@@ -19,238 +19,238 @@ codeAutoHeight: true
public @interface EnumErrorCode
{
/** Successful. */
- public static final int EC_OK = 0;
+ int EC_OK = 0;
/** -10000~-19999: Common error code. */
/** Unknown error. */
- public static final int EC_UNKNOWN = -10000,
+ int EC_UNKNOWN = -10000,
/**Not enough memory to perform the operation. */
- public static final int EC_NO_MEMORY = -10001,
+ int EC_NO_MEMORY = -10001,
/** Null pointer */
- public static final int EC_NULL_POINTER = -10002,
+ int EC_NULL_POINTER = -10002,
/** License invalid. */
- public static final int EC_LICENSE_INVALID = -10003,
+ int EC_LICENSE_INVALID = -10003,
/** License expired. */
- public static final int EC_LICENSE_EXPIRED = -10004,
+ int EC_LICENSE_EXPIRED = -10004,
/** File not found. */
- public static final int EC_FILE_NOT_FOUND = -10005,
+ int EC_FILE_NOT_FOUND = -10005,
/** The file type is not supported. */
- public static final int EC_FILE_TYPE_NOT_SUPPORTED = -10006,
+ int EC_FILE_TYPE_NOT_SUPPORTED = -10006,
/** The BPP (Bits Per Pixel) is not supported. */
- public static final int EC_BPP_NOT_SUPPORTED = -10007,
+ int EC_BPP_NOT_SUPPORTED = -10007,
/** The index is invalid. */
- public static final int EC_INDEX_INVALID = -10008,
+ int EC_INDEX_INVALID = -10008,
/** The input region value parameter is invalid. */
- public static final int EC_CUSTOM_REGION_INVALID = -10010,
+ int EC_CUSTOM_REGION_INVALID = -10010,
/** Failed to read the image. */
- public static final int EC_IMAGE_READ_FAILED = -10012,
+ int EC_IMAGE_READ_FAILED = -10012,
/** Failed to read the TIFF image. */
- public static final int EC_TIFF_READ_FAILED = -10013,
+ int EC_TIFF_READ_FAILED = -10013,
/** The DIB (Device-Independent Bitmaps) buffer is invalid. */
- public static final int EC_DIB_BUFFER_INVALID = -10018,
+ int EC_DIB_BUFFER_INVALID = -10018,
/** Failed to read the PDF image. */
- public static final int EC_PDF_READ_FAILED = -10021,
+ int EC_PDF_READ_FAILED = -10021,
/** The PDF DLL is missing. */
- public static final int EC_PDF_DLL_MISSING = -10022,
+ int EC_PDF_DLL_MISSING = -10022,
/** The page number is invalid. */
- public static final int EC_PAGE_NUMBER_INVALID = -10023,
+ int EC_PAGE_NUMBER_INVALID = -10023,
/** The custom size is invalid. */
- public static final int EC_CUSTOM_SIZE_INVALID = -10024,
+ int EC_CUSTOM_SIZE_INVALID = -10024,
/** timeout. */
- public static final int EC_TIMEOUT = -10026,
+ int EC_TIMEOUT = -10026,
/** Json parse failed. */
- public static final int EC_JSON_PARSE_FAILED = -10030,
+ int EC_JSON_PARSE_FAILED = -10030,
/** Json type invalid. */
- public static final int EC_JSON_TYPE_INVALID = -10031,
+ int EC_JSON_TYPE_INVALID = -10031,
/** Json key invalid. */
- public static final int EC_JSON_KEY_INVALID = -10032,
+ int EC_JSON_KEY_INVALID = -10032,
/** Json value invalid. */
- public static final int EC_JSON_VALUE_INVALID = -10033,
+ int EC_JSON_VALUE_INVALID = -10033,
/** Json name key missing. */
- public static final int EC_JSON_NAME_KEY_MISSING = -10034,
+ int EC_JSON_NAME_KEY_MISSING = -10034,
/** The value of the key "Name" is duplicated. */
- public static final int EC_JSON_NAME_VALUE_DUPLICATED = -10035,
+ int EC_JSON_NAME_VALUE_DUPLICATED = -10035,
/** Template name invalid. */
- public static final int EC_TEMPLATE_NAME_INVALID = -10036,
+ int EC_TEMPLATE_NAME_INVALID = -10036,
/** The name reference is invalid. */
- public static final int EC_JSON_NAME_REFERENCE_INVALID = -10037,
+ int EC_JSON_NAME_REFERENCE_INVALID = -10037,
/** Parameter value invalid. */
- public static final int EC_PARAMETER_VALUE_INVALID = -10038,
+ int EC_PARAMETER_VALUE_INVALID = -10038,
/** The domain of your current site does not match the domain bound in the current product key. */
- public static final int EC_DOMAIN_NOT_MATCH = -10039,
+ int EC_DOMAIN_NOT_MATCH = -10039,
/** The reserved info does not match the reserved info bound in the current product key. */
- public static final int EC_RESERVED_INFO_NOT_MATCH = -10040,
+ int EC_RESERVED_INFO_NOT_MATCH = -10040,
/** The license key does not match the license content. */
- public static final int EC_LICENSE_KEY_NOT_MATCH = -10043,
+ int EC_LICENSE_KEY_NOT_MATCH = -10043,
/** Failed to request the license content. */
- public static final int EC_REQUEST_FAILED = -10044,
+ int EC_REQUEST_FAILED = -10044,
/** Failed to init the license. */
- public static final int EC_LICENSE_INIT_FAILED = -10045,
+ int EC_LICENSE_INIT_FAILED = -10045,
/** Failed to set mode's argument. */
- public static final int EC_SET_MODE_ARGUMENT_ERROR = -10051,
+ int EC_SET_MODE_ARGUMENT_ERROR = -10051,
/** The license content is invalid. */
- public static final int EC_LICENSE_CONTENT_INVALID = -10052,
+ int EC_LICENSE_CONTENT_INVALID = -10052,
/** The license key is invalid. */
- public static final int EC_LICENSE_KEY_INVALID = -10053,
+ int EC_LICENSE_KEY_INVALID = -10053,
/** The license key has no remaining quota. */
- public static final int EC_LICENSE_DEVICE_RUNS_OUT = -10054,
+ int EC_LICENSE_DEVICE_RUNS_OUT = -10054,
/** Failed to get mode's argument. */
- public static final int EC_GET_MODE_ARGUMENT_ERROR = -10055,
+ int EC_GET_MODE_ARGUMENT_ERROR = -10055,
/** The Intermediate Result Types license is invalid. */
- public static final int EC_IRT_LICENSE_INVALID = -10056,
+ int EC_IRT_LICENSE_INVALID = -10056,
/** Failed to save file. */
- public static final int EC_FILE_SAVE_FAILED = -10058,
+ int EC_FILE_SAVE_FAILED = -10058,
/** The stage type is invalid. */
- public static final int EC_STAGE_TYPE_INVALID = -10059,
+ int EC_STAGE_TYPE_INVALID = -10059,
/** The image orientation is invalid. */
- public static final int EC_IMAGE_ORIENTATION_INVALID = -10060,
+ int EC_IMAGE_ORIENTATION_INVALID = -10060,
/** Complex tempalte can't be converted to simplified settings. */
- public static final int EC_CONVERT_COMPLEX_TEMPLATE_ERROR = -10061,
+ int EC_CONVERT_COMPLEX_TEMPLATE_ERROR = -10061,
/** Reject function call while capturing in progress.*/
- public static final int EC_CALL_REJECTED_WHEN_CAPTURING = -10062,
+ int EC_CALL_REJECTED_WHEN_CAPTURING = -10062,
/**The input image source was not found.*/
- public static final int EC_NO_IMAGE_SOURCE = -10063,
+ int EC_NO_IMAGE_SOURCE = -10063,
/**Failed to read directory.*/
- public static final int EC_READ_DIRECTORY_FAILED = -10064,
+ int EC_READ_DIRECTORY_FAILED = -10064,
/**[Name] Module not found.*/
/**Name : */
/**DynamsoftBarcodeReader*/
/**DynamsoftLabelRecognizer*/
/**DynamsoftDocumentNormalizer*/
- public static final int EC_MODULE_NOT_FOUND = -10065,
+ int EC_MODULE_NOT_FOUND = -10065,
/**The file already exists but overwriting is disabled.*/
- public static final int EC_FILE_ALREADY_EXISTS = -10067,
+ int EC_FILE_ALREADY_EXISTS = -10067,
/**The file path does not exist but cannot be created, or cannot be created for any other reason.*/
- public static final int EC_CREATE_FILE_FAILED = -10068,
+ int EC_CREATE_FILE_FAILED = -10068,
/**The input ImageData object contains invalid parameter(s).*/
- public static final int EC_IMGAE_DATA_INVALID = -10069,
+ int EC_IMGAE_DATA_INVALID = -10069,
/**The size of the input image do not meet the requirements.*/
- public static final int EC_IMAGE_SIZE_NOT_MATCH = -10070,
+ int EC_IMAGE_SIZE_NOT_MATCH = -10070,
/**The pixel format of the input image do not meet the requirements.*/
- public static final int EC_IMAGE_PIXEL_FORMAT_NOT_MATCH = -10071,
+ int EC_IMAGE_PIXEL_FORMAT_NOT_MATCH = -10071,
/**The section level result is irreplaceable.*/
- public static final int EC_SECTION_LEVEL_RESULT_IRREPLACEABLE = -10072,
+ int EC_SECTION_LEVEL_RESULT_IRREPLACEABLE = -10072,
/**The axis definition is incorrect.*/
- public static final int EC_AXIS_DEFINITION_INCORRECT = -10073,
+ int EC_AXIS_DEFINITION_INCORRECT = -10073,
/**The result is not replaceable due to type mismatch*/
- public static final int EC_RESULT_TYPE_MISMATCH_IRREPLACEABLE = -10074,
+ int EC_RESULT_TYPE_MISMATCH_IRREPLACEABLE = -10074,
/**Failed to load the PDF library.*/
- public static final int EC_PDF_LIBRARY_LOAD_FAILED = -10075,
+ int EC_PDF_LIBRARY_LOAD_FAILED = -10075,
/*The license is initialized successfully but detected invalid content in your key.*/
- public static final int EC_LICENSE_WARNING = -10076,
+ int EC_LICENSE_WARNING = -10076,
/*The template version is incompatible. Please use a compatible template.*/
- public static final int EC_TEMPLATE_VERSION_INCOMPATIBLE = -10081
+ int EC_TEMPLATE_VERSION_INCOMPATIBLE = -10081
/** -20000~-29999: DLS license error code. */
/** No license. */
- public static final int EC_NO_LICENSE = -20000,
+ int EC_NO_LICENSE = -20000,
/** The Handshake Code is invalid. */
- public static final int EC_HANDSHAKE_CODE_INVALID = -20001,
+ int EC_HANDSHAKE_CODE_INVALID = -20001,
/** Failed to read or write license buffer. */
- public static final int EC_LICENSE_BUFFER_FAILED = -20002,
+ int EC_LICENSE_BUFFER_FAILED = -20002,
/** Failed to synchronize license info with license server. */
- public static final int EC_LICENSE_SYNC_FAILED = -20003,
+ int EC_LICENSE_SYNC_FAILED = -20003,
/** Device dose not match with buffer. */
- public static final int EC_DEVICE_NOT_MATCH = -20004,
+ int EC_DEVICE_NOT_MATCH = -20004,
/** Failed to bind device. */
- public static final int EC_BIND_DEVICE_FAILED = -20005,
+ int EC_BIND_DEVICE_FAILED = -20005,
/** Instance count is over limit. */
- public static final int EC_INSTANCE_COUNT_OVER_LIMIT = -20008,
+ int EC_INSTANCE_COUNT_OVER_LIMIT = -20008,
/** Trial License */
- public static final int EC_TRIAL_LICENSE = -20010,
+ int EC_TRIAL_LICENSE = -20010,
/*License authentication failed: quota exceeded.*/
- public static final int EC_LICENSE_AUTH_QUOTA_EXCEEDED = -20013,
+ int EC_LICENSE_AUTH_QUOTA_EXCEEDED = -20013,
/**License restriction: the number of results has exceeded the allowed limit.*/
- public static final int EC_LICENSE_RESULTS_LIMIT_EXCEEDED = -20014,
+ int EC_LICENSE_RESULTS_LIMIT_EXCEEDED = -20014,
/** Failed to reach License Server. */
- public static final int EC_FAILED_TO_REACH_DLS = -20200,
+ int EC_FAILED_TO_REACH_DLS = -20200,
/** -30000~-39999: DBR error code. */
/** The barcode format is invalid. */
- public static final int EC_BARCODE_FORMAT_INVALID = -30009,
+ int EC_BARCODE_FORMAT_INVALID = -30009,
/** The QR Code license is invalid. */
- public static final int EC_QR_LICENSE_INVALID = -30016,
+ int EC_QR_LICENSE_INVALID = -30016,
/** The 1D Barcode license is invalid. */
- public static final int EC_1D_LICENSE_INVALID = -30017,
+ int EC_1D_LICENSE_INVALID = -30017,
/** The PDF417 license is invalid. */
- public static final int EC_PDF417_LICENSE_INVALID = -30019,
+ int EC_PDF417_LICENSE_INVALID = -30019,
/** The DATAMATRIX license is invalid. */
- public static final int EC_DATAMATRIX_LICENSE_INVALID = -30020,
+ int EC_DATAMATRIX_LICENSE_INVALID = -30020,
/** The custom module size is invalid. */
- public static final int EC_CUSTOM_MODULESIZE_INVALID = -30025,
+ int EC_CUSTOM_MODULESIZE_INVALID = -30025,
/** The AZTEC license is invalid. */
- public static final int EC_AZTEC_LICENSE_INVALID = -30041,
+ int EC_AZTEC_LICENSE_INVALID = -30041,
/** The Patchcode license is invalid. */
- public static final int EC_PATCHCODE_LICENSE_INVALID = -30046,
+ int EC_PATCHCODE_LICENSE_INVALID = -30046,
/** The Postal code license is invalid. */
- public static final int EC_POSTALCODE_LICENSE_INVALID = -30047,
+ int EC_POSTALCODE_LICENSE_INVALID = -30047,
/** The DPM license is invalid. */
- public static final int EC_DPM_LICENSE_INVALID = -30048,
+ int EC_DPM_LICENSE_INVALID = -30048,
/** The frame decoding thread already exists. */
- public static final int EC_FRAME_DECODING_THREAD_EXISTS = -30049,
+ int EC_FRAME_DECODING_THREAD_EXISTS = -30049,
/** Failed to stop the frame decoding thread. */
- public static final int EC_STOP_DECODING_THREAD_FAILED = -30050,
+ int EC_STOP_DECODING_THREAD_FAILED = -30050,
/** The Maxicode license is invalid. */
- public static final int EC_MAXICODE_LICENSE_INVALID = -30057,
+ int EC_MAXICODE_LICENSE_INVALID = -30057,
/** The GS1 Databar license is invalid. */
- public static final int EC_GS1_DATABAR_LICENSE_INVALID = -30058,
+ int EC_GS1_DATABAR_LICENSE_INVALID = -30058,
/** The GS1 Composite code license is invalid. */
- public static final int EC_GS1_COMPOSITE_LICENSE_INVALID = -30059,
+ int EC_GS1_COMPOSITE_LICENSE_INVALID = -30059,
/** The DotCode license is invalid. */
- public static final int EC_DOTCODE_LICENSE_INVALID = -30061,
+ int EC_DOTCODE_LICENSE_INVALID = -30061,
/** The Pharmacode license is invalid. */
- public static final int EC_PHARMACODE_LICENSE_INVALID = -30062,
+ int EC_PHARMACODE_LICENSE_INVALID = -30062,
/*[Barcode Reader] No license found.*/
- public static final int EC_DBR_LICENSE_NOT_FOUND = -30063,
+ int EC_DBR_LICENSE_NOT_FOUND = -30063,
/** -40000~-49999: DLR error code */
/** Character Model file is not found. */
- public static final int EC_CHARACTER_MODEL_FILE_NOT_FOUND = -40100,
+ int EC_CHARACTER_MODEL_FILE_NOT_FOUND = -40100,
/**There is a conflict in the layout of TextLineGroup. */
- public static final int EC_TEXT_LINE_GROUP_LAYOUT_CONFLICT = -40101,
+ int EC_TEXT_LINE_GROUP_LAYOUT_CONFLICT = -40101,
/**There is a conflict in the regex of TextLineGroup. */
- public static final int EC_TEXT_LINE_GROUP_REGEX_CONFLICT = -40102,
+ int EC_TEXT_LINE_GROUP_REGEX_CONFLICT = -40102,
/*[Label Recognizer] No license found.*/
- public static final int EC_DLR_LICENSE_NOT_FOUND = -40103,
+ int EC_DLR_LICENSE_NOT_FOUND = -40103,
/** -50000~-59999: DDN error code. */
/**No content has been detected. */
- public static final int EC_CONTENT_NOT_FOUND = -50056,
+ int EC_CONTENT_NOT_FOUND = -50056,
/*The quardrilateral is invalid. */
- public static final int EC_QUADRILATERAL_INVALID = -50057,
+ int EC_QUADRILATERAL_INVALID = -50057,
/*[Document Normalizer] No license found.*/
- public static final int EC_DDN_LICENSE_NOT_FOUND = -50058,
+ int EC_DDN_LICENSE_NOT_FOUND = -50058,
/** -60000~-69999: DCE error code. */
/**-60000~-69999: DCE error code*/
/** The camera module is not exist. */
- public static final int EC_CAMERA_MODULE_NOT_EXIST = -60003;
+ int EC_CAMERA_MODULE_NOT_EXIST = -60003;
/** The camera id does not exist. */
- public static final int EC_CAMERA_ID_NOT_EXIST = -60006;
+ int EC_CAMERA_ID_NOT_EXIST = -60006;
/** The sensor does not exist. */
- public static final int EC_NO_SENSOR = -60045;
+ int EC_NO_SENSOR = -60045;
/**-70000~-79999: Panorama error code. */
/**The panorama license is invalid. */
- public static final int EC_PANORAMA_LICENSE_INVALID = -70060,
+ int EC_PANORAMA_LICENSE_INVALID = -70060,
/** -80000~-89999: Reserved error code. */
/**-90000~-99999: DCP error code. */
/** The resource path is not exist. */
- public static final int EC_RESOURCE_PATH_NOT_EXIST = -90001,
+ int EC_RESOURCE_PATH_NOT_EXIST = -90001,
/** Failed to load resource. */
- public static final int EC_RESOURCE_LOAD_FAILED = -90002,
+ int EC_RESOURCE_LOAD_FAILED = -90002,
/** The code specification is not found. */
- public static final int EC_CODE_SPECIFICATION_NOT_FOUND = -90003,
+ int EC_CODE_SPECIFICATION_NOT_FOUND = -90003,
/** The full code string is empty. */
- public static final int EC_FULL_CODE_EMPTY = -90004,
+ int EC_FULL_CODE_EMPTY = -90004,
/** Failed to preprocess the full code string */
- public static final int EC_FULL_CODE_PREPROCESS_FAILED = -90005,
+ int EC_FULL_CODE_PREPROCESS_FAILED = -90005,
/** The license for parsing South Africa Driver License is invalid. */
- public static final int EC_ZA_DL_LICENSE_INVALID = -90006,
+ int EC_ZA_DL_LICENSE_INVALID = -90006,
/** The license for parsing North America DL/ID is invalid. */
- public static final int EC_AAMVA_DL_ID_LICENSE_INVALID = -90007,
+ int EC_AAMVA_DL_ID_LICENSE_INVALID = -90007,
/** The license for parsing Aadhaar is invalid. */
- public static final int EC_AADHAAR_LICENSE_INVALID = -90008,
+ int EC_AADHAAR_LICENSE_INVALID = -90008,
/** The license for parsing Machine Readable Travel Documents is invalid. */
- public static final int EC_MRTD_LICENSE_INVALID = -90009,
+ int EC_MRTD_LICENSE_INVALID = -90009,
/** The license for parsing Vehicle Identification Number is invalid. */
- public static final int EC_VIN_LICENSE_INVALID = -90010,
+ int EC_VIN_LICENSE_INVALID = -90010,
/** The license for parsing customized code type is invalid. */
- public static final int EC_CUSTOMIZED_CODE_TYPE_LICENSE_INVALID = -90011,
+ int EC_CUSTOMIZED_CODE_TYPE_LICENSE_INVALID = -90011,
/*[Code Parser] No license found.*/
- public static final int EC_DCP_LICENSE_NOT_FOUND = -90012
+ int EC_DCP_LICENSE_NOT_FOUND = -90012
} ErrorCode;
```
diff --git a/programming/android/api-reference/core/enum/grayscale-enhancement-mode.md b/programming/android/api-reference/core/enum/grayscale-enhancement-mode.md
index b6f4ed32..aff60a93 100644
--- a/programming/android/api-reference/core/enum/grayscale-enhancement-mode.md
+++ b/programming/android/api-reference/core/enum/grayscale-enhancement-mode.md
@@ -17,20 +17,20 @@ codeAutoHeight: true
```java
@Retention(RetentionPolicy.CLASS)public @interface EnumGrayscaleEnhancementMode {
/**Not supported yet. */
- public static final int GEM_AUTO = 1;
+ int GEM_AUTO = 1;
/**Takes the unpreprocessed image for following operations.*/
- public static final int GEM_GENERAL = 2;
+ int GEM_GENERAL = 2;
/**Preprocesses the image using the gray equalization algorithm. Check @ref IPM for available argument settings.*/
- public static final int GEM_GRAY_EQUALIZE = 4;
+ int GEM_GRAY_EQUALIZE = 4;
/**Preprocesses the image using the gray smoothing algorithm. Check @ref IPM for available argument settings.*/
- public static final int GEM_GRAY_SMOOTH = 8;
+ int GEM_GRAY_SMOOTH = 8;
/**Preprocesses the image using the sharpening and smoothing algorithm. Check @ref IPM for available argument settings.*/
- public static final int GEM_SHARPEN_SMOOTH = 16;
+ int GEM_SHARPEN_SMOOTH = 16;
/**Reserved setting for image preprocessing mode.*/
- public static final int GEM_REV = -2147483648;
+ int GEM_REV = -2147483648;
/**Skips image preprocessing. */
- public static final int GEM_SKIP = 0;
+ int GEM_SKIP = 0;
/**Placeholder value with no functional meaning. */
- public static final int GEM_END = 0xFFFFFFFF;
+ int GEM_END = 0xFFFFFFFF;
}
```
diff --git a/programming/android/api-reference/core/enum/grayscale-transformation-mode.md b/programming/android/api-reference/core/enum/grayscale-transformation-mode.md
index dba50233..64f6af91 100644
--- a/programming/android/api-reference/core/enum/grayscale-transformation-mode.md
+++ b/programming/android/api-reference/core/enum/grayscale-transformation-mode.md
@@ -19,16 +19,16 @@ codeAutoHeight: true
public @interface EnumGrayscaleTransformationMode
{
/** Transforms to the inverted grayscale for further reference. This value is recommended for light on dark images. */
- public static final int GTM_INVERTED = 1;
+ int GTM_INVERTED = 1;
/** Keeps the original grayscale for further reference. This value is recommended for dark on light images. */
- public static final int GTM_ORIGINAL = 2;
+ int GTM_ORIGINAL = 2;
/**Lets the library choose an algorithm automatically for grayscale transformation.*/
- public static final int GTM_AUTO = 4;
+ int GTM_AUTO = 4;
/** Skips grayscale transformation. */
- public static final int GTM_SKIP = 0;
+ int GTM_SKIP = 0;
/** Reserved setting for grayscale transformation mode. */
- public static final int GTM_REV = -2147483648;
+ int GTM_REV = -2147483648;
/**Placeholder value with no functional meaning. */
- public static final int GTM_END = 0xFFFFFFFF;
+ int GTM_END = 0xFFFFFFFF;
}
```
diff --git a/programming/android/api-reference/core/enum/image-capture-distance-mode.md b/programming/android/api-reference/core/enum/image-capture-distance-mode.md
index 28006e59..a62350fc 100644
--- a/programming/android/api-reference/core/enum/image-capture-distance-mode.md
+++ b/programming/android/api-reference/core/enum/image-capture-distance-mode.md
@@ -19,8 +19,8 @@ codeAutoHeight: true
public @interface EnumImageCaptureDistanceMode
{
/** The image is taken by close-up shot camera. */
- public static final int ICDM_NEAR = 0;
+ int ICDM_NEAR = 0;
/** The image is taken by long shot camera. */
- public static final int ICDM_FAR = 1;
+ int ICDM_FAR = 1;
}
```
diff --git a/programming/android/api-reference/core/enum/image-file-format.md b/programming/android/api-reference/core/enum/image-file-format.md
index d68e536c..cf5125e0 100644
--- a/programming/android/api-reference/core/enum/image-file-format.md
+++ b/programming/android/api-reference/core/enum/image-file-format.md
@@ -17,9 +17,9 @@ codeAutoHeight: true
```java
public @interface EnumImageFileFormat
{
- public static final int IFF_JPEG = 0;
- public static final int IFF_PNG = 1;
- public static final int IFF_BMP = 2;
- public static final int IFF_PDF = 3;
+ int IFF_JPEG = 0;
+ int IFF_PNG = 1;
+ int IFF_BMP = 2;
+ int IFF_PDF = 3;
}
```
diff --git a/programming/android/api-reference/core/enum/image-pixel-format.md b/programming/android/api-reference/core/enum/image-pixel-format.md
index a3b37e31..b5f82bec 100644
--- a/programming/android/api-reference/core/enum/image-pixel-format.md
+++ b/programming/android/api-reference/core/enum/image-pixel-format.md
@@ -19,34 +19,36 @@ codeAutoHeight: true
public @interface EnumCapturedResultItemType
{
/** 0:Black, 1:White. */
- public static final int IPF_BINARY = 0;
+ int IPF_BINARY = 0;
/** 0:White, 1:Black. */
- public static final int IPF_BINARYINVERTED = 1;
+ int IPF_BINARYINVERTED = 1;
/** 8bit gray. */
- public static final int IPF_GRAYSCALED = 2;
+ int IPF_GRAYSCALED = 2;
/** NV21. */
- public static final int IPF_NV21 = 3;
+ int IPF_NV21 = 3;
/** 16bit with RGB channel order stored in memory from high to low address. */
- public static final int IPF_RGB_565 = 4;
+ int IPF_RGB_565 = 4;
/** 16bit with RGB channel order stored in memory from high to low address. */
- public static final int IPF_RGB_555 = 5;
+ int IPF_RGB_555 = 5;
/** 24bit with RGB channel order stored in memory from high to low address. */
- public static final int IPF_RGB_888 = 6;
+ int IPF_RGB_888 = 6;
/** 32bit with ARGB channel order stored in memory from high to low address. */
- public static final int IPF_ARGB_8888 = 7;
+ int IPF_ARGB_8888 = 7;
/** 48bit with RGB channel order stored in memory from high to low address. */
- public static final int IPF_RGB_161616 = 8;
+ int IPF_RGB_161616 = 8;
/** 64bit with ARGB channel order stored in memory from high to low address. */
- public static final int IPF_ARGB_16161616 = 9;
+ int IPF_ARGB_16161616 = 9;
/** 32bit with ABGR channel order stored in memory from high to low address. */
- public static final int IPF_ABGR_8888 = 10;
+ int IPF_ABGR_8888 = 10;
/** 64bit with ABGR channel order stored in memory from high to low address. */
- public static final int IPF_ABGR_16161616 = 11;
+ int IPF_ABGR_16161616 = 11;
/** 24bit with BGR channel order stored in memory from high to low address. */
- public static final int IPF_BGR_888 = 12;
+ int IPF_BGR_888 = 12;
/** 0:Black, 255:White. */
- public static final int IPF_BINARY_8 = 13;
- /**NV12 */
- public static final int IPF_NV12 = 14;
+ int IPF_BINARY_8 = 13;
+ /** NV12 */
+ int IPF_NV12 = 14;
+ /** 0:white, 255:black. */
+ int IPF_BINARY_8_INVERTED = 15;
}
```
diff --git a/programming/android/api-reference/core/enum/image-source-state.md b/programming/android/api-reference/core/enum/image-source-state.md
index 5609586d..8cefe31b 100644
--- a/programming/android/api-reference/core/enum/image-source-state.md
+++ b/programming/android/api-reference/core/enum/image-source-state.md
@@ -18,11 +18,11 @@ ignore: true
```java
@Retention(RetentionPolicy.CLASS)
-public @interface EnumImageSourceState
+public @interface EnumImageSourceAdapterStatus
{
/** The buffer of ImageSourceAdapter is temporarily empty. */
- public static final int ISS_BUFFER_EMPTY = 0;
+ int ISAS_BUFFER_EMPTY = 0;
/** The source of ImageSourceAdapter is empty. */
- public static final int ISS_EXHAUSTED = 1;
+ int ISAS_EXHAUSTED = 1;
}
```
diff --git a/programming/android/api-reference/core/enum/image-tag-type.md b/programming/android/api-reference/core/enum/image-tag-type.md
index d539f4a8..eea05491 100644
--- a/programming/android/api-reference/core/enum/image-tag-type.md
+++ b/programming/android/api-reference/core/enum/image-tag-type.md
@@ -18,7 +18,7 @@ codeAutoHeight: true
@Retention(RetentionPolicy.CLASS)
public @interface EnumImageTagType
{
- public static final int ITT_FILE_IMAGE = 0;
- public static final int ITT_VIDEO_FRAME = 1;
+ int ITT_FILE_IMAGE = 0;
+ int ITT_VIDEO_FRAME = 1;
}
```
diff --git a/programming/android/api-reference/core/enum/intermediate-result-unit-type.md b/programming/android/api-reference/core/enum/intermediate-result-unit-type.md
index 61b21b14..9bbe5787 100644
--- a/programming/android/api-reference/core/enum/intermediate-result-unit-type.md
+++ b/programming/android/api-reference/core/enum/intermediate-result-unit-type.md
@@ -76,12 +76,12 @@ public @interface EnumIntermediateResultUnitType {
/** Detected short lines. */
long IRUT_SHORT_LINES = 1L << 27;
/** Recognized raw text lines. */
- public static final long IRUT_RAW_TEXT_LINES = 1L << 28;
+ long IRUT_RAW_TEXT_LINES = 1L << 28;
/**Detected logic lines.*/
- public static final long IRUT_LOGIC_LINES = 1L << 29;
+ long IRUT_LOGIC_LINES = 1L << 29;
/**Detected logic lines.*/
- public static final long IRUT_ENHANCED_IMAGE = 1L << 30;
+ long IRUT_ENHANCED_IMAGE = 1L << 30;
/** A mask to select all types of intermediate results. */
- long IRUT_ALL = 0xFFFFFFFFFFFFFFFF;
+ long IRUT_ALL = 0xFFFFFFFFFFFFFFFFL;
}
```
diff --git a/programming/android/api-reference/core/enum/log-mode.md b/programming/android/api-reference/core/enum/log-mode.md
index d5875a4d..a709971c 100644
--- a/programming/android/api-reference/core/enum/log-mode.md
+++ b/programming/android/api-reference/core/enum/log-mode.md
@@ -17,7 +17,7 @@ codeAutoHeight: true
```java
public @interface EnumLogMode
{
- public static final int LGM_CONSOLE = 1;
- public static final int LGM_FILE = 2;
+ int LGM_CONSOLE = 1;
+ int LGM_FILE = 2;
}
```
diff --git a/programming/android/api-reference/core/enum/pdf-reading-mode.md b/programming/android/api-reference/core/enum/pdf-reading-mode.md
index ee1e85d5..77caf3bc 100644
--- a/programming/android/api-reference/core/enum/pdf-reading-mode.md
+++ b/programming/android/api-reference/core/enum/pdf-reading-mode.md
@@ -18,14 +18,16 @@ codeAutoHeight: true
@Retention(RetentionPolicy.CLASS)
public @interface EnumPDFReadingMode
{
+ /** Lets the Library choose the reading mode automatically. Not supported yet. */
+ int PDFRM_AUTO = 0x01;
/** Capture content from vector data in PDF file. */
- public static final int PDFRM_VECTOR = 1;
+ int PDFRM_VECTOR = 0x02;
/** The default value.
* Outputs raster data found in the PDFs.
* Depending on the argument Resolution, the SDK may rasterize the PDF pages.
* Check the template for available argument settings. */
- public static final int PDFRM_RASTER = 2;
+ int PDFRM_RASTER = 0x02;
/** Reserved setting for PDF reading mode.*/
- public static final int PDFRM_REV = -2147483648;
+ int PDFRM_REV = -2147483648;
}
```
diff --git a/programming/android/api-reference/core/enum/raster-data-source.md b/programming/android/api-reference/core/enum/raster-data-source.md
index b51c7a2a..d4d5ca2a 100644
--- a/programming/android/api-reference/core/enum/raster-data-source.md
+++ b/programming/android/api-reference/core/enum/raster-data-source.md
@@ -16,8 +16,8 @@ breadcrumbText: RasterDataSource
```java
public @interface EnumRasterDataSource {
/**The raster data source type of the PDF file is "pages". Only available for PDFReadingMode raster.*/
- public static final int RDS_RASTERIZED_PAGES = 0;
+ int RDS_RASTERIZED_PAGES = 0;
/**The raster data source type of the PDF file is "images".*/
- public static final int RDS_EXTRACTED_IMAGES = 1;
+ int RDS_EXTRACTED_IMAGES = 1;
}
```
diff --git a/programming/android/api-reference/core/enum/region-object-element-type.md b/programming/android/api-reference/core/enum/region-object-element-type.md
index 9712a6af..5ad9e873 100644
--- a/programming/android/api-reference/core/enum/region-object-element-type.md
+++ b/programming/android/api-reference/core/enum/region-object-element-type.md
@@ -19,20 +19,20 @@ codeAutoHeight: true
public @interface EnumRegionObjectElementType
{
/**The type of subclass PredetectedRegionElement.*/
- public static final int ROET_PREDETECTED_REGION = 0;
+ int ROET_PREDETECTED_REGION = 0;
/**The type of subclass LocalizedBarcodeElement.*/
- public static final int ROET_LOCALIZED_BARCODE = 1;
+ int ROET_LOCALIZED_BARCODE = 1;
/**The type of subclass DecodedBarcodeElement.*/
- public static final int ROET_DECODED_BARCODE = 2;
+ int ROET_DECODED_BARCODE = 2;
/**The type of subclass LocalizedTextLineElement.*/
- public static final int ROET_LOCALIZED_TEXT_LINE = 3;
+ int ROET_LOCALIZED_TEXT_LINE = 3;
/**The type of subclass RecognizedTextLineElement.*/
- public static final int ROET_RECOGNIZED_TEXT_LINE = 4;
+ int ROET_RECOGNIZED_TEXT_LINE = 4;
/**The type of subclass DetectedQuadElement.*/
- public static final int ROET_DETECTED_QUAD = 5;
+ int ROET_DETECTED_QUAD = 5;
/**The type of subclass DeskewedImageElement.*/
- public static final int ROET_DESKEWED_IMAGE = 6;
+ int ROET_DESKEWED_IMAGE = 6;
/**The type of subclass EnhancedImageElement.*/
- public static final int ROET_ENHANCED_IMAGE = 6;
+ int ROET_ENHANCED_IMAGE = 6;
}
```
diff --git a/programming/android/api-reference/core/enum/section-type.md b/programming/android/api-reference/core/enum/section-type.md
index 295040c8..f4a3ec31 100644
--- a/programming/android/api-reference/core/enum/section-type.md
+++ b/programming/android/api-reference/core/enum/section-type.md
@@ -19,22 +19,22 @@ codeAutoHeight: true
public @interface EnumSectionType
{
/**No section type is specified.*/
- public static final int ST_NULL = 0;
+ int ST_NULL = 0;
/**The result is output by "region prediction" section.*/
- public static final int ST_REGION_PREDETECTION = 1;
+ int ST_REGION_PREDETECTION = 1;
/**The result is output by "barcode localization" section.*/
- public static final int ST_BARCODE_LOCALIZATION = 2;
+ int ST_BARCODE_LOCALIZATION = 2;
/**The result is output by "barcode decoding" section.*/
- public static final int ST_BARCODE_DECODING = 3;
+ int ST_BARCODE_DECODING = 3;
/**The result is output by "text line localization" section.*/
- public static final int ST_TEXT_LINE_LOCALIZATION = 4;
+ int ST_TEXT_LINE_LOCALIZATION = 4;
/**The result is output by "text line recognition" section.*/
- public static final int ST_TEXT_LINE_RECOGNITION = 5;
+ int ST_TEXT_LINE_RECOGNITION = 5;
/**The result is output by "document detection" section.*/
- public static final int ST_DOCUMENT_DETECTION = 6;
+ int ST_DOCUMENT_DETECTION = 6;
/**The result is output by "document deskewing" section.*/
- public static final int ST_DOCUMENT_DESKEWING = 7;
+ int ST_DOCUMENT_DESKEWING = 7;
/**The result is output by "document enhancement" section.*/
- public static final int ST_IMAGE_ENHANCEMENT = 8;
+ int ST_IMAGE_ENHANCEMENT = 8;
}
```
diff --git a/programming/android/api-reference/core/enum/video-frame-quality.md b/programming/android/api-reference/core/enum/video-frame-quality.md
index eacb67eb..ae796f8d 100644
--- a/programming/android/api-reference/core/enum/video-frame-quality.md
+++ b/programming/android/api-reference/core/enum/video-frame-quality.md
@@ -18,10 +18,10 @@ codeAutoHeight: true
@Retention(RetentionPolicy.CLASS)
public @interface EnumVideoFrameQuality {
/**The frame quality is measured to be high.*/
- public static final int VFQ_HIGH = 0;
+ int VFQ_HIGH = 0;
/**The frame quality is measured to be low.*/
- public static final int VFQ_LOW = 1;
+ int VFQ_LOW = 1;
/**The frame quality is unknown.*/
- public static final int VFQ_UNKNOWN = 2;
+ int VFQ_UNKNOWN = 2;
}
```
diff --git a/programming/android/api-reference/core/intermediate-results/binary-image-unit.md b/programming/android/api-reference/core/intermediate-results/binary-image-unit.md
index 5dcea916..0adf392c 100644
--- a/programming/android/api-reference/core/intermediate-results/binary-image-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/binary-image-unit.md
@@ -48,6 +48,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets the image data for the binary image.
```java
+@Nullable
ImageData getImageData();
```
@@ -60,7 +61,7 @@ The `ImageData` object as the image data of the binary image.
Sets the image data for the binary image.
```java
-int setImageData(ImageData imageData);
+int setImageData(@Nullable ImageData imageData);
```
**Parameters**
diff --git a/programming/android/api-reference/core/intermediate-results/colour-image-unit.md b/programming/android/api-reference/core/intermediate-results/colour-image-unit.md
index 1f850dcc..15148e19 100644
--- a/programming/android/api-reference/core/intermediate-results/colour-image-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/colour-image-unit.md
@@ -48,6 +48,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets the image data for the colour image.
```java
+@Nullable
ImageData getImageData();
```
@@ -60,7 +61,7 @@ The `ImageData` object as the image data of the colour image.
Sets the image data for the colour image.
```java
-int setImageData(ImageData imageData);
+int setImageData(@Nullable ImageData imageData);
```
**Parameters**
diff --git a/programming/android/api-reference/core/intermediate-results/contours-unit.md b/programming/android/api-reference/core/intermediate-results/contours-unit.md
index a045d5f2..366fb619 100644
--- a/programming/android/api-reference/core/intermediate-results/contours-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/contours-unit.md
@@ -49,6 +49,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets the contour array of the unit.
```java
+@Nullable
Contour[] getContours()
```
@@ -81,6 +82,7 @@ Returns the `ErrorCode` if failed. Otherwise, returns 0.
Gets the contour hierarchies as an array of `Vector4` objects.
```java
+@Nullable
Vector4[] getHierarchies()
```
diff --git a/programming/android/api-reference/core/intermediate-results/enhanced-grayscale-image-unit.md b/programming/android/api-reference/core/intermediate-results/enhanced-grayscale-image-unit.md
index 05336174..364d1816 100644
--- a/programming/android/api-reference/core/intermediate-results/enhanced-grayscale-image-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/enhanced-grayscale-image-unit.md
@@ -48,6 +48,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets the image data for the enhanced grayscale image.
```java
+@Nullable
ImageData getImageData();
```
@@ -60,7 +61,7 @@ The `ImageData` object as the image data of the enhanced grayscale image.
Sets the image data for the enhanced grayscale image.
```java
-int setImageData(ImageData imageData);
+int setImageData(@Nullable ImageData imageData);
```
**Parameter**
diff --git a/programming/android/api-reference/core/intermediate-results/grayscale-image-unit.md b/programming/android/api-reference/core/intermediate-results/grayscale-image-unit.md
index 89b651df..8d1be4c3 100644
--- a/programming/android/api-reference/core/intermediate-results/grayscale-image-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/grayscale-image-unit.md
@@ -48,6 +48,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets the image data for the grayscale image.
```java
+@Nullable
ImageData getImageData();
```
@@ -60,7 +61,7 @@ The `ImageData` object as the image data of the grayscale image.
Sets the image data for the grayscale image.
```java
-int setImageData(ImageData imageData);
+int setImageData(@Nullable ImageData imageData);
```
**Parameters**
diff --git a/programming/android/api-reference/core/intermediate-results/intermediate-result-extra-info.md b/programming/android/api-reference/core/intermediate-results/intermediate-result-extra-info.md
index 80c1f08d..5b2d73cc 100644
--- a/programming/android/api-reference/core/intermediate-results/intermediate-result-extra-info.md
+++ b/programming/android/api-reference/core/intermediate-results/intermediate-result-extra-info.md
@@ -29,7 +29,7 @@ class IntermediateResultExtraInfo
| [`targetROIDefName`](#targetroidefname) | *String* | The property indicates the name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-def/) object that generates the intermediate result. |
| [`taskName`](#taskname) | *String* | The property indicates the name of the processing task to which this result belongs. |
| [`isSectionLevelResult`](#issectionlevelresult) | *boolean* | The property indicates whether the result is at the section level. |
-| [`sectionType`](#sectiontype) | *[EnumSectionType]({{ site.dcv_android_api }}core/enum/section-type.html?lang=android)* | The property indicates the type of section that generates the result, if applicable, as defined by the enumeration `EnumSectionType`. |
+| [`sectionType`](#sectiontype) | *int* | The property indicates the type of section that generates the result, if applicable, as defined by the enumeration `EnumSectionType`. |
### targetROIDefName
@@ -60,5 +60,6 @@ boolean isSectionLevelResult;
The type of section that generates the result, if applicable, as defined by the enumeration [`EnumSectionType`]({{ site.dcv_android_api }}core/enum/section-type.html?lang=android).
```java
-EnumSectionType sectionType;
+@EnumSectionType
+int sectionType;
```
diff --git a/programming/android/api-reference/core/intermediate-results/intermediate-result-manager.md b/programming/android/api-reference/core/intermediate-results/intermediate-result-manager.md
deleted file mode 100644
index 3497429d..00000000
--- a/programming/android/api-reference/core/intermediate-results/intermediate-result-manager.md
+++ /dev/null
@@ -1,74 +0,0 @@
----
-layout: default-layout
-title: IntermediateResultManager - Dynamsoft Core Module Android Edition API Reference
-description: The class IntermediateResultManager of Dynamsoft Core Module manages intermediate results generated during data capturing. It provides methods to add and remove intermediate result receivers, as well as to get original image data using an image hash id.
-keywords: intermediate result manager, Java, Kotlin
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-ignore: true
----
-
-# IntermediateResultManager
-
-> You are reading a history page of `DynamsoftCore`. Start from v3.2.10, the `IntermediateResultManager` class is moved to the `DynamsoftCaptureVisionRouter` module. View the [`DynamsoftCaptureVisionRouter.IntermediateResultManager`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html) for the latest version.
-
-The `IntermediateResultManager` class is responsible for handling intermediate results obtained during the process of an image. It offers methods to both register and deregister receivers of these intermediate results, as well as to retrieve the original image data.
-
-## Definition
-
-*Namespace:* com.dynamsoft.core.intermediate_results
-
-*Assembly:* DynamsoftCaptureVisionBundle.aar
-
-```java
-class IntermediateResultManager
-```
-
-## Methods
-
-| Method | Description |
-| ------ | ----------- |
-| [`addResultReceiver`](#addresultreceiver) | Adds a `IntermediateResultReceiver` object as the receiver of intermediate results. |
-| [`removeResultReceiver`](#removeresultreceiver) | Removes the specified `IntermediateResultReceiver` object. |
-| [`getOriginalImage`](#getoriginalimage) | Retrieves the original image data. |
-
-### addResultReceiver
-
-Adds a `IntermediateResultReceiver` object as the receiver of intermediate results.
-
-```java
-void addResultReceiver(IntermediateResultReceiver receiver);
-```
-
-**Parameters**
-
-`[in] receiver`: A delegate object of `IntermediateResultReceiver`.
-
-### removeResultReceiver
-
-Removes the specified `IntermediateResultReceiver` object.
-
-```java
-void removeResultReceiver(IntermediateResultReceiver receiver);
-```
-
-**Parameters**
-
-`[in] receiver`: A delegate object of [`IntermediateResultReceiver`](intermediate-result-receiver.md).
-
-### getOriginalImage
-
-Retrieves the original image data.
-
-```java
-ImageData getOriginalImage(String imageHashId);
-```
-
-**Parameters**
-
-`[in] imageHashId`: The image hash ID.
-
-**Return Value**
-
-The original image data, of type [`ImageData`](../basic-structures/image-data.md).
diff --git a/programming/android/api-reference/core/intermediate-results/intermediate-result-receiver.md b/programming/android/api-reference/core/intermediate-results/intermediate-result-receiver.md
deleted file mode 100644
index 6e4f7bce..00000000
--- a/programming/android/api-reference/core/intermediate-results/intermediate-result-receiver.md
+++ /dev/null
@@ -1,464 +0,0 @@
----
-layout: default-layout
-title: IntermediateResultReceiver - Dynamsoft Core Module Android Edition API Reference
-description: The interface IntermediateResultReceiver includes methods for monitoring the output of intermediate results.
-keywords: interface, Java, Kotlin
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-ignore: true
----
-
-# IntermediateResultReceiver
-
-> You are reading a history page of `DynamsoftCore`. Start from v3.2.10, the `IntermediateResultReceiver` class is moved to the `DynamsoftCaptureVisionRouter` module. View the [`DynamsoftCaptureVisionRouter.IntermediateResultReceiver`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) for the latest version.
-
-The `IntermediateResultReceiver` interface includes methods for monitoring the output of intermediate results.
-
-## Definition
-
-*Namespace:* com.dynamsoft.core.intermediate_results
-
-*Assembly:* DynamsoftCaptureVisionBundle.aar
-
-```java
-interface IntermediateResultReceiver
-```
-
-## Methods
-
-| Method | Description |
-| ------ | ----------- |
-| [`getObservationParameters`](#getobservationparameters) | Gets the observed parameters of the intermediate result receiver. Allowing for configuration of intermediate result observation. |
-| [`onPredetectedRegionsReceived`](#onpredetectedregionsreceived) | The callback method triggered when a pre-detected regions unit is received. |
-| [`onLocalizedBarcodesReceived`](#onlocalizedbarcodesreceived) | The callback method triggered when a localized barcodes unit is received. |
-| [`onDecodedBarcodesReceived`](#ondecodedbarcodesreceived) | The callback method triggered when a decoded barcodes unit is received. |
-| [`onLocalizedTextLinesReceived`](#onlocalizedtextlinesreceived) | The callback method triggered when a localized text lines unit is received. |
-| [`onRecognizedTextLinesReceived`](#onrecognizedtextlinesreceived) | The callback method triggered when a recognized text lines unit is received. |
-| [`onDetectedQuadsReceived`](#ondetectedquadsreceived) | The callback method triggered when a detected quads unit is received. |
-| [`onNormalizedImagesReceived`](#onnormalizedimagesreceived) | The callback method triggered when a normalized images unit is received. |
-| [`onColourImageUnitReceived`](#oncolourimageunitreceived) | The callback method triggered when a colour images unit is received. |
-| [`onScaledDownColourImageUnitReceived`](#onscaleddowncolourimageunitreceived) | The callback method triggered when a scaled down colour images unit is received. |
-| [`onGrayscaleImageUnitReceived`](#ongrayscaleimageunitreceived) | The callback method triggered when a grayscale images unit is received. |
-| [`onTransformedGrayscaleImageUnitReceived`](#ontransformedgrayscaleimageunitreceived) | The callback method triggered when a transformed grayscale images unit is received. |
-| [`onEnhancedGrayscaleImageUnitReceived`](#onenhancedgrayscaleimageunitreceived) | The callback method triggered when a enhanced grayscale images unit is received. |
-| [`onBinaryImageUnitReceived`](#onbinaryimageunitreceived) | The callback method triggered when a binary images unit is received. |
-| [`onTextureDetectionResultUnitReceived`](#ontexturedetectionresultunitreceived) | The callback method triggered when a texture detection results unit is received. |
-| [`onTextureRemovedGrayscaleImageUnitReceived`](#ontextureremovedgrayscaleimageunitreceived) | The callback method triggered when a texture-removed grayscale images unit is received. |
-| [`onTextureRemovedBinaryImageUnitReceived`](#ontextureremovedbinaryimageunitreceived) | The callback method triggered when a texture-removed binary images unit is received. |
-| [`onContoursUnitReceived`](#oncontoursunitreceived) | The callback method triggered when a contours unit is received. |
-| [`onLineSegmentsUnitReceived`](#onlinesegmentsunitreceived) | The callback method triggered when a line segments unit is received. |
-| [`onTextZonesUnitReceived`](#ontextzonesunitreceived) | The callback method triggered when a text zones unit is received. |
-| [`onTextRemovedBinaryImageUnitReceived`](#ontextremovedbinaryimageunitreceived) | The callback method triggered when a text removed binary images unit is received. |
-| [`onLongLinesUnitReceived`](#onlonglinesunitreceived) | The callback method triggered when a long lines unit is received. |
-| [`onCornersUnitReceived`](#oncornersunitreceived) | The callback method triggered when a corners unit is received. |
-| [`onCandidateQuadEdgesUnitReceived`](#oncandidatequadedgesunitreceived) | The callback method triggered when a candidate quad edges unit is received. |
-| [`onCandidateBarcodeZonesUnitReceived`](#oncandidatebarcodezonesunitreceived) | The callback method triggered when a candidate barcode zones unit is received. |
-| [`onScaledUpBarcodeImageUnitReceived`](#onscaledupbarcodeimageunitreceived) | The callback method triggered when a scaled up barcode images unit is received. |
-| [`onDeformationResistedBarcodeImageUnitReceived`](#ondeformationresistedbarcodeimageunitreceived) | The callback method triggered when a deformation-resisted barcode images unit is received. |
-| [`onComplementedBarcodeImageUnitReceived`](#oncomplementedbarcodeimageunitreceived) | The callback method triggered when a complemented barcode images unit is received. |
-| [`onTaskResultsReceived`](#ontaskresultsreceived) | The callback method triggered when a task results unit is received. |
-
-### getObservationParameters
-
-Gets the observed parameters of the intermediate result receiver. Allowing for configuration of intermediate result observation.
-
-```java
-ObservationParameters getObservationParameters();
-```
-
-**Return Value**
-
-The observed parameters, of type `ObservationParameters`. The default parameters are to observe all intermediate result unit types and all tasks.
-
-### onPredetectedRegionsReceived
-
-The callback method triggered when a pre-detected regions unit is received.
-
-```java
-void onPredetectedRegionsReceived(PredetectedRegionsUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the pre-detected regions, of type `PredetectedRegionsUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onLocalizedBarcodesReceived
-
-The callback method triggered when a localized barcodes unit is received.
-
-```java
-void onLocalizedBarcodesReceived(LocalizedBarcodesUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the localized barcodes, of type `LocalizedBarcodesUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onDecodedBarcodesReceived
-
-The callback method triggered when a decoded barcodes unit is received.
-
-```java
-void onDecodedBarcodesReceived(DecodedBarcodesUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the decoded barcodes, of type `DecodedBarcodesUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onLocalizedTextLinesReceived
-
-The callback method triggered when a localized text lines unit is received.
-
-```java
-void onLocalizedTextLinesReceived(LocalizedTextLinesUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the localized text lines, of type `LocalizedTextLinesUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onRecognizedTextLinesReceived
-
-The callback method triggered when a recognized text lines unit is received.
-
-```java
-void onRecognizedTextLinesReceived(RecognizedTextLinesUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the recognized text lines, of type `RecognizedTextLinesUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onDetectedQuadsReceived
-
-The callback method triggered when a detected quads unit is received.
-
-```java
-void onDetectedQuadsReceived(DetectedQuadsUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the detected quads, of type `DetectedQuadsUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onNormalizedImagesReceived
-
-The callback method triggered when a normalized images unit is received.
-
-```java
-void onNormalizedImagesReceived(NormalizedImagesUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the normalized images, of type `NormalizedImagesUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onColourImageUnitReceived
-
-The callback method triggered when a colour images unit is received.
-
-```java
-void onColourImageUnitReceived(ColourImageUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the colour images, of type `ColourImageUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onScaledDownColourImageUnitReceived
-
-The callback method triggered when a scaled-down colour images unit is received.
-
-```java
-void onScaledDownColourImageUnitReceived(ScaledDownColourImageUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the scaled-down colour images, of type `ScaledDownColourImageUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onGrayscaleImageUnitReceived
-
-The callback method triggered when a grayscale images unit is received.
-
-```java
-void onGrayscaleImageUnitReceived(GrayscaleImageUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the grayscale images, of type `GrayscaleImageUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onTransformedGrayscaleImageUnitReceived
-
-The callback method triggered when a transformed grayscale images unit is received.
-
-```java
-void onTransformedGrayscaleImageUnitReceived(TransformedGrayscaleImageUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the transformed grayscale images, of type `TransformedGrayscaleImageUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onEnhancedGrayscaleImageUnitReceived
-
-The callback method triggered when a enhanced grayscale images unit is received.
-
-```java
-void onEnhancedGrayscaleImageUnitReceived(EnhancedGrayscaleImageUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the enhanced grayscale images, of type `EnhancedGrayscaleImageUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onBinaryImageUnitReceived
-
-The callback method triggered when a binary images unit is received.
-
-```java
-void onBinaryImageUnitReceived(BinaryImageUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the binary images, of type `BinaryImageUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onTextureDetectionResultUnitReceived
-
-The callback method triggered when a texture detection results unit is received.
-
-```java
-void onTextureDetectionResultUnitReceived(TextureDetectionResultUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the texture detection results, of type `TextureDetectionResultUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onTextureRemovedGrayscaleImageUnitReceived
-
-The callback method triggered when a texture removed grayscale images unit is received.
-
-```java
-void onTextureRemovedGrayscaleImageUnitReceived(TextureRemovedGrayscaleImageUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the texture removed grayscale images, of type `TextureRemovedGrayscaleImageUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onTextureRemovedBinaryImageUnitReceived
-
-The callback method triggered when a texture removed binary images unit is received.
-
-```java
-void onTextureRemovedBinaryImageUnitReceived(TextureRemovedBinaryImageUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the texture removed binary images, of type `TextureRemovedBinaryImageUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onContoursUnitReceived
-
-The callback method triggered when a contours unit is received.
-
-```java
-void onContoursUnitReceived(ContoursUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the contours, of type `ContoursUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onLineSegmentsUnitReceived
-
-The callback method triggered when a line segments unit is received.
-
-```java
-void onLineSegmentsUnitReceived(LineSegmentsUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the line segments, of type `LineSegmentsUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onTextZonesUnitReceived
-
-The callback method triggered when a text zones unit is received.
-
-```java
-void onTextZonesUnitReceived(TextZonesUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the text zones, of type `TextZonesUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onTextRemovedBinaryImageUnitReceived
-
-The callback method triggered when a text removed binary images unit is received.
-
-```java
-void onTextRemovedBinaryImageUnitReceived(TextRemovedBinaryImageUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the text removed binary images, of type `TextRemovedBinaryImageUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onLongLinesUnitReceived
-
-The callback method triggered when a long lines unit is received.
-
-```java
-void onLongLinesUnitReceived(LongLinesUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the long lines, of type `LongLinesUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onCornersUnitReceived
-
-The callback method triggered when a corners unit is received.
-
-```java
-void onCornersUnitReceived(CornersUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the corners, of type `CornersUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onCandidateQuadEdgesUnitReceived
-
-The callback method triggered when a candidate quad edges unit is received.
-
-```java
-void onCandidateQuadEdgesUnitReceived(CandidateQuadEdgesUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the candidate quad edges, of type `CandidateQuadEdgesUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onCandidateBarcodeZonesUnitReceived
-
-The callback method triggered when a candidate barcode zones unit is received.
-
-```java
-void onCandidateBarcodeZonesUnitReceived(CandidateBarcodeZonesUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the candidate barcode zones, of type `CandidateBarcodeZonesUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onScaledUpBarcodeImageUnitReceived
-
-The callback method triggered when a scaled up barcode images unit is received.
-
-```java
-void onScaledUpBarcodeImageUnitReceived(ScaledUpBarcodeImageUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the scaled up barcode images, of type `ScaledUpBarcodeImageUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onDeformationResistedBarcodeImageUnitReceived
-
-The callback method triggered when a deformation resisted barcode images unit is received.
-
-```java
-void onDeformationResistedBarcodeImageUnitReceived(DeformationResistedBarcodeImageUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the deformation resisted barcode images, of type `DeformationResistedBarcodeImageUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onComplementedBarcodeImageUnitReceived
-
-The callback method triggered when a complemented barcode images unit is received.
-
-```java
-void onComplementedBarcodeImageUnitReceived(ComplementedBarcodeImageUnit unit, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the complemented barcode images, of type `ComplementedBarcodeImageUnit`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
-
-### onTaskResultsReceived
-
-The callback method triggered when a task results unit is received.
-
-```java
-void onTaskResultsReceived(IntermediateResult result, IntermediateResultExtraInfo info);
-```
-
-**Parameters**
-
-`[in] unit`: The result unit that contains the task results, of type `IntermediateResult`.
-
-`[in] info`: Additional information about the result, of type `IntermediateResultExtraInfo`.
diff --git a/programming/android/api-reference/core/intermediate-results/intermediate-result-unit.md b/programming/android/api-reference/core/intermediate-results/intermediate-result-unit.md
index 0c8ca607..87b53535 100644
--- a/programming/android/api-reference/core/intermediate-results/intermediate-result-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/intermediate-result-unit.md
@@ -39,6 +39,7 @@ class IntermediateResultUnit
Creates a copy of the intermediate result unit.
```java
+@NonNull
IntermediateResultUnit clone();
```
@@ -51,6 +52,7 @@ A copy of the intermediate result unit.
Gets the hash ID of the unit.
```java
+@NonNull
String getHashId();
```
@@ -63,6 +65,7 @@ The hash ID of the unit.
Gets the hash ID of the original image. You can use this ID to get the original image via `IntermediateResultManager` class.
```java
+@NonNull
String getOriginalImageHashId();
```
@@ -75,6 +78,7 @@ The hash ID of the original image.
Gets the image tag of the original image.
```java
+@Nullable
ImageTag getOriginalImageTag();
```
@@ -87,6 +91,7 @@ The image tag of the original image.
Gets the type of the intermediate result unit.
```java
+@EnumIntermediateResultUnitType
long getType();
```
@@ -99,7 +104,8 @@ The type of the intermediate result unit.
Gets the transformation matrix via [`EnumTransformMatrixType`]({{ site.dcv_android_api }}core/enum/transform-matrix-type.html).
```java
-Matrix getTransformMatrix(int matrixType);
+@Nullable
+Matrix getTransformMatrix(@EnumTransformMatrixType int matrixType);
```
**Parameters**
diff --git a/programming/android/api-reference/core/intermediate-results/intermediate-result.md b/programming/android/api-reference/core/intermediate-results/intermediate-result.md
index c089fa7e..87920b77 100644
--- a/programming/android/api-reference/core/intermediate-results/intermediate-result.md
+++ b/programming/android/api-reference/core/intermediate-results/intermediate-result.md
@@ -26,11 +26,11 @@ class IntermediateResult
| Methods | Description |
| ------- | ----------- |
-| [`getIntermediateResultUnits`](#getintermediateresultunits) | Get an array of [`IntermediateResultUnit`](intermediate-result-unit.md) objects, each representing a different type of intermediate result. |
+| [`getIntermediateResultUnits`](#getintermediateresultunits) | Gets an array of [`IntermediateResultUnit`](intermediate-result-unit.md) objects, each representing a different type of intermediate result. |
### getIntermediateResultUnits
-Get an array of [`IntermediateResultUnit`](intermediate-result-unit.md) objects, each representing a different type of intermediate result.
+Gets an array of [`IntermediateResultUnit`](intermediate-result-unit.md) objects, each representing a different type of intermediate result.
```java
IntermediateResultUnit[] getIntermediateResultUnits()
diff --git a/programming/android/api-reference/core/intermediate-results/line-segments-unit.md b/programming/android/api-reference/core/intermediate-results/line-segments-unit.md
index 4f5955cf..18f16611 100644
--- a/programming/android/api-reference/core/intermediate-results/line-segments-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/line-segments-unit.md
@@ -53,6 +53,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets the array of [`LineSegment`](../basic-structures/line-segment.html).
```java
+@Nullable
LineSegment[] getLineSegments();
```
@@ -77,6 +78,7 @@ The number of line segments.
Gets the [`LineSegment`](../basic-structures/line-segment.html) at the specified index.
```java
+@Nullable
LineSegment getLineSegment(int index);
```
diff --git a/programming/android/api-reference/core/intermediate-results/predetected-region-element.md b/programming/android/api-reference/core/intermediate-results/predetected-region-element.md
index b93d53c3..d4170c03 100644
--- a/programming/android/api-reference/core/intermediate-results/predetected-region-element.md
+++ b/programming/android/api-reference/core/intermediate-results/predetected-region-element.md
@@ -54,7 +54,7 @@ The name of the detection mode used to detect this region element. It can be one
Sets the location of the pre-detected region object.
```java
-void setLocation(Quadrilateral location);
+void setLocation(@NonNull Quadrilateral location);
```
**Parameters**
@@ -82,6 +82,7 @@ The label ID of this pre-detected region.
Gets the label name of this pre-detected region element.
```java
+@NonNull
String getLabelName();
```
diff --git a/programming/android/api-reference/core/intermediate-results/predetected-regions-unit.md b/programming/android/api-reference/core/intermediate-results/predetected-regions-unit.md
index 23eb6d0b..cf70131c 100644
--- a/programming/android/api-reference/core/intermediate-results/predetected-regions-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/predetected-regions-unit.md
@@ -53,6 +53,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Get the array of `PredetectedRegionElement` objects.
```java
+@Nullable
PredetectedRegionElement[] getPredetectedRegions();
```
@@ -77,6 +78,7 @@ The number of `PredetectedRegionElement` objects.
Get the `PredetectedRegionElement` object at the specified index.
```java
+@Nullable
PredetectedRegionElement getPredetectedRegion(int index);
```
diff --git a/programming/android/api-reference/core/intermediate-results/region-object-element.md b/programming/android/api-reference/core/intermediate-results/region-object-element.md
index 5be4ede4..7aa8633f 100644
--- a/programming/android/api-reference/core/intermediate-results/region-object-element.md
+++ b/programming/android/api-reference/core/intermediate-results/region-object-element.md
@@ -36,6 +36,7 @@ class RegionObjectElement
Gets the location of the region object, represented as a [`Quadrilateral`](../basic-structures/quadrilateral.md).
```java
+@NonNull
Quadrilateral getLocation();
```
@@ -48,6 +49,7 @@ The location of the region object, represented as a [`Quadrilateral`](../basic-s
Gets the referenced element that supports the capturing of this element.
```java
+@Nullable
RegionObjectElement getReferencedElement();
```
@@ -73,6 +75,7 @@ The type of the region object element.
Gets the original image that produce this element.
```java
+@Nullable
ImageData getImageData();
```
diff --git a/programming/android/api-reference/core/intermediate-results/scaled-down-colour-image-unit.md b/programming/android/api-reference/core/intermediate-results/scaled-down-colour-image-unit.md
index 76a5688c..74f0f08a 100644
--- a/programming/android/api-reference/core/intermediate-results/scaled-down-colour-image-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/scaled-down-colour-image-unit.md
@@ -48,6 +48,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets the image data for the scaled-down colour image.
```java
+@Nullable
ImageData getImageData();
```
diff --git a/programming/android/api-reference/core/intermediate-results/short-lines-unit.md b/programming/android/api-reference/core/intermediate-results/short-lines-unit.md
index 7ef0f6cf..283cedcb 100644
--- a/programming/android/api-reference/core/intermediate-results/short-lines-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/short-lines-unit.md
@@ -53,6 +53,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets an array of `LineSegment` objects, each representing a short line detected within the image.
```java
+@Nullable
LineSegment[] getShortLines()
```
@@ -77,6 +78,7 @@ The number of short lines.
Gets the short line at the specified index.
```java
+@Nullable
LineSegment getShortLine(int index)
```
diff --git a/programming/android/api-reference/core/intermediate-results/text-removed-binary-image-unit.md b/programming/android/api-reference/core/intermediate-results/text-removed-binary-image-unit.md
index b9cb55d4..aab8a316 100644
--- a/programming/android/api-reference/core/intermediate-results/text-removed-binary-image-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/text-removed-binary-image-unit.md
@@ -48,6 +48,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets the image data for the text-removed binary image.
```java
+@Nullable
ImageData getImageData();
```
@@ -60,7 +61,7 @@ The `ImageData` object as the image data of the text-removed binary image.
Sets the image data for the text-removed binary image.
```java
-int setImageData(ImageData imageData);
+int setImageData(@Nullable ImageData imageData);
```
**Parameter**
diff --git a/programming/android/api-reference/core/intermediate-results/text-zone.md b/programming/android/api-reference/core/intermediate-results/text-zone.md
index d9a71f14..1372834b 100644
--- a/programming/android/api-reference/core/intermediate-results/text-zone.md
+++ b/programming/android/api-reference/core/intermediate-results/text-zone.md
@@ -34,6 +34,7 @@ class TextZone
The location of the text zone.
```java
+@NonNull
Quadrilateral location
```
@@ -42,5 +43,6 @@ Quadrilateral location
The indices of the character contours.
```java
+@NonNull
int[] charContoursIndices
```
diff --git a/programming/android/api-reference/core/intermediate-results/text-zones-unit.md b/programming/android/api-reference/core/intermediate-results/text-zones-unit.md
index 9f829d67..806fa8fd 100644
--- a/programming/android/api-reference/core/intermediate-results/text-zones-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/text-zones-unit.md
@@ -53,6 +53,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets an array of `TextZone` objects, each representing the geometric boundaries of a detected text zone within the image.
```java
+@Nullable
TextZone[] getTextZones()
```
@@ -77,6 +78,7 @@ The number of text zones.
Gets the text zone at the specified index.
```java
+@Nullable
TextZone getTextZone(int index)
```
diff --git a/programming/android/api-reference/core/intermediate-results/texture-removed-binary-image-unit.md b/programming/android/api-reference/core/intermediate-results/texture-removed-binary-image-unit.md
index 9f3d9b80..ae754b7f 100644
--- a/programming/android/api-reference/core/intermediate-results/texture-removed-binary-image-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/texture-removed-binary-image-unit.md
@@ -48,6 +48,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets the `ImageData` object as the image data of the texture-removed binary image.
```java
+@Nullable
ImageData getImageData();
```
@@ -60,7 +61,7 @@ The `ImageData` object as the image data of the texture-removed binary image.
Sets the `ImageData` object as the image data of the texture-removed binary image.
```java
-int setImageData(ImageData imageData);
+int setImageData(@Nullable ImageData imageData);
```
**Parameter**
diff --git a/programming/android/api-reference/core/intermediate-results/texture-removed-grayscale-image-unit.md b/programming/android/api-reference/core/intermediate-results/texture-removed-grayscale-image-unit.md
index fe0765ec..ea314c4a 100644
--- a/programming/android/api-reference/core/intermediate-results/texture-removed-grayscale-image-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/texture-removed-grayscale-image-unit.md
@@ -48,6 +48,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets the `ImageData` object as the image data of the texture-removed grayscale image.
```java
+@Nullable
ImageData getImageData();
```
@@ -60,7 +61,7 @@ The `ImageData` object as the image data of the texture-removed grayscale image
Sets the `ImageData` object as the image data of the texture-removed grayscale image.
```java
-int setImageData(ImageData imageData);
+int setImageData(@Nullable ImageData imageData);
```
**Parameter**
diff --git a/programming/android/api-reference/core/intermediate-results/transformed-grayscale-image-unit.md b/programming/android/api-reference/core/intermediate-results/transformed-grayscale-image-unit.md
index 8f660f07..9f5c6921 100644
--- a/programming/android/api-reference/core/intermediate-results/transformed-grayscale-image-unit.md
+++ b/programming/android/api-reference/core/intermediate-results/transformed-grayscale-image-unit.md
@@ -48,6 +48,7 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
Gets the `ImageData` object as the image data of the grayscale-transformed image.
```java
+@Nullable
ImageData getImageData();
```
@@ -60,7 +61,7 @@ The `ImageData` object as the image data of the grayscale-transformed image.
Sets the `ImageData` object as the image data of the grayscale-transformed image.
```java
-void setImageData(ImageData imageData);
+void setImageData(@Nullable ImageData imageData);
```
**Parameter**
diff --git a/programming/android/api-reference/dnn/neural-network-module.md b/programming/android/api-reference/dnn/neural-network-module.md
index 1505a44b..acd1b025 100644
--- a/programming/android/api-reference/dnn/neural-network-module.md
+++ b/programming/android/api-reference/dnn/neural-network-module.md
@@ -15,7 +15,7 @@ The `NeuralNetworkModule` class defines general functions of the `DynamsoftNeura
## Definition
-*Namespace:* com.dynamsoft.dip
+*Namespace:* com.dynamsoft.dnn
*Assembly:* DynamsoftCaptureVisionBundle.aar
diff --git a/programming/android/api-reference/license/license-manager.md b/programming/android/api-reference/license/license-manager.md
index 9ed82609..08141e72 100644
--- a/programming/android/api-reference/license/license-manager.md
+++ b/programming/android/api-reference/license/license-manager.md
@@ -29,21 +29,20 @@ class LicenseManager
| [`initLicense`](#initlicense) | Initializes the license for the application using a license key. |
| [`setDeviceFriendlyName`](#setdevicefriendlyname) | Assigns a distinctive name to the device, correlating it with its UUID. |
| [`getDeviceUUID`](#getdeviceuuid) | Returns the unique identifier of the device. |
+| [`isInitLicenseFinished`](#isinitlicensefinished) | Returns whether the license initialization is finished. |
### initLicense
Initializes the license for the application using a license key.
```java
-static void initLicense(String license, @NonNull Context context, LicenseVerificationListener listener);
+static void initLicense(final String license, @Nullable final LicenseVerificationListener listener);
```
**Parameters**
`[in] license`: The license key to be used for initialization.
-`[in] context`: The context that you want to initialize the license.
-
`[in] listener`: A listener object of `LicenseVerificationListener` to monitor the license activation status.
### setDeviceFriendlyName
@@ -69,3 +68,11 @@ static String getDeviceUUID(){}
**Return Value**
The unique identifier of the device.
+
+### isInitLicenseFinished
+
+Returns whether the license initialization is finished.
+
+```java
+static boolean isInitLicenseFinished();
+```
diff --git a/programming/android/api-reference/license/license-verification-listener.md b/programming/android/api-reference/license/license-verification-listener.md
index ea3be83d..b6fd98c5 100644
--- a/programming/android/api-reference/license/license-verification-listener.md
+++ b/programming/android/api-reference/license/license-verification-listener.md
@@ -31,7 +31,7 @@ interface LicenseVerificationListener
The callback triggered when the license verification result is available.
```java
-void onLicenseVerified(boolean isSuccess, Exception error);
+void onLicenseVerified(boolean isSuccess, @Nullable Exception error);
```
**Parameters**
diff --git a/programming/android/api-reference/utility/image-io.md b/programming/android/api-reference/utility/image-io.md
index 62cc44ac..1ebd9b44 100644
--- a/programming/android/api-reference/utility/image-io.md
+++ b/programming/android/api-reference/utility/image-io.md
@@ -36,7 +36,7 @@ class ImageIO
Saves an image to the specified path and format. The desired file format is inferred from the file extension provided in the `path` parameter.
```java
-void saveToFile(ImageData imageData, String path, boolean overWrite) throws UtilityException{}
+void saveToFile(@NonNull ImageData imageData, @NonNull String path, boolean overWrite) throws UtilityException{}
```
**Parameters**
@@ -96,7 +96,7 @@ public void onOriginalImageResultReceived(@NonNull OriginalImageResultItem resul
Saves an image to the memory.
```java
-byte[] SaveToMemory(ImageData imageData, EnumImageFileFormat imageFormat) throws UtilityException{}
+byte[] SaveToMemory(@NonNull ImageData imageData, @EnumImageFileFormat int imageFormat) throws UtilityException{}
```
**Parameters**
@@ -121,7 +121,7 @@ The image bytes.
Reads an image from the specified path and format.
```java
-ImageData readFromFile(String filePath) throws UtilityException{}
+ImageData readFromFile(@NonNull String filePath) throws UtilityException{}
```
**Parameters**
@@ -143,7 +143,7 @@ The image data of type `ImageData`.
Reads an image from the memory.
```java
-ImageData readFromMemory(byte[] fileBytes) throws UtilityException{}
+ImageData readFromMemory(@NonNull byte[] fileBytes) throws UtilityException{}
```
**Parameters**
diff --git a/programming/android/api-reference/utility/image-manager.md b/programming/android/api-reference/utility/image-manager.md
deleted file mode 100644
index 604caf2a..00000000
--- a/programming/android/api-reference/utility/image-manager.md
+++ /dev/null
@@ -1,205 +0,0 @@
----
-layout: default-layout
-title: ImageManager - Dynamsoft Capture Vision Router Module Android Edition API Reference
-description: The class ImageManager of Dynamsoft Capture Vision Router Module is a utility class for managing and manipulating images. It provides functionality for saving images to files and drawing various shapes on images.
-keywords: image manager, Java, Kotlin
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-ignore: true
----
-
-# ImageManager
-
-The `ImageManager` class is a utility class for managing and manipulating images. It provides functionality for saving images to files and drawing various shapes on images.
-
-## Definition
-
-*Namespace:* com.dynamsoft.utility
-
-*Assembly:* DynamsoftCaptureVisionBundle.aar
-
-```java
-class ImageManager
-```
-
-## Methods
-
-| Method | Description |
-| ------ | ----------- |
-| [`saveToFile`](#savetofile) | Saves an image to the specified path and format. |
-| [`drawOnImage(imageData,quads,colour,thickness)`](#drawonimageimagedataquadscolourthickness) | Add quadrilaterals on the image. |
-| [`drawOnImage(imageData,lines,colour,thickness)`](#drawonimageimagedatalinesegmentscolourthickness) | Add lines on the image. |
-| [`drawOnImage(imageData,contours,colour,thickness)`](#drawonimageimagedatacontourscolourthickness) | Add contours on the image. |
-| [`drawOnImage(imageData,corners,colour,thickness)`](#drawonimageimagedatacornerscolourthickness) | Add corners on the image. |
-| [`drawOnImage(imageData,edges,colour,thickness)`](#drawonimageimagedataedgescolourthickness) | Add edges on the image. |
-
-### saveToFile
-
-Saves an image to the specified path and format. The desired file format is inferred from the file extension provided in the `path` parameter.
-
-```java
-void saveToFile(ImageData imageData, String path, boolean overWrite) throws UtilityException{}
-```
-
-**Parameters**
-
-`[in] imageData`: The image to be saved, of type `ImageData`.
-
-`[in] path`: The file path, name and extension name, as a string, under which the image will be saved.
-
-`[in] overWrite`: A flag indicating whether to overwrite the file if it already exists. Defaults to true.
-
-**Exception**
-
-| Error Code | Value | Description |
-| :--------- | :---- | :---------- |
-| EC_NULL_POINTER | -10002 | The ImageData object is null. |
-| EC_FILE_TYPE_NOT_SUPPORTED | -10006 | The file type is not supported. |
-| EC_FILE_ALREADY_EXISTS | -10067 | The file already exists but overwriting is disabled. |
-| EC_CREATE_FILE_FAILED | -10068 | The file path does not exist but cannot be created, or the file cannot be created for any other reason. |
-| EC_IMGAE_DATA_INVALID | -10069 | The input ImageData object contains invalid parameter(s). |
-
-**Return Value**
-
-A boolean value that indicates whether the file is saved successfully.
-
-**Code Snippet**
-
-```java
-@Override
-public void onOriginalImageResultReceived(@NonNull OriginalImageResultItem result) {
- if (result != null)
- {
- ImageManager imageManager = new ImageManager();
- Thread saveThread = new Thread(new Runnable() {
- @Override
- public void run() {
- try {
- imageManager.saveToFile(result.getImageData(), String.valueOf(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_PICTURES))+"/DynamsoftImageManager/originalImage.png", true);
- } catch (UtilityException e) {
- throw new RuntimeException(e);
- } catch (CoreException e) {
- throw new RuntimeException(e);
- } catch (IOException e) {
- throw new RuntimeException(e);
- }
- }
- });
- saveThread.start();
- } else {
- Log.i("CRR", "onOriginalImageResultReceived: Not saved");
- return;
- }
-}
-```
-
-### drawOnImage(imageData,quads,colour,thickness)
-
-Add quadrilaterals on the image.
-
-```java
-ImageData drawOnImage(ImageData imageData, Quadrilateral[] quads, int colour, int thickness){}
-```
-
-**Parameters**
-
-`[in] imageData`: The `ImageData` to modify.
-
-`[in] quads`: An array of `Quadrilateral` objects to be added on the image.
-
-`[in] colour`: An int value as an ARGB colour.
-
-`[in] thickness`: The width of the border.
-
-**Return Value**
-
-The modified `ImageData`.
-
-### drawOnImage(imageData,lineSegments,colour,thickness)
-
-Add lines on the image.
-
-```java
-ImageData drawOnImage(ImageData imageData, LineSegment[] lines, int colour, int thickness){}
-```
-
-**Parameters**
-
-`[in] imageData`: The `ImageData` to modify.
-
-`[in] lineSegments`: An array of `LineSegment` objects to be added on the image.
-
-`[in] colour`: An int value as an ARGB colour.
-
-`[in] thickness`: The width of the lines.
-
-**Return Value**
-
-The modified `ImageData`.
-
-### drawOnImage(imageData,contours,colour,thickness)
-
-Add contours on the image.
-
-```java
-ImageData drawOnImage(ImageData imageData, Contour[] contours, int colour, int thickness){}
-```
-
-**Parameters**
-
-`[in] imageData`: The `ImageData` to modify.
-
-`[in] contours`: An array of `Contour` objects to be added on the image.
-
-`[in] colour`: An int value as an ARGB colour.
-
-`[in] thickness`: The width of the borders.
-
-**Return Value**
-
-The modified `ImageData`.
-
-### drawOnImage(imageData,corners,colour,thickness)
-
-Add corners on the image.
-
-```java
-ImageData drawOnImage(ImageData imageData, Corner[] corners, int colour, int thickness){}
-```
-
-**Parameters**
-
-`[in] imageData`: The `ImageData` to modify.
-
-`[in] corners`: An array of `Corner` objects to be added on the image.
-
-`[in] colour`: An int value as an ARGB colour.
-
-`[in] thickness`: The width of the lines.
-
-**Return Value**
-
-The modified `ImageData`.
-
-### drawOnImage(imageData,edges,colour,thickness)
-
-Add edges on the image.
-
-```java
-ImageData drawOnImage(ImageData imageData, Edge[] edges, int colour, int thickness){}
-```
-
-**Parameters**
-
-`[in] imageData`: The `ImageData` to modify.
-
-`[in] edges`: An array of `Edge` objects to be added on the image.
-
-`[in] colour`: An int value as an ARGB colour.
-
-`[in] thickness`: The width of the lines.
-
-**Return Value**
-
-The modified `ImageData`.
diff --git a/programming/android/api-reference/utility/image-processor.md b/programming/android/api-reference/utility/image-processor.md
index 218cc2d6..6ee540e0 100644
--- a/programming/android/api-reference/utility/image-processor.md
+++ b/programming/android/api-reference/utility/image-processor.md
@@ -62,7 +62,7 @@ The cropped `ImageData`.
Crops and deskews an image based on the provided quadrilateral and additional information.
```java
-public ImageData cropAndDeskewImage(CImageData imageData, CQuadrilateral quad, int dstWidth, int dstHeight, int padding) throws UtilityException{}
+public ImageData cropAndDeskewImage(ImageData imageData, Quadrilateral quad, int dstWidth, int dstHeight, int padding) throws UtilityException{}
```
### cropAndDeskewImage(imageData,quad)
@@ -70,7 +70,7 @@ public ImageData cropAndDeskewImage(CImageData imageData, CQuadrilateral quad, i
Crops and deskews an image based on the provided quadrilateral. The arguments dstWidth, dstHeight, and padding are set to 0.
```java
-public ImageData cropAndDeskewImage(CImageData imageData, CQuadrilateral quad) throws UtilityException{}
+public ImageData cropAndDeskewImage(ImageData imageData, Quadrilateral quad) throws UtilityException{}
```
### adjustBrightness
@@ -78,7 +78,7 @@ public ImageData cropAndDeskewImage(CImageData imageData, CQuadrilateral quad) t
Adjusts the brightness of an image.
```java
-ImageData adjustBrightness(ImageData imageData, int brightness){}
+ImageData adjustBrightness(ImageData imageData, @IntRange(from = -100, to = 100) int brightness){}
```
**Parameters**
@@ -96,7 +96,7 @@ The modified `ImageData`.
Adjusts the contrast of an image.
```java
-ImageData adjustContrast(ImageData imageData, int contrast){}
+ImageData adjustContrast(ImageData imageData, @IntRange(from = -100, to = 100) int contrast){}
```
**Parameters**
@@ -114,7 +114,7 @@ The modified `ImageData`.
Applies a filter to an image.
```java
-ImageData filterImage(ImageData imageData, EnumFilterType filterType){}
+ImageData filterImage(ImageData imageData, @EnumFilterType int filterType){}
```
**Parameters**
@@ -148,7 +148,7 @@ The converted grayscale `ImageData`.
Converts an image to grayscale.
```java
-ImageData convertToGray(ImageData imageData, float r, float g, float b){}
+ImageData convertToGray(ImageData imageData, @FloatRange(from = 0, to = 1) float r, @FloatRange(from = 0, to = 1) float g, @FloatRange(from = 0, to = 1) float b){}
```
**Parameters**
@@ -186,7 +186,7 @@ The converted binary `ImageData`.
Converts an image to binary using a global threshold.
```java
-ImageData convertToBinaryGlobal(ImageData imageData, int threshold, boolean invert){}
+ImageData convertToBinaryGlobal(ImageData imageData, @IntRange(from = -1, to = 255) int threshold, boolean invert){}
```
**Parameters**
diff --git a/programming/android/api-reference/utility/multi-frame-result-cross-filter.md b/programming/android/api-reference/utility/multi-frame-result-cross-filter.md
index 7d3eeaf1..4b18237e 100644
--- a/programming/android/api-reference/utility/multi-frame-result-cross-filter.md
+++ b/programming/android/api-reference/utility/multi-frame-result-cross-filter.md
@@ -26,6 +26,7 @@ class MultiFrameResultCrossFilter implements CapturedResultFilter
| Method | Description |
| ------ | ----------- |
+| [`MultiFrameResultCrossFilter`](#multiframeresultcrossfilter-1) | The constructor. |
| [`enableLatestOverlapping`](#enablelatestoverlapping) | Enables or disables the to-the-latest overlapping feature of one or multiple specific result item types. This feature can sharpenly increase the read-rate performance when decoding multiple barcodes under the video streaming. |
| [`enableResultCrossVerification`](#enableresultcrossverification) | Enables or disables the verification of one or multiple specific result item types. |
| [`enableResultDeduplication`](#enableresultdeduplication) | Enables or disables the deduplication process for one or multiple specific result item types. |
@@ -37,26 +38,20 @@ class MultiFrameResultCrossFilter implements CapturedResultFilter
| [`setDuplicateForgetTime`](#setduplicateforgettime) | Sets the interval during which duplicates are disregarded for specific result item types. |
| [`setMaxOverlappingFrames`](#setmaxoverlappingframes) | Set the maximum overlapping frames count for a given result item type. |
-### enableLatestOverlapping
+### MultiFrameResultCrossFilter
-Enables or disables the to-the-latest overlapping feature of one or multiple specific result item types. This feature can sharpenly increase the read-rate performance when decoding multiple barcodes under the video streaming.
+The constructor.
```java
-void enableLatestOverlapping(@EnumCapturedResultItemType int type, boolean enable);
+MultiFrameResultCrossFilter();
```
-**Parameters**
-
-`[in] type`: Specifies the result item type with [`EnumCapturedResultItemType`]({{ site.dcv_android_api }}core/enum/captured-result-item-type.html?lang=android).
-
-`[in] enable`: Boolean to toggle to-the-latest overlapping on or off.
-
### enableResultCrossVerification
Enables or disables the verification of one or multiple specific result item types.
```java
-void enableResultCrossVerification(@EnumCapturedResultItemType int resultItemTypes, bool enable);
+void enableResultCrossVerification(@EnumCapturedResultItemType int resultItemTypes, boolean enable);
```
**Parameters**
@@ -65,12 +60,28 @@ void enableResultCrossVerification(@EnumCapturedResultItemType int resultItemTyp
`[in] enable`: Boolean to toggle verification on or off.
+### isResultCrossVerificationEnabled
+
+Checks if verification is active for a given result item type.
+
+```java
+boolean isResultCrossVerificationEnabled(@EnumCapturedResultItemType int type);
+```
+
+**Parameters**
+
+`[in] type`: Specifies the result item type with [`EnumCapturedResultItemType`]({{ site.dcv_android_api }}core/enum/captured-result-item-type.html?lang=android).
+
+**Return Value**
+
+Boolean indicating the status of verification for the specified type.
+
### enableResultDeduplication
Enables or disables the deduplication process for one or multiple specific result item types.
```java
-void enableResultDeduplication(@EnumCapturedResultItemType int resultItemTypes, bool enable);
+void enableResultDeduplication(@EnumCapturedResultItemType int resultItemTypes, boolean enable);
```
**Parameters**
@@ -79,12 +90,12 @@ void enableResultDeduplication(@EnumCapturedResultItemType int resultItemTypes,
`[in] enable`: Boolean to toggle deduplication on or off.
-### getDuplicateForgetTime
+### isResultDeduplicationEnabled
-Gets the interval during which duplicates are disregarded for a given result item type.
+Checks if deduplication is active for a given result item type.
```java
-int getDuplicateForgetTime(@EnumCapturedResultItemType int type);
+boolean isResultDeduplicationEnabled(@EnumCapturedResultItemType int type);
```
**Parameters**
@@ -93,30 +104,28 @@ int getDuplicateForgetTime(@EnumCapturedResultItemType int type);
**Return Value**
-The set interval for the specified item type.
+Boolean indicating the deduplication status for the specified type.
-### getMaxOverlappingFrames
+### setDuplicateForgetTime
-Get the maximum overlapping frames count for a given result item type.
+Sets the interval during which duplicates are disregarded for a given result item type.
```java
-int getMaxOverlappingFrames(@EnumCapturedResultItemType int type);
+void setDuplicateForgetTime(@EnumCapturedResultItemType int resultItemTypes, int time);
```
**Parameters**
-`[in] type`: Specifies the result item type with [`EnumCapturedResultItemType`]({{ site.dcv_android_api }}core/enum/captured-result-item-type.html?lang=android).
-
-**Return Value**
+`[in] type`: Specifies one or multiple specific result item types, which can be defined using [`EnumCapturedResultItemType`]({{ site.dcv_android_api }}core/enum/captured-result-item-type.html?lang=android).
-The maximum overlapping frame count for the overlapping.
+`[in] time`: Time in milliseconds during which duplicates are disregarded.
-### isLatestOverlappingEnabled
+### getDuplicateForgetTime
-Checks if to-the-latest overlapping is active for a given result item type.
+Gets the interval during which duplicates are disregarded for a given result item type.
```java
-boolean isLatestOverlappingEnabled(@EnumCapturedResultItemType int type);
+int getDuplicateForgetTime(@EnumCapturedResultItemType int type);
```
**Parameters**
@@ -125,30 +134,28 @@ boolean isLatestOverlappingEnabled(@EnumCapturedResultItemType int type);
**Return Value**
-Boolean indicating the to-the-latest overlapping status for the specified type.
+The set interval for the specified item type.
-### isResultDeduplicationEnabled
+### enableLatestOverlapping
-Checks if deduplication is active for a given result item type.
+Enables or disables the to-the-latest overlapping feature of one or multiple specific result item types. This feature can sharpenly increase the read-rate performance when decoding multiple barcodes under the video streaming.
```java
-boolean isResultDeduplicationEnabled(@EnumCapturedResultItemType int type);
+void enableLatestOverlapping(@EnumCapturedResultItemType int resultItemTypes, boolean enable);
```
**Parameters**
`[in] type`: Specifies the result item type with [`EnumCapturedResultItemType`]({{ site.dcv_android_api }}core/enum/captured-result-item-type.html?lang=android).
-**Return Value**
-
-Boolean indicating the deduplication status for the specified type.
+`[in] enable`: Boolean to toggle to-the-latest overlapping on or off.
-### isResultCrossVerificationEnabled
+### isLatestOverlappingEnabled
-Checks if verification is active for a given result item type.
+Checks if to-the-latest overlapping is active for a given result item type.
```java
-boolean isResultCrossVerificationEnabled(@EnumCapturedResultItemType int type);
+boolean isLatestOverlappingEnabled(@EnumCapturedResultItemType int type);
```
**Parameters**
@@ -157,35 +164,37 @@ boolean isResultCrossVerificationEnabled(@EnumCapturedResultItemType int type);
**Return Value**
-Boolean indicating the status of verification for the specified type.
+Boolean indicating the to-the-latest overlapping status for the specified type.
-### setDuplicateForgetTime
+### setMaxOverlappingFrames
-Sets the interval during which duplicates are disregarded for a given result item type.
+Set the maximum overlapping frames count for a given result item type. You can set it higher if:
+
+- You capture device is stationary or moving stably.
+- You want to further improve the read-rate.
```java
-void setDuplicateForgetTime(@EnumCapturedResultItemType int resultItemTypes, int time);
+void setMaxOverlappingFrames(@EnumCapturedResultItemType int resultItemTypes, int maxFramesToCheck);
```
**Parameters**
-`[in] type`: Specifies one or multiple specific result item types, which can be defined using [`EnumCapturedResultItemType`]({{ site.dcv_android_api }}core/enum/captured-result-item-type.html?lang=android).
-
-`[in] time`: Time in milliseconds during which duplicates are disregarded.
+`[in] type`: Specifies the result item type with [`EnumCapturedResultItemType`]({{ site.dcv_android_api }}core/enum/captured-result-item-type.html?lang=android).
-### setMaxOverlappingFrames
+`[in] maxOverlappingFrames`: The maximum overlapping frame count for the overlapping.
-Set the maximum overlapping frames count for a given result item type. You can set it higher if:
+### getMaxOverlappingFrames
-- You capture device is stationary or moving stably.
-- You want to further improve the read-rate.
+Get the maximum overlapping frames count for a given result item type.
```java
-void setMaxOverlappingFrames(@EnumCapturedResultItemType int type, int maxOverlappingFrames);
+int getMaxOverlappingFrames(@EnumCapturedResultItemType int type);
```
**Parameters**
`[in] type`: Specifies the result item type with [`EnumCapturedResultItemType`]({{ site.dcv_android_api }}core/enum/captured-result-item-type.html?lang=android).
-`[in] maxOverlappingFrames`: The maximum overlapping frame count for the overlapping.
+**Return Value**
+
+The maximum overlapping frame count for the overlapping.
diff --git a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/capture-state-listener.md b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/capture-state-listener.md
index b2c4c72f..5edbff61 100644
--- a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/capture-state-listener.md
+++ b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/capture-state-listener.md
@@ -55,18 +55,3 @@ func onCapturedStateChanged(_ state: DSCaptureState)
**Parameters**
`state`: One of the `DSCaptureState` value that indicates the capture state.
-
-**Code Snippet**
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-[self.delegate onCapturedStateChanged:state];
-```
-2.
-```swift
-delegate?.onCapturedStateChanged(state)
-```
\ No newline at end of file
diff --git a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/captured-result-filter.md b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/captured-result-filter.md
index ff891941..4b618034 100644
--- a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/captured-result-filter.md
+++ b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/captured-result-filter.md
@@ -51,7 +51,7 @@ The method for monitoring the output of [`DSOriginalImageResultItem`]({{ site.dc
```
2.
```swift
-func onOriginalImageResultReceived(_ result: DSOriginalImageResultItem)
+func onOriginalImageResultReceived(_ result: OriginalImageResultItem)
```
**Parameters**
@@ -72,7 +72,7 @@ The method for monitoring the output of [DSDecodedBarcodesResult]({{ site.dbr_io
```
2.
```swift
-func onDecodedBarcodesReceived(_ result: DSDecodedBarcodesResult)
+func onDecodedBarcodesReceived(_ result: DecodedBarcodesResult)
```
**Parameters**
@@ -93,7 +93,7 @@ The method for monitoring the output of [DSRecognizedTextLinesResult]({{ site.dl
```
2.
```swift
-func onRecognizedTextLinesReceived(_ result: DSRecognizedTextLinesResult)
+func onRecognizedTextLinesReceived(_ result: RecognizedTextLinesResult)
```
**Parameters**
@@ -135,7 +135,7 @@ The method for monitoring the output of [DSParsedResult]({{ site.dcp_ios_api }}p
```
2.
```swift
-func onParsedResultsReceived(_ result: DSParsedResult)
+func onParsedResultsReceived(_ result: ParsedResult)
```
**Parameters**
diff --git a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/captured-result-receiver.md b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/captured-result-receiver.md
index 5c4836e4..86487b48 100644
--- a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/captured-result-receiver.md
+++ b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/captured-result-receiver.md
@@ -55,7 +55,7 @@ The callback method triggered when a generic captured result is available, occur
```
2.
```swift
-func onCapturedResultReceived(_ result: DSCapturedResult)
+func onCapturedResultReceived(_ result: CapturedResult)
```
**Parameters**
@@ -76,7 +76,7 @@ The callback method triggered when the original image result is available, occur
```
2.
```swift
-func onOriginalImageResultReceived(_ result: DSOriginalImageResultItem)
+func onOriginalImageResultReceived(_ result: OriginalImageResultItem)
```
**Parameters**
@@ -95,9 +95,9 @@ The callback triggered when decoded barcodes are available, occurring each time
```objc
- (void)onDecodedBarcodesReceived:(DSDecodedBarcodesResult*)result;
```
-1.
+2.
```swift
-func onDecodedBarcodesReceived(_ result: DSDecodedBarcodesResult)
+func onDecodedBarcodesReceived(_ result: DecodedBarcodesResult)
```
**Parameters**
@@ -116,9 +116,9 @@ The callback triggered when recognized text lines are available, occurring each
```objc
- (void)onRecognizedTextLinesReceived:(DSRecognizedTextLinesResult*)result;
```
-1.
+2.
```swift
-func onRecognizedTextLinesReceived(_ result: DSRecognizedTextLinesResult)
+func onRecognizedTextLinesReceived(_ result: RecognizedTextLinesResult)
```
**Parameters**
@@ -158,9 +158,9 @@ The callback triggered when parsed results are available, occurring each time an
```objc
- (void)onParsedResultsReceived:(DSParsedResult*)result;
```
-1.
+2.
```swift
-func onParsedResultsReceived(_ result: DSParsedResult)
+func onParsedResultsReceived(_ result: ParsedResult)
```
**Parameters**
diff --git a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/captured-result.md b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/captured-result.md
index ab07434b..8d03e897 100644
--- a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/captured-result.md
+++ b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/captured-result.md
@@ -59,7 +59,7 @@ An array of [DSCapturedResultItem]({{ site.dcv_ios_api }}core/basic-structures/c
>
>1.
```objc
-@property(nonatomic, strong, nullable, readonly) NSArray *items;
+@property (nonatomic, readonly, copy, nullable) NSArray *items;
```
2.
```swift
diff --git a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/image-source-state-listener.md b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/image-source-state-listener.md
index 538adfdd..4dcbdc15 100644
--- a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/image-source-state-listener.md
+++ b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/image-source-state-listener.md
@@ -49,7 +49,7 @@ The methods for monitoring the state of the ImageSourceAdapter.
```
2.
```swift
-func onImageSourceStateReceived(_ state: DSImageSourceState)
+func onImageSourceStateReceived(_ state: ImageSourceState)
```
**Parameters**
@@ -68,5 +68,5 @@ func onImageSourceStateReceived(_ state: DSImageSourceState)
```
2.
```swift
-stateListener.onImageSourceStateReceived(DSImageSourceState.connected)
+stateListener.onImageSourceStateReceived(ImageSourceState.connected)
```
diff --git a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-manager.md b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-manager.md
index a08a9635..55c9a1e7 100644
--- a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-manager.md
+++ b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-manager.md
@@ -48,7 +48,7 @@ Adds a [DSIntermediateResultReceiver](intermediate-result-receiver.md) object as
>
>1.
```objc
-- (BOOL)addResultReceiver:(id)receiver;
+- (void)addResultReceiver:(id)receiver;
```
2.
```swift
@@ -88,7 +88,7 @@ Removes the specified [DSIntermediateResultReceiver](intermediate-result-receive
>
>1.
```objc
-- (BOOL)removeResultReceiver:(id)receiver;
+- (void)removeResultReceiver:(id)receiver;
```
2.
```swift
diff --git a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md
index 7e6d69e2..cdc43e64 100644
--- a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md
+++ b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md
@@ -79,7 +79,7 @@ Get the observed parameters of the intermediate result receiver.
>
>1.
```objc
--(ObservationParameters *)getObservationParameters;
+-(DSObservationParameters *)getObservationParameters;
```
2.
```swift
@@ -100,7 +100,7 @@ The callback triggered when the processing of a target ROI is finished.
>
>1.
```objc
--(void)onTargetROIResultsReceived:(IntermediateResult *)unit
+-(void)onTargetROIResultsReceived:(DSIntermediateResult *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
@@ -118,7 +118,7 @@ The callback triggered when the processing of a task is finished.
>
>1.
```objc
--(void)onTaskResultsReceived:(IntermediateResult *)unit
+-(void)onTaskResultsReceived:(DSIntermediateResult *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
@@ -142,8 +142,8 @@ The callback triggered when pre-detected regions are received.
>
>1.
```objc
--(void)onPredetectedRegionsReceived:(PredetectedRegionsUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onPredetectedRegionsReceived:(DSPredetectedRegionsUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -166,8 +166,8 @@ The callback triggered when localized barcodes are received.
>
>1.
```objc
--(void)onLocalizedBarcodesReceived:(LocalizedBarcodesUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onLocalizedBarcodesReceived:(DSLocalizedBarcodesUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -190,8 +190,8 @@ The callback triggered when decoded barcodes are received.
>
>1.
```objc
--(void)onDecodedBarcodesReceived:(DecodedBarcodesUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onDecodedBarcodesReceived:(DSDecodedBarcodesUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -214,8 +214,8 @@ The callback triggered when localized text lines are received.
>
>1.
```objc
--(void)onLocalizedTextLinesReceived:(LocalizedTextLinesUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onLocalizedTextLinesReceived:(DSLocalizedTextLinesUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -238,8 +238,8 @@ The callback triggered when recognized text lines are received.
>
>1.
```objc
--(void)onRecognizedTextLinesReceived:(RecognizedTextLinesUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onRecognizedTextLinesReceived:(DSRecognizedTextLinesUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -262,8 +262,8 @@ The callback triggered when detected quads are received.
>
>1.
```objc
--(void)onDetectedQuadsReceived:(DetectedQuadsUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onDetectedQuadsReceived:(DSDetectedQuadsUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -286,8 +286,8 @@ The callback triggered when deskewed images are received.
>
>1.
```objc
--(void)onDeskewedImagesReceived:(DeskewedImagesUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onDeskewedImagesReceived:(DSDeskewedImagesUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -310,8 +310,8 @@ The callback triggered when enhanced images are received.
>
>1.
```objc
--(void)onEnhancedImagesReceived:(EnhancedImagesUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onEnhancedImagesReceived:(DSEnhancedImagesUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -334,8 +334,8 @@ The callback triggered when colour images are received.
>
>1.
```objc
--(void)onColourImageUnitReceived:(ColourImageUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onColourImageUnitReceived:(DSColourImageUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -358,8 +358,8 @@ The callback triggered when up or down scaled colour images are received.
>
>1.
```objc
--(void)onScaledColourImageUnitReceived:(ScaledColourImageUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onScaledColourImageUnitReceived:(DSScaledColourImageUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
1.
```swift
@@ -382,8 +382,8 @@ The callback triggered when grayscale images are received.
>
>1.
```objc
--(void)onGrayscaleImageUnitReceived:(GrayscaleImageUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onGrayscaleImageUnitReceived:(DSGrayscaleImageUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -406,8 +406,8 @@ The callback triggered when transformed grayscale images are received.
>
>1.
```objc
--(void)onTransformedGrayscaleImageUnitReceived:(TransformedGrayscaleImageUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onTransformedGrayscaleImageUnitReceived:(DSTransformedGrayscaleImageUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -430,8 +430,8 @@ The callback triggered when enhanced grayscale images are received.
>
>1.
```objc
--(void)onEnhancedGrayscaleImageUnitReceived:(EnhancedGrayscaleImageUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onEnhancedGrayscaleImageUnitReceived:(DSEnhancedGrayscaleImageUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -454,8 +454,8 @@ The callback triggered when binary images are received.
>
>1.
```objc
--(void)onBinaryImageUnitReceived:(BinaryImageUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onBinaryImageUnitReceived:(DSBinaryImageUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -478,8 +478,8 @@ The callback triggered when texture detection results are received.
>
>1.
```objc
--(void)onTextureDetectionResultUnitReceived:(TextureDetectionResultUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onTextureDetectionResultUnitReceived:(DSTextureDetectionResultUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -502,8 +502,8 @@ The callback triggered when texture removed grayscale images are received.
>
>1.
```objc
--(void)onTextureRemovedGrayscaleImageUnitReceived:(TextureRemovedGrayscaleImageUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onTextureRemovedGrayscaleImageUnitReceived:(DSTextureRemovedGrayscaleImageUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -526,8 +526,8 @@ The callback triggered when texture removed binary images are received.
>
>1.
```objc
--(void)onTextureRemovedBinaryImageUnitReceived:(TextureRemovedBinaryImageUnit *)unit
- info:(IntermediateResultExtraInfo *)info
+-(void)onTextureRemovedBinaryImageUnitReceived:(DSTextureRemovedBinaryImageUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -550,7 +550,7 @@ The callback triggered when contours are received.
>
>1.
```objc
--(void)onContoursUnitReceived:(ContoursUnit *)unit
+-(void)onContoursUnitReceived:(DSContoursUnit *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
@@ -598,7 +598,7 @@ The callback triggered when line segments are received.
>
>1.
```objc
--(void)onLineSegmentsUnitReceived:(LineSegmentsUnit *)unit
+-(void)onLineSegmentsUnitReceived:(DSLineSegmentsUnit *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
@@ -622,7 +622,7 @@ The callback triggered when text zones are received.
>
>1.
```objc
--(void)onTextZonesUnitReceived:(TextZonesUnit *)unit
+-(void)onTextZonesUnitReceived:(DSTextZonesUnit *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
@@ -646,7 +646,7 @@ The callback triggered when text removed binary images are received.
>
>1.
```objc
--(void)onTextRemovedBinaryImageUnitReceived:(TextRemovedBinaryImageUnit *)unit
+-(void)onTextRemovedBinaryImageUnitReceived:(DSTextRemovedBinaryImageUnit *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
@@ -670,8 +670,8 @@ The callback triggered when logic lines are received.
>
>1.
```objc
--(void)onLogicLinesUnitReceived:(LogicLinesUnit *)unit
- info:(DSIntermediateResultExtraInfo *)info
+-(void)onLogicLinesUnitReceived:(DSLogicLinesUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -694,7 +694,7 @@ The callback triggered when long lines are received.
>
>1.
```objc
--(void)onLongLinesUnitReceived:(LongLinesUnit *)unit
+-(void)onLongLinesUnitReceived:(DSLongLinesUnit *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
@@ -718,7 +718,7 @@ The callback triggered when corners are received.
>
>1.
```objc
--(void)onCornersUnitReceived:(CornersUnit *)unit
+-(void)onCornersUnitReceived:(DSCornersUnit *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
@@ -742,7 +742,7 @@ The callback triggered when candidate quad edges are received.
>
>1.
```objc
--(void)onCandidateQuadEdgesUnitReceived:(CandidateQuadEdgesUnit *)unit
+-(void)onCandidateQuadEdgesUnitReceived:(DSCandidateQuadEdgesUnit *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
@@ -766,7 +766,7 @@ The callback triggered when candidate barcode zones are received.
>
>1.
```objc
--(void)onCandidateBarcodeZonesUnitReceived:(CandidateBarcodeZonesUnit *)unit
+-(void)onCandidateBarcodeZonesUnitReceived:(DSCandidateBarcodeZonesUnit *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
@@ -790,8 +790,8 @@ The callback triggered when scaled up barcode images are received.
>
>1.
```objc
--(void)onScaledBarcodeImageUnitReceived:(ScaledBarcodeImageUnit *)unit
- info:(DSIntermediateResultExtraInfo *)info
+-(void)onScaledBarcodeImageUnitReceived:(DSScaledBarcodeImageUnit *)unit
+ info:(DSIntermediateResultExtraInfo *)info
```
2.
```swift
@@ -814,7 +814,7 @@ The callback triggered when deformation resisted barcode images are received.
>
>1.
```objc
--(void)onDeformationResistedBarcodeImageUnitReceived:(DeformationResistedBarcodeImageUnit *)unit
+-(void)onDeformationResistedBarcodeImageUnitReceived:(DSDeformationResistedBarcodeImageUnit *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
@@ -838,7 +838,7 @@ The callback triggered when complemented barcode images are received.
>
>1.
```objc
--(void)onComplementedBarcodeImageUnitReceived:(ComplementedBarcodeImageUnit *)unit
+-(void)onComplementedBarcodeImageUnitReceived:(DSComplementedBarcodeImageUnit *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
@@ -862,7 +862,7 @@ The callback triggered when a raw text lines unit is received.
>
>1.
```objc
--(void)onRawTextLinesUnitReceived:(RawTextLinesUnit *)unit
+-(void)onRawTextLinesUnitReceived:(DSRawTextLinesUnit *)unit
info:(DSIntermediateResultExtraInfo *)info
```
2.
diff --git a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.md b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.md
index 765cdd38..d885b5d3 100644
--- a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.md
+++ b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.md
@@ -77,11 +77,11 @@ Specifies the region of interest (ROI) of the image or frame where the capture a
>
>1.
```objc
-@property (nonatomic, strong, nullable) DSQuadrilateral *roi;
+@property (nonatomic, nullable) DSQuadrilateral *roi;
```
2.
```swift
-var roi: DSQuadrilateral? { get set }
+var roi: Quadrilateral? { get set }
```
### roiMeasuredInPercentage
@@ -166,11 +166,11 @@ Specifies the settings for the `DynamsoftBarcodeReader` task with a [`Simplified
>
>1.
```objc
-@property (nonatomic, strong, nullable) DSSimplifiedBarcodeReaderSettings *barcodeSettings;
+@property (nonatomic, nullable) DSSimplifiedBarcodeReaderSettings *barcodeSettings;
```
2.
```swift
-var barcodeSettings: DSSimplifiedBarcodeReaderSettings? { get set }
+var barcodeSettings: SimplifiedBarcodeReaderSettings? { get set }
```
### labelSettings
@@ -183,11 +183,11 @@ Specifies the settings for the `DynamsoftLabelRecognizer` task with a [`Simplifi
>
>1.
```objc
-@property (nonatomic, strong, nullable) DSSimplifiedLabelRecognizerSettings *labelSettings;
+@property (nonatomic, nullable) DSSimplifiedLabelRecognizerSettings *labelSettings;
```
2.
```swift
-var labelSettings: DSSimplifiedLabelRecognizerSettings? { get set }
+var labelSettings: SimplifiedLabelRecognizerSettings? { get set }
```
### documentSettings
@@ -200,9 +200,9 @@ Specifies the settings for the `DynamsoftDocumentNormalizer` task with a [`Simpl
>
>1.
```objc
-@property (nonatomic, strong, nullable) DSSimplifiedDocumentNormalizerSettings *documentSettings;
+@property (nonatomic, nullable) DSSimplifiedDocumentNormalizerSettings *documentSettings;
```
2.
```swift
-var documentSettings: DSSimplifiedDocumentNormalizerSettings? { get set }
+var documentSettings: SimplifiedDocumentNormalizerSettings? { get set }
```
diff --git a/programming/ios/api-reference/capture-vision-router/capture-vision-router.md b/programming/ios/api-reference/capture-vision-router/capture-vision-router.md
index ea36a2fd..90ec81e2 100644
--- a/programming/ios/api-reference/capture-vision-router/capture-vision-router.md
+++ b/programming/ios/api-reference/capture-vision-router/capture-vision-router.md
@@ -52,16 +52,20 @@ class CaptureVisionRouter : NSObject
| [`getInput`](multiple-file-processing.md#getinput) | Returns the image source object. |
| [`addImageSourceStateListener`](multiple-file-processing.md#addimagesourcestatelistener) | Registers a DSImageSourceStateListener to get callback when the status of DSImageSourceAdapter changes. |
| [`removeImageSourceStateListener`](multiple-file-processing.md#removeimagesourcestatelistener) | Removes a DSImageSourceStateListener. |
+| [`removeAllImageSourceStateListeners`](#removeallimagesourcestatelisteners) | Removes all user-added [`ImageSourceStateListeners`](auxiliary-classes/image-source-state-listener.html). |
| [`addResultReceiver`](multiple-file-processing.md#addresultreceiver) | Registers a DSCapturedResultReceiver to get callback when DSCapturedResult output. |
| [`removeResultReceiver`](multiple-file-processing.md#removeresultreceiver) | Removes a DSCapturedResultReceiver. |
+| [`removeAllResultReceivers`](#removeallresultreceivers) | Removes all user-added [`CapturedResultReceivers`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html). |
| [`startCapturing`](multiple-file-processing.md#startcapturing) | Initiates a capturing process based on a specified template. This process is repeated for each image fetched from the source. |
| [`stopCapturing`](multiple-file-processing.md#stopcapturing) | Stops the capturing process. |
| [`pauseCapturing`](multiple-file-processing.md#pausecapturing) | Pauses the Capture Vision Router. |
| [`resumeCapturing`](multiple-file-processing.md#resumecapturing) | Resumes the Capture Vision Router. |
| [`addCaptureStateListener`](multiple-file-processing.md#addcapturestatelistener) | Registers a DSCaptureStateListener to get callback when capture state changes. |
| [`removeCaptureStateListener`](multiple-file-processing.md#removecapturestatelistener) | Removes a DSCaptureStateListener. |
+| [`removeAllCaptureStateListeners`](#removeallcapturestatelisteners) | Removes all user-added [`CaptureStateListeners`](auxiliary-classes/capture-state-listener.html). |
| [`addResultFilter`](multiple-file-processing.md#addresultfilter) | Adds a `CaptureResultFilter` object to filter non-essential results. |
| [`removeResultFilter`](multiple-file-processing.md#removeresultfilter) | Removes the specified `CaptureResultFilter` object. |
+| [`removeAllResultFilters`](#removeallresultfilters) | Removes all user-added `CapturedResultFilters`. |
| [`switchCapturingTemplate`](multiple-file-processing.md#switchcapturingtemplate) | Switch the image processing settings with the CaptureVisionTemplate name during the image processing workflow. |
## Settings
@@ -77,9 +81,16 @@ class CaptureVisionRouter : NSObject
| [`outputSettingsToFile`](settings.md#outputsettingstofile) | Output the targeting Capture Vision settings to a JSON file. |
| [`clearDLModelBuffers`](settings.md#cleardlmodelbuffers) | Clear the buffered deep learning models to release the memory. |
| [`setGlobalIntraOpNumThreads`](settings.md#setglobalintraopnumthreads) | Sets the global number of threads used internally for model execution. |
+| [`getTemplateNames`](#gettemplatenames) | Retrieves the names of all the currently available templates. |
## Intermediate Result
| Method | Description |
| ------ | ----------- |
| [`getIntermediateResultManager`](intermediate-result.md#getintermediateresultmanager) | Gets the object of `IntermediateResultManager`. |
+
+## Buffered Items
+
+| Method | Description |
+| ------ | ----------- |
+| [`getBufferedItemsManager`](buffered-items.md#getbuffereditemsmanager) | Gets the object of `BufferedItemsManager`. |
diff --git a/programming/ios/api-reference/capture-vision-router/enum/capture-state.md b/programming/ios/api-reference/capture-vision-router/enum/capture-state.md
index e417b3f2..8453e6a9 100644
--- a/programming/ios/api-reference/capture-vision-router/enum/capture-state.md
+++ b/programming/ios/api-reference/capture-vision-router/enum/capture-state.md
@@ -24,7 +24,9 @@ typedef NS_ENUM(NSInteger, DSCaptureState)
/** The data capturing is started. */
DSCaptureStateStarted,
/** The data capturing is stopped. */
- DSCaptureStateStopped
+ DSCaptureStateStopped,
+ /** The data capturing is paused. */
+ DSCaptureStatePaused
};
```
>
@@ -35,5 +37,7 @@ public enum CaptureState : Int
started
/** The data capturing is stopped. */
stopped
+ /** The data capturing is paused. */
+ paused
};
```
diff --git a/programming/ios/api-reference/capture-vision-router/multiple-file-processing.md b/programming/ios/api-reference/capture-vision-router/multiple-file-processing.md
index bedfaa94..41c432e4 100644
--- a/programming/ios/api-reference/capture-vision-router/multiple-file-processing.md
+++ b/programming/ios/api-reference/capture-vision-router/multiple-file-processing.md
@@ -43,12 +43,12 @@ Sets an image source that will provide images to be consecutively processed.
>
>1.
```objc
-- (BOOL)setInput:(DSImageSourceAdapter *)adapter
+- (BOOL)setInput:(nullable DSImageSourceAdapter *)adapter
error:(NSError * _Nullable * _Nullable)error;
```
2.
```swift
-func setInput(_ adapter: DSImageSourceAdapter) throws -> BOOL
+func setInput(_ adapter: ImageSourceAdapter) throws -> BOOL
```
**Parameters**
@@ -76,11 +76,11 @@ Gets the attached image source adapter (`DSImageSourceAdapter`) object of the Ca
>
>1.
```objc
-- (DSImageSourceAdapter *)getInput;
+- (nullable DSImageSourceAdapter *)getInput;
```
2.
```swift
-func getInput() -> DSImageSourceAdapter
+func getInput() -> ImageSourceAdapter
```
**Return Value**
@@ -97,21 +97,17 @@ Registers a `DSImageSourceStateListener` object to be used as a callback when th
>
>1.
```objc
-- (BOOL)addImageSourceStateListener:(id)listener;
+- (void)addImageSourceStateListener:(id)listener;
```
2.
```swift
-func addImageSourceStateListener(_ listener:DSImageSourceStateListener) -> BOOL
+func addImageSourceStateListener(_ listener:ImageSourceStateListener)
```
**Parameters**
`listener`: An object of [`DSImageSourceStateListener`](auxiliary-classes/image-source-state-listener.md).
-**Return Value**
-
-A BOOL value that indicates whether the `DSImageSourceStateListener` is added successfully.
-
## removeImageSourceStateListener
Removes a `DSImageSourceStateListener` from the Capture Vision Router.
@@ -122,21 +118,17 @@ Removes a `DSImageSourceStateListener` from the Capture Vision Router.
>
>1.
```objc
-- (BOOL)removeImageSourceStateListener:(id)listener;
+- (void)removeImageSourceStateListener:(id)listener;
```
2.
```swift
-func removeImageSourceStateListener(_ listener:DSImageSourceStateListener) -> BOOL
+func removeImageSourceStateListener(_ listener:ImageSourceStateListener)
```
**Parameters**
`listener`: An object of `DSImageSourceStateListener`.
-**Return Value**
-
-A BOOL value that indicates whether the `DSImageSourceStateListener` is removed successfully.
-
## removeAllImageSourceStateListeners
Removes all user-added `DSImageSourceStateListeners`.
@@ -147,7 +139,7 @@ Removes all user-added `DSImageSourceStateListeners`.
>
>1.
```objc
-- (BOOL)removeAllImageSourceStateListeners;
+- (void)removeAllImageSourceStateListeners;
```
2.
```swift
@@ -164,24 +156,20 @@ Adds a [`CapturedResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/au
>
>1.
```objc
-- (BOOL)addResultReceiver:(id)receiver;
+- (void)addResultReceiver:(id)receiver;
```
2.
```swift
-func addResultReceiver(_ listener:DSCapturedResultReceiver) -> BOOL
+func addResultReceiver(_ listener:CapturedResultReceiver)
```
**Parameters**
`listener`: An object of [`DSCapturedResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html).
-**Return Value**
-
-A BOOL value that indicates whether the result receiver is added successfully.
-
## removeResultReceiver
-emoves the specified [`CapturedResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) object.
+Removes the specified [`CapturedResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) object.
>- Objective-C
@@ -189,11 +177,11 @@ emoves the specified [`CapturedResultReceiver`]({{ site.dcv_ios_api }}capture-vi
>
>1.
```objc
-- (BOOL)removeResultReceiver:(id)receiver;
+- (void)removeResultReceiver:(id)receiver;
```
2.
```swift
-func removeResultReceiver(_ listener:DSCapturedResultReceiver) -> BOOL
+func removeResultReceiver(_ listener:CapturedResultReceiver)
```
**Parameters**
@@ -325,11 +313,11 @@ Registers a `DSCaptureStateListener` to be used as a callback when capture state
>
>1.
```objc
-- (BOOL)addCaptureStateListener:(nonnull id)listener;
+- (void)addCaptureStateListener:(nonnull id)listener;
```
2.
```swift
-func addCaptureStateListener(_ listener:DSCaptureStateListener) -> BOOL
+func addCaptureStateListener(_ listener:CaptureStateListener)
```
**Parameters**
@@ -350,11 +338,11 @@ Removes a `DSCaptureStateListener` that has been configured for the Capture Visi
>
>1.
```objc
-- (BOOL)removeCaptureStateListener:(nonnull id)listener;
+- (void)removeCaptureStateListener:(nonnull id)listener;
```
2.
```swift
-func removeCaptureStateListener(_ listener:DSCaptureStateListener) -> BOOL
+func removeCaptureStateListener(_ listener:CaptureStateListener)
```
**Parameters**
@@ -375,7 +363,7 @@ Removes all user-added `DSCaptureStateListeners`.
>
>1.
```objc
-- (BOOL)removeAllCaptureStateListeners;
+- (void)removeAllCaptureStateListeners;
```
2.
```swift
@@ -392,11 +380,11 @@ Adds a [`DSCapturedResultFilter`]({{ site.dcv_ios_api }}capture-vision-router/au
>
>1.
```objc
-- (BOOL)addResultFilter:(nonnull id)filter;
+- (void)addResultFilter:(nonnull id)filter;
```
2.
```swift
-func addResultFilter(_ filter:DSCapturedResultFilter) -> BOOL
+func addResultFilter(_ filter:CapturedResultFilter)
```
**Parameters**
@@ -417,11 +405,11 @@ Removes the specified `DSCapturedResultFilter` object.
>
>1.
```objc
-- (BOOL)removeResultFilter:(nonnull id)filter;
+- (void)removeResultFilter:(nonnull id)filter;
```
2.
```swift
-func removeResultFilter(_ filter:DSCapturedResultFilter) -> BOOL
+func removeResultFilter(_ filter:CapturedResultFilter)
```
**Parameters**
@@ -442,7 +430,7 @@ Removes all user-added `DSCapturedResultFilters`.
>
>1.
```objc
-- (BOOL)removeAllResultFilters;
+- (void)removeAllResultFilters;
```
2.
```swift
diff --git a/programming/ios/api-reference/capture-vision-router/settings.md b/programming/ios/api-reference/capture-vision-router/settings.md
index ac3c9814..44cce102 100644
--- a/programming/ios/api-reference/capture-vision-router/settings.md
+++ b/programming/ios/api-reference/capture-vision-router/settings.md
@@ -75,7 +75,7 @@ Configures runtime settings using a provided JSON file, which contains settings
>1.
```objc
- (BOOL)initSettingsFromFile:(NSString *)file
- error:(NSError * _Nullable * _Nullable)error
+ error:(NSError * _Nullable * _Nullable)error
```
2.
```swift
diff --git a/programming/ios/api-reference/capture-vision-router/single-file-processing.md b/programming/ios/api-reference/capture-vision-router/single-file-processing.md
index 1c7ee27a..2427eef4 100644
--- a/programming/ios/api-reference/capture-vision-router/single-file-processing.md
+++ b/programming/ios/api-reference/capture-vision-router/single-file-processing.md
@@ -27,8 +27,8 @@ Capture data from the file specified by the file path. To learn more about what
>
>1.
```objc
-- (nullable DSCapturedResult *)captureFromFile:(NSString *)file
- templateName:(nonnull NSString*)templateName;
+- (DSCapturedResult *)captureFromFile:(NSString *)file
+ templateName:(NSString*)templateName;
```
2.
```swift
@@ -72,8 +72,8 @@ Capture data from a given file in memory. To learn more about what the captured
>
>1.
```objc
-- (nullable DSCapturedResult *)captureFromFileBytes:(NSData *)fileBytes
- templateName:(nonnull NSString*)templateName;
+- (DSCapturedResult *)captureFromFileBytes:(NSData *)fileBytes
+ templateName:(NSString*)templateName;
```
2.
```swift
@@ -115,8 +115,8 @@ Capture data from the memory buffer via a `DSImageData` object. To learn more ab
>
>1.
```objc
-- (nullable DSCapturedResult *)captureFromBuffer:(DSImageData *)buffer
- templateName:(nonnull NSString*)templateName;
+- (DSCapturedResult *)captureFromBuffer:(DSImageData *)buffer
+ templateName:(NSString*)templateName;
```
2.
```swift
@@ -159,8 +159,8 @@ Capture data from the given image. To learn more about what the captured data ca
>
>1.
```objc
-- (nullable DSCapturedResult *)captureFromImage:(UIImage *)image
- templateName:(nonnull NSString*)templateName;
+- (DSCapturedResult *)captureFromImage:(UIImage *)image
+ templateName:(NSString*)templateName;
```
2.
```swift
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 aba906fb..f9bd49b3 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
@@ -50,7 +50,7 @@ The hash id of the original image.
>
>1.
```objc
-@property(nonatomic, copy, readonly) NSString *originalImageHashId;
+@property (nonatomic, copy, readonly) NSString *originalImageHashId;
```
2.
```swift
@@ -67,7 +67,7 @@ The [DSImageTag](image-tag.md) of the original image.
>
>1.
```objc
-@property(nonatomic, readonly) DSImageTag *originalImageTag;
+@property (nonatomic, readonly, strong, nullable) DSImageTag *originalImageTag;
```
2.
```swift
@@ -84,7 +84,7 @@ The rotation transformation matrix of the original image relative to the rotated
>
>1.
```objc
-@property(nonatomic, assign, readonly) CGAffineTransform rotationTransformMatrix;
+@property (nonatomic, assign, readonly) CGAffineTransform rotationTransformMatrix;
```
2.
```swift
@@ -118,7 +118,7 @@ The error message of this result.
>
>1.
```objc
-@property (nonatomic, assign, readonly) NSString * errorMessage;
+@property (nonatomic, readonly, copy, nullable) NSString * errorMessage;
```
2.
```swift
diff --git a/programming/ios/api-reference/core/basic-structures/captured-result-filter.md b/programming/ios/api-reference/core/basic-structures/captured-result-filter.md
deleted file mode 100644
index 792add18..00000000
--- a/programming/ios/api-reference/core/basic-structures/captured-result-filter.md
+++ /dev/null
@@ -1,166 +0,0 @@
----
-layout: default-layout
-title: DSCapturedResultFilter - Dynamsoft Core Module iOS Edition API Reference
-description: The protocol DSCapturedResultFilter of Dynamsoft Core Module represents a captured result filter, which is responsible for filtering different types of captured results, including original image, decoded barcodes, recognized text lines, detected quads, normalized images, and parsed results.
-keywords: captured result filter, objective-c, swift
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-ignore: true
----
-
-# DSCapturedResultFilter
-
-The `DSCapturedResultFilter` protocol represents a captured result filter, which is responsible for filtering different types of captured results, including original image, decoded barcodes, recognized text lines, detected quads, normalized images, and parsed results.
-
-## Declaration
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-@protocol DSCapturedResultFilter : NSObject
-```
-2.
-```swift
-protocol CapturedResultFilter : NSObjectProtocol
-```
-
-## Methods
-
-| Method | Description |
-| ------ | ----------- |
-| [`onOriginalImageResultReceived`](#onoriginalimageresultreceived) | The method for monitoring the output of `DSOriginalImageResultItem`. |
-| [`onDecodedBarcodesReceived`](#ondecodedbarcodesreceived) | The method for monitoring the output of `DSDecodedBarcodesResult`. |
-| [`onRecognizedTextLinesReceived`](#onrecognizedtextlinesreceived) | The method for monitoring the output of `DSRecognizedTextLinesResult`. |
-| [`onDetectedQuadsReceived`](#ondetectedquadsreceived) | The method for monitoring the output of `DSDetectedQuadsResult`. |
-| [`onNormalizedImagesReceived`](#onnormalizedimagesreceived) | The method for monitoring the output of `DSNormalizedImagesResult`. |
-| [`onParsedResultsReceived`](#onparsedresultsreceived) | The method for monitoring the output of `DSParsedResult`. |
-
-### onOriginalImageResultReceived
-
-The method for monitoring the output of DSOriginalImageResultItem.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (void)onOriginalImageResultReceived:(DSOriginalImageResultItem*)result;
-```
-2.
-```swift
-func onOriginalImageResultReceived(_ result: DSOriginalImageResultItem)
-```
-
-**Parameters**
-
-`result`: A `DSOriginalImageResultItem` object as a original image result.
-
-### onDecodedBarcodesReceived
-
-The method for monitoring the output of DSDecodedBarcodesResult.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (void)onDecodedBarcodesReceived:(DSDecodedBarcodesResult*)result;
-```
-2.
-```swift
-func onDecodedBarcodesReceived(_ result: DSDecodedBarcodesResult)
-```
-
-**Parameters**
-
-`result`: A `DSDecodedBarcodesResult` object as a decoded barcode result.
-
-### onRecognizedTextLinesReceived
-
-The method for monitoring the output of DSRecognizedTextLinesResult.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (void)onRecognizedTextLinesReceived:(DSRecognizedTextLinesResult*)result;
-```
-2.
-```swift
-func onRecognizedTextLinesReceived(_ result: DSRecognizedTextLinesResult)
-```
-
-**Parameters**
-
-`result`: A `DSRecognizedTextLinesResult` object as a recognized text line result.
-
-### onDetectedQuadsReceived
-
-The method for monitoring the output of DSDetectedQuadsResult.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (void)onDetectedQuadsReceived:(DSDetectedQuadsResult*)result;
-```
-2.
-```swift
-func onDetectedQuadsReceived(_ result: DSDetectedQuadsResult)
-```
-
-**Parameters**
-
-`result`: A `DSDetectedQuadsResult` object as a detected quad result.
-
-### onNormalizedImagesReceived
-
-The method for monitoring the output of DSNormalizedImagesResult.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (void)onNormalizedImagesReceived:(DSNormalizedImagesResult*)result;
-```
-2.
-```swift
-func onNormalizedImagesReceived(_ result: DSNormalizedImagesResult)
-```
-
-**Parameters**
-
-`result`: A `DSNormalizedImagesResult` object as a normalized image result.
-
-### onParsedResultsReceived
-
-The method for monitoring the output of DSParsedResult.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (void)onParsedResultsReceived:(DSParsedResult*)result;
-```
-2.
-```swift
-func onParsedResultsReceived(_ result: DSParsedResult)
-```
-
-**Parameters**
-
-`result`: A `DSParsedResult` object as a parsed result.
diff --git a/programming/ios/api-reference/core/basic-structures/captured-result-item.md b/programming/ios/api-reference/core/basic-structures/captured-result-item.md
index b3321edd..be96ccf5 100644
--- a/programming/ios/api-reference/core/basic-structures/captured-result-item.md
+++ b/programming/ios/api-reference/core/basic-structures/captured-result-item.md
@@ -69,7 +69,7 @@ A property of type `DSCapturedResultItem` that represents a reference to another
```
2.
```swift
-var referenceItem: DSCapturedResultItem? { get }
+var referenceItem: CapturedResultItem? { get }
```
### targetROIDefName
@@ -82,7 +82,7 @@ The name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-d
>
>1.
```objc
-@property (nonatomic, nullable, readonly) NSString *targetROIDefName
+@property (nonatomic, readonly) NSString *targetROIDefName
```
2.
```swift
@@ -99,7 +99,7 @@ The name of the task that generated the result.
>
>1.
```objc
-@property (nonatomic, nullable, readonly) NSString *taskName
+@property (nonatomic, readonly) NSString *taskName
```
2.
```swift
diff --git a/programming/ios/api-reference/core/basic-structures/captured-result.md b/programming/ios/api-reference/core/basic-structures/captured-result.md
deleted file mode 100644
index 4a5fb814..00000000
--- a/programming/ios/api-reference/core/basic-structures/captured-result.md
+++ /dev/null
@@ -1,146 +0,0 @@
----
-layout: default-layout
-title: DSCapturedResult - Dynamsoft Core Module iOS Edition API Reference
-description: The class DSCapturedResult of Dynamsoft Core Module represents the result of a capture operation on an image, which contains multiple items such as barcode, text line, detected quad, normalized image, original image, parsed item, etc.
-keywords: captured result, objective-c, swift
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-ignore: true
----
-
-# DSCapturedResult
-
-> You are viewing a history document page of `DynamsoftCore` v3.0.20. Start from v3.2.10 version, the class `DSCapturedResult` is migrated to the `DynamsoftCaptureVisionRouter` library. [View the latest document page of `DSCapturedResult`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result.html).
-
-The `DSCapturedResult` class represents the result of a capture operation on an image. Internally, `DSCapturedResult` stores an array that contains multiple items, each of which may be a barcode, text line, detected quad, normalized image, original image, parsed item, etc.
-
-## Definition
-
-*Assembly:* DynamsoftCaptureVisionBundle.xcframework
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-@interface DSCapturedResult : NSObject
-```
-2.
-```swift
-class CapturedResult : NSObject
-```
-
-## Attributes
-
-| Attributes | Type | Description |
-| ---------- | ---- | ----------- |
-| [`originalImageHashId`](#originalimagehashid) | *NSString \** | The hash id of the original image. You can use this ID to get the original image via `IntermediateResultManager` class. |
-| [`originalImageTag`](#originalimagetag) | *DSImageTag* | The [DSImageTag](image-tag.md) of the original image that records information such as the image ID of the original image. |
-| [`items`](#items) | *NSArray \** | An array of `DSCapturedResultItems`, which are the basic unit of the captured results. A `DSCapturedResultItem` can be a original image, a decoded barcode, a recognized text, a detected quad, a normalized image or a parsed result. View DSCapturedResultItemType for all available types. |
-| [`rotationTransformMatrix`](#rotationtransformmatrix) | *CGAffineTransform* | The rotation transformation matrix of the original image relative to the rotated image. |
-| [`errorCode`](#errorcode) | *NSInteger* | Get the error code of this result. |
-| [`errorMessage`](#errormessage) | *NSString \** | Get the error message of this result. |
-
-### originalImageHashId
-
-The hash ID of the original image which can be used to get the original image via the [IntermediateResultManager](../intermediate-results/intermediate-result-manager.md) class.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-@property(nonatomic, copy, readonly) NSString *originalImageHashId;
-```
-2.
-```swift
-var originalImageHashId: String { get }
-```
-
-### originalImageTag
-
-The [DSImageTag](image-tag.md) of the original image that records information such as the image ID of the original image.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-@property(nonatomic, readonly) DSImageTag *originalImageTag;
-```
-2.
-```swift
-var originalImageTag: ImageTag { get }
-```
-
-### items
-
-An array of [DSCapturedResultItem](captured-result-item.md), which is the basic unit of the captured results. A DSCapturedResultItem can be an original image, a decoded barcode, a recognized text, a detected quad, a normalized image, or a parsed result. View DSCapturedResultItemType for all available types.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-@property(nonatomic, strong, nullable, readonly) NSArray *items;
-```
-2.
-```swift
-var items: [CapturedResultItem]? { get }
-```
-
-### rotationTransformMatrix
-
-The rotation transformation matrix of the original image relative to the rotated image. View [CGAffineTransform](https://developer.apple.com/documentation/corefoundation/cgaffinetransform) for more info.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-@property(nonatomic, assign, readonly) CGAffineTransform rotationTransformMatrix;
-```
-2.
-```swift
-var rotationTransformMatrix: CGAffineTransform { get }
-```
-
-### errorCode
-
-Get the error code of this result. A `CapturedResult` will carry error information when the license module is missing or the process timeout.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-@property (nonatomic, assign, readonly) NSInteger errorCode;
-```
-2.
-```swift
-var errorCode: Int { get }
-```
-
-### errorMessage
-
-Get the error message of this result. A `CapturedResult` will carry error information when the license module is missing or the process timeout.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-@property (nonatomic, assign, readonly) NSString * errorMessage;
-```
-2.
-```swift
-var errorMessage: String { get }
-```
diff --git a/programming/ios/api-reference/core/basic-structures/contour.md b/programming/ios/api-reference/core/basic-structures/contour.md
index 77368cfb..5c097d94 100644
--- a/programming/ios/api-reference/core/basic-structures/contour.md
+++ b/programming/ios/api-reference/core/basic-structures/contour.md
@@ -29,12 +29,17 @@ The `Contour` class represents a contour made up of multiple points.
class Contour : NSObject
```
-## Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
| [`points`](#points) | *NSArray \** | An array of `Point` objects defining the vertices of the contour. |
+
+| Method | Description |
+| ------ | ----------- |
+| [`initWithPointArray`](#initwithpointarray) | The constructor. Creates an instance from an array of points. |
+
### points
An array of `Point` objects defining the vertices of the contour.
@@ -45,9 +50,26 @@ An array of `Point` objects defining the vertices of the contour.
>
>1.
```objc
-@property(nonatomic, copy) NSArray *points;
+@property (nonatomic, copy, nullable) NSArray *points;
```
2.
```swift
var points: [Point] { get set }
```
+
+### initWithPointArray
+
+The constructor. Creates an instance from an array of points.
+
+
+>- Objective-C
+>- Swift
+>
+>1.
+```objc
+- (instancetype)initWithPointArray:(nullable NSArray *)points;
+```
+2.
+```swift
+init(points: [Point]?)
+```
diff --git a/programming/ios/api-reference/core/basic-structures/core-module.md b/programming/ios/api-reference/core/basic-structures/core-module.md
index 976fdfd2..6fd713f3 100644
--- a/programming/ios/api-reference/core/basic-structures/core-module.md
+++ b/programming/ios/api-reference/core/basic-structures/core-module.md
@@ -83,11 +83,11 @@ Enable the output of logs.
>
>1.
```objc
-+(BOOL)enableLogging:(NSInteger)logMode;
++(void)enableLogging:(DSLogMode)mode;
```
2.
```swift
-class func enableLogging(_ logMode:Int)
+class func enableLogging(_ mode:Int)
```
**Parameters**
diff --git a/programming/ios/api-reference/core/basic-structures/corner.md b/programming/ios/api-reference/core/basic-structures/corner.md
index e2dd0ae4..fe73f8b4 100644
--- a/programming/ios/api-reference/core/basic-structures/corner.md
+++ b/programming/ios/api-reference/core/basic-structures/corner.md
@@ -29,7 +29,7 @@ The `DSCorner` class represents a corner, typically where two line segments meet
class Corner: NSObject
```
-## Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
@@ -38,6 +38,10 @@ class Corner: NSObject
| [`line1`](#line1) | *DSLineSegment \** | The first line segment forming the corner. |
| [`line2`](#line2) | *DSLineSegment \** | The second line segment forming the corner. |
+| Method | Description |
+| ------ | ----------- |
+| [`initWithCornerType`](#initwithcornertype) | The constructor. Creates an instance from corner type, intersection and lines. |
+
### type
The type of the corner, represented by the enumeration [`DSCornerType`]({{ site.dcv_ios_api }}core/enum/corner-type.html?lang=objc,swift).
@@ -52,7 +56,7 @@ The type of the corner, represented by the enumeration [`DSCornerType`]({{ site.
```
2.
```swift
-var type: DSCornerType { get set }
+var type: CornerType { get set }
```
### intersection
@@ -82,11 +86,11 @@ The first line segment forming the corner.
>
>1.
```objc
-@property (nonatomic, strong, nullable) DSLineSegment *line1;
+@property (nonatomic, strong) DSLineSegment *line1;
```
2.
```swift
-var line1: DSLineSegment? { get set }
+var line1: LineSegment? { get set }
```
### line2
@@ -99,9 +103,29 @@ The second line segment forming the corner.
>
>1.
```objc
-@property (nonatomic, strong, nullable) DSLineSegment *line2;
+@property (nonatomic, strong) DSLineSegment *line2;
+```
+2.
+```swift
+var line2: LineSegment? { get set }
+```
+
+### initWithCornerType
+
+The constructor. Creates an instance from corner type, intersection and lines.
+
+
+>- Objective-C
+>- Swift
+>
+>1.
+```objc
+- (instancetype)initWithCornerType:(DSCornerType)type
+ intersection:(CGPoint)intersection
+ line1:(DSLineSegment *)line1
+ line2:(DSLineSegment *)line2;
```
2.
```swift
-var line2: DSLineSegment? { get set }
+init(type: CornerType, intersection: CGPoint, line1: LineSegment?, line2: LineSegment?)
```
diff --git a/programming/ios/api-reference/core/basic-structures/edge.md b/programming/ios/api-reference/core/basic-structures/edge.md
index 95f311dc..7a1fdef1 100644
--- a/programming/ios/api-reference/core/basic-structures/edge.md
+++ b/programming/ios/api-reference/core/basic-structures/edge.md
@@ -29,13 +29,17 @@ The `DSEdge` class represents an edge defined by two `Corners`.
class Edge : NSObject
```
-## Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
| [`startCorner`](#startcorner) | *DSCorner \** | The starting corner of the edge. |
| [`endCorner`](#endcorner) | *DSCorner \** | The ending corner of the edge. |
+| Method | Description |
+| ------ | ----------- |
+| [`initWithStartCorner`](#initwithstartcorner) | The constructor. Creates an instance from start corner and end corner. |
+
### startCorner
The starting corner of the edge.
@@ -46,7 +50,7 @@ The starting corner of the edge.
>
>1.
```objc
-@property(nonatomic, strong, nullable) DSCorner *startCorner;
+@property (nonatomic, strong) DSCorner *startCorner;
```
2.
```swift
@@ -63,9 +67,27 @@ The ending corner of the edge.
>
>1.
```objc
-@property(nonatomic, strong, nullable) DSCorner *endCorner;
+@property (nonatomic, strong) DSCorner *endCorner;
```
2.
```swift
var endCorner: Corner? { get set }
```
+
+### initWithStartCorner
+
+The constructor. Creates an instance from start corner and end corner.
+
+
+>- Objective-C
+>- Swift
+>
+>1.
+```objc
+- (instancetype)initWithStartCorner:(DSCorner *)startCorner
+ endCorner:(DSCorner *)endCorner;
+```
+2.
+```swift
+init(startCorner: Corner, endCorner: Corner)
+```
diff --git a/programming/ios/api-reference/core/basic-structures/file-image-tag.md b/programming/ios/api-reference/core/basic-structures/file-image-tag.md
index d3462220..a831a569 100644
--- a/programming/ios/api-reference/core/basic-structures/file-image-tag.md
+++ b/programming/ios/api-reference/core/basic-structures/file-image-tag.md
@@ -29,7 +29,7 @@ The `DSFileImageTag` class represents an image tag that is associated with a fil
class FileImageTag : ImageTag
```
-## Methods & Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
@@ -51,7 +51,7 @@ The file path of the image.
>
>1.
```objc
-@property(nonatomic, copy, readonly) NSString *filePath;
+@property (nonatomic, readonly, copy, nullable) NSString *filePath;
```
2.
```swift
@@ -68,7 +68,7 @@ The page number of the current image in the multi-page.
>
>1.
```objc
-@property (nonatomic, readonly) NSInteger pageNumber;
+@property (nonatomic, readonly, assign) NSUInteger pageNumber;
```
2.
```swift
@@ -85,7 +85,7 @@ The total page number of the multi-page.
>
>1.
```objc
-@property (nonatomic, readonly) NSInteger totalPages;
+@property (nonatomic, readonly, assign) NSUInteger totalPages;
```
2.
```swift
diff --git a/programming/ios/api-reference/core/basic-structures/image-data.md b/programming/ios/api-reference/core/basic-structures/image-data.md
index 0d398b60..7ece3341 100644
--- a/programming/ios/api-reference/core/basic-structures/image-data.md
+++ b/programming/ios/api-reference/core/basic-structures/image-data.md
@@ -29,7 +29,7 @@ The `DSImageData` class defines the structure of an object that represents an im
class ImageData : NSObject
```
-## Methods & Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
@@ -55,7 +55,7 @@ The image data content in a byte array.
>
>1.
```objc
-@property(nonatomic, copy) NSData *bytes;
+@property (nonatomic, copy) NSData *bytes;
```
2.
```swift
@@ -72,7 +72,7 @@ The width of the image in pixels.
>
>1.
```objc
-@property (nonatomic, assign) NSInteger width
+@property (nonatomic, assign) NSUInteger width
```
2.
```swift
@@ -89,7 +89,7 @@ The height of the image in pixels.
>
>1.
```objc
-@property (nonatomic, assign) NSInteger height
+@property (nonatomic, assign) NSUInteger height
```
2.
```swift
@@ -106,7 +106,7 @@ The stride (or scan width) of the image.
>
>1.
```objc
-@property (nonatomic, assign) NSInteger stride
+@property (nonatomic, assign) NSUInteger stride
```
2.
```swift
@@ -157,7 +157,7 @@ The tag of the image.
>
>1.
```objc
-@property(nonatomic, strong, nullable) DSImageTag *tag;
+@property (nonatomic, strong, nullable) DSImageTag *tag;
```
2.
```swift
@@ -174,7 +174,7 @@ Transform the DSImageData to a UIImage.
>
>1.
```objc
-- (UIImage * _Nullable)toUIImage:(NSError *_Nullable *_Nullable)error;
+- (nullable UIImage *)toUIImage:(NSError *_Nullable *_Nullable)error;
```
2.
```swift
diff --git a/programming/ios/api-reference/core/basic-structures/image-source-adapter.md b/programming/ios/api-reference/core/basic-structures/image-source-adapter.md
index a0bfa505..3278ba26 100644
--- a/programming/ios/api-reference/core/basic-structures/image-source-adapter.md
+++ b/programming/ios/api-reference/core/basic-structures/image-source-adapter.md
@@ -29,14 +29,13 @@ The `ImageSourceAdapter` class is an abstract class representing an adapter for
class ImageSourceAdapter : NSObject
```
-## Methods & Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
| [`bufferEmpty`](#bufferempty) | *BOOL* | The read only property determines whether the buffer is currently empty. |
| [`bufferOverflowProtectionMode`](#bufferoverflowprotectionmode) | *DSBufferOverflowProtectionMode* | Sets the behavior for handling new incoming images when the buffer is full. |
| [`colourChannelUsageType`](#colourchannelusagetype) | *colourChannelUsageType* | Sets the usage type for color channels in images. |
-| [`hasNextImageToFetch`](#hasnextimagetofetch) | *BOOL* | Determines whether there are more images available to fetch. |
| [`imageCount`](#imagecount) | *NSUInteger* | The property defines the current number of images in the buffer. |
| [`maxImageCount`](#maximagecount) | *NSUInteger* | The property defines the maximum number of images that can be buffered. |
@@ -47,6 +46,7 @@ class ImageSourceAdapter : NSObject
| [`getImage`](#getimage) | Get a buffered image. Implementing classes should return a Promise that resolves with an instance of `DSImageData`. |
| [`hasImage`](#hasimage) | Checks if an image with the specified ID is present in the buffer. |
| [`setErrorListener`](#seterrorlistener) | Sets an error listener to receive notifications about errors that occur during image source operations. |
+| [`setImageFetchState`](#setimagefetchstate) | Determines whether there are more images left to fetch. |
| [`setNextImageToReturn`](#setnextimagetoreturn) | Sets the processing priority of a specific image. This can affect the order in which images are returned by `getImage`. |
| [`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. |
@@ -65,7 +65,7 @@ The read only property indicates whether the Video Buffer is empty.
```
2.
```swift
-var bufferEmpty: Bool { get }
+var isBufferEmpty: Bool { get }
```
### bufferOverflowProtectionMode
@@ -82,7 +82,7 @@ Sets a mode that determines the action to take when there is a new incoming imag
```
2.
```swift
-var bufferOverflowProtectionMode: DSBufferOverflowProtectionMode { get set }
+var bufferOverflowProtectionMode: BufferOverflowProtectionMode { get set }
```
### colourChannelUsageType
@@ -95,11 +95,11 @@ The usage type of a color channel in an image.
>
>1.
```objc
-@property (nonatomic, assign) colourChannelUsageType;
+@property (nonatomic, assign) DSColourChannelUsageType colourChannelUsageType;
```
2.
```swift
-var colourChannelUsageType: colourChannelUsageType { get set }
+var colourChannelUsageType: ColourChannelUsageType { get set }
```
### hasNextImageToFetch
@@ -129,11 +129,11 @@ The property defines current image count in the Video Buffer.
>
>1.
```objc
-@property (nonatomic, assign) NSUInteger imageCount;
+@property (nonatomic, readonly, assign) NSUInteger imageCount;
```
2.
```swift
-var imageCount: Int { get set }
+var imageCount: Int { get }
```
### maxImageCount
@@ -167,7 +167,7 @@ Adds an image to the internal buffer.
```
2.
```swift
-func addImageToBuffer(image: DSImageData)
+func addImageToBuffer(image: ImageData)
```
**Parameters**
@@ -201,7 +201,7 @@ Get a buffered image. Implementing classes should return a Promise that resolves
>
>1.
```objc
-- (DSImageData *_Nullable)getImage;
+- (nullable DSImageData *)getImage;
```
2.
```swift
@@ -250,17 +250,38 @@ Sets an error listener to receive notifications about errors that occur during i
>
>1.
```objc
--(void)setErrorListener:(DSImageSourceErrorListener)listener;
+- (void)setErrorListener:(nullable id)listener;
```
2.
```swift
-func setErrorListener(_ listener:ImageSourceErrorListener)
+func setErrorListener(_ listener: ImageSourceErrorListener?)
```
**Parameters**
`[in] listener`: A delegate object of [`DSImageSourceErrorListener`]({{ site.dcv_ios_api }}core/basic-structures/image-source-error-listener.html) to receive the errors that occurs in the `ImageSourceAdapter`.
+### setImageFetchState
+
+Determines whether there are more images left to fetch.
+
+
+>- Objective-C
+>- Swift
+>
+>1.
+```objc
+- (void)setImageFetchState:(BOOL)state;
+```
+2.
+```swift
+func setImageFetchState(state: Bool)
+```
+
+**Parameters**
+
+`[in] state`: The state of image fetching.
+
### setNextImageToReturn
Sets the processing priority of a specific image. This can affect the order in which images are returned by [`getImage`](#getimage).
@@ -271,11 +292,12 @@ Sets the processing priority of a specific image. This can affect the order in w
>
>1.
```objc
-- (BOOL)setNextImageToReturn:(NSInteger)imageId;
+- (BOOL)setNextImageToReturn:(NSInteger)imageId
+ keepInBuffer:(BOOL)keepInBuffer;
```
2.
```swift
-func setNextImageToReturn(imageId: Int) -> Bool
+func setNextImageToReturn(imageId: Int, keepInBuffer: Bool) -> Bool
```
**Parameters**
diff --git a/programming/ios/api-reference/core/basic-structures/image-source-error-listener.md b/programming/ios/api-reference/core/basic-structures/image-source-error-listener.md
index d67bf4cf..706525d3 100644
--- a/programming/ios/api-reference/core/basic-structures/image-source-error-listener.md
+++ b/programming/ios/api-reference/core/basic-structures/image-source-error-listener.md
@@ -45,11 +45,11 @@ The callback method for monitoring the errors that occur in the [`ImageSourceAda
>
>1.
```objc
-- (void)onErrorReceived:( NSError *_Nullable error)imageSourceError;
+- (void)onErrorReceived:(NSError *)error;
```
2.
```swift
-func onErrorReceived(_ error: Error)
+func onErrorReceived(_error: Error)
```
**Parameters**
diff --git a/programming/ios/api-reference/core/basic-structures/image-tag.md b/programming/ios/api-reference/core/basic-structures/image-tag.md
index 0b3e0558..d54bce78 100644
--- a/programming/ios/api-reference/core/basic-structures/image-tag.md
+++ b/programming/ios/api-reference/core/basic-structures/image-tag.md
@@ -47,11 +47,11 @@ The ID of the image, which is the unique identifier of the image.
>
>1.
```objc
-@property(nonatomic, assign) NSInteger imageId;
+@property (nonatomic, readonly, assign) NSInteger imageId;
```
2.
```swift
-var imageId: Int { get set }
+var imageId: Int { get }
```
### type
@@ -64,7 +64,7 @@ The type of the image tag.
>
>1.
```objc
-@property(nonatomic, assign, readonly) DSImageTagType type;
+@property (nonatomic, readonly, assign) DSImageTagType type;
```
2.
```swift
@@ -81,7 +81,7 @@ The capture distance mode of the image.
>
>1.
```objc
-@property(nonatomic, assign) DSImageCaptureDistanceMode distanceMode;
+@property (nonatomic, assign) DSImageCaptureDistanceMode distanceMode;
```
2.
```swift
diff --git a/programming/ios/api-reference/core/basic-structures/line-segment.md b/programming/ios/api-reference/core/basic-structures/line-segment.md
index 25e91bd7..5a006e6f 100644
--- a/programming/ios/api-reference/core/basic-structures/line-segment.md
+++ b/programming/ios/api-reference/core/basic-structures/line-segment.md
@@ -29,7 +29,7 @@ The `DSLineSegment` class represents a line segment defined by two `Points`.
class LineSegment : NSObject
```
-## Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
@@ -37,6 +37,10 @@ class LineSegment : NSObject
| [`endPoint`](#endpoint) | *CGPoint* | The ending point of the line segment. |
| [`id`](#id) | *int* | The ID of the line segment. |
+| Methods | Description |
+| ------- | ----------- |
+| [`initWithStartPoint`](#initwithstartpoint) | The constructor. Creates an instance from start point, end point and line ID. |
+
### startPoint
The starting point of the line segment.
@@ -47,7 +51,7 @@ The starting point of the line segment.
>
>1.
```objc
-@property(nonatomic, assign) CGPoint startPoint;
+@property (nonatomic, assign) CGPoint startPoint;
```
2.
```swift
@@ -64,7 +68,7 @@ The ending point of the line segment.
>
>1.
```objc
-@property(nonatomic, assign) CGPoint endPoint;
+@property (nonatomic, assign) CGPoint endPoint;
```
2.
```swift
@@ -81,9 +85,28 @@ The ID of the line segment.
>
>1.
```objc
-@property (nonatomic) NSInteger *lineId;
+@property (nonatomic, assign) NSInteger lineId;
```
2.
```swift
var lineId: Int { get set }
```
+
+### initWithStartPoint
+
+The constructor. Creates an instance from start point, end point and line ID.
+
+
+>- Objective-C
+>- Swift
+>
+>1.
+```objc
+- (instancetype)initWithStartPoint:(CGPoint)startPoint
+ endPoint:(CGPoint)endPoint
+ lineId:(NSInteger)lineId;
+```
+2.
+```swift
+init(startPoint: CGPoint, endPoint: CGPoint, lineId: Int)
+```
diff --git a/programming/ios/api-reference/core/basic-structures/original-image-result-item.md b/programming/ios/api-reference/core/basic-structures/original-image-result-item.md
index dfb4a9df..5a4f0b86 100644
--- a/programming/ios/api-reference/core/basic-structures/original-image-result-item.md
+++ b/programming/ios/api-reference/core/basic-structures/original-image-result-item.md
@@ -54,7 +54,7 @@ The image data of the captured original image result item.
>
>1.
```objc
-@property (nonatomic, nonnull, readonly) DSImageData* imageData;
+@property (nonatomic, readonly, strong, nullable) DSImageData *imageData;
```
2.
```swift
diff --git a/programming/ios/api-reference/core/basic-structures/pdf-reading-parameter.md b/programming/ios/api-reference/core/basic-structures/pdf-reading-parameter.md
index 72d9c811..c082efb1 100644
--- a/programming/ios/api-reference/core/basic-structures/pdf-reading-parameter.md
+++ b/programming/ios/api-reference/core/basic-structures/pdf-reading-parameter.md
@@ -48,7 +48,7 @@ Set the processing mode of the PDF file. You can either read the PDF info from v
>
>1.
```objc
-@property(nonatomic, assign) DSPDFReadingMode mode;
+@property (nonatomic, assign) DSPDFReadingMode mode;
```
2.
```swift
@@ -65,7 +65,7 @@ Set the DPI (dots per inch) of the PDF file.
>
>1.
```objc
-@property(nonatomic, assign) NSInteger dpi;
+@property (nonatomic, assign) NSInteger dpi;
```
2.
```swift
@@ -82,9 +82,9 @@ Set the raster data source type of the image. The default type is pages.
>
>1.
```objc
-@property(nonatomic, assign) DSRasterDataSource rasterDataSource;
+@property (nonatomic, assign) DSRasterDataSource rasterDataSource;
```
2.
```swift
-var rasterDataSource: DSRasterDataSource { get set }
+var rasterDataSource: RasterDataSource { get set }
```
diff --git a/programming/ios/api-reference/core/basic-structures/quadrilateral.md b/programming/ios/api-reference/core/basic-structures/quadrilateral.md
index 2fb3bd75..9dc1d9ce 100644
--- a/programming/ios/api-reference/core/basic-structures/quadrilateral.md
+++ b/programming/ios/api-reference/core/basic-structures/quadrilateral.md
@@ -29,19 +29,21 @@ The `DSQuadrilateral` class represents a quadrilateral defined by four points.
class Quadrilateral : NSObject
```
-## Methods & Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
| [`points`](#points) | *NSArray* | An array of four `Point` objects defining the vertices of the quadrilateral. |
| [`id`](#id) | *NSInteger* | The ID of the quadrilateral. |
+| [`boundingRect`](#boundingrect) | *CGRect* | Get the bounding rectangle of the quadrilateral. |
+| [`centrePoint`](#centrepoint) | *CGPoint* | Get the centre point of the quadrilateral. |
+| [`area`](#area) | *NSUInteger* | Get the area of the quadrilateral. |
| Method | Description |
| ------ | ----------- |
+| [`initWithPointArray(points:)`](#initwithpointarraypoints) | The constructor. Creates a quadrilateral from an array of points. |
+| [`initWithPointArray(points:quadId:)`](#initwithpointarraypointsquadid) | The constructor. Creates a quadrilateral from an array of points and an ID. |
| [`contains`](#contains) | Check whether the input point is contained by the quadrilateral. |
-| [`boundingRect`](#boundingrect) | Get the bounding rectangle of the quadrilateral. |
-| [`centrePoint`](#centrepoint) | Get the centre point of the quadrilateral. |
-| [`area`](#area) | Get the area of the quadrilateral. |
### points
@@ -53,11 +55,11 @@ An array of four `Point` objects defining the vertices of the quadrilateral.
>
>1.
```objc
-@property (nonatomic, copy) NSArray *points;
+@property (nonatomic, readonly, copy) NSArray *points;
```
2.
```swift
-var points: [CGPoint] { get set }
+var points: [NSValue] { get }
```
### id
@@ -70,16 +72,16 @@ The ID of the quadrilateral.
>
>1.
```objc
-@property (nonatomic) NSInteger *quadId;
+@property (nonatomic, assign) NSInteger quadId;
```
2.
```swift
var quadId: Int { get set }
```
-### contains
+### boundingRect
-Check whether the input point is contained by the quadrilateral.
+Get the bounding rectangle of the quadrilateral.
>- Objective-C
@@ -87,39 +89,20 @@ Check whether the input point is contained by the quadrilateral.
>
>1.
```objc
-- (BOOL)contains:(CGPoint)point;
+@property (nonatomic, readonly) CGRect boundingRect;
```
2.
```swift
-func contains(_ point: CGPoint) -> Bool
+var boundingRect: CGRect { get }
```
-**Parameters**
-
-`point`: Input a point.
-
**Return Value**
-A `BOOL` value that indicates whether the point is contained by the quadrilateral.
-
-**Code Snippet**
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-BOOL result = [quadrilateral contains:point];
-```
-2.
-```swift
-let result = quadrilateral.contains(point)
-```
+The bounding rectangle of the quadrilateral.
-### boundingRect
+### centrePoint
-Get the bounding rectangle of the quadrilateral.
+Get the centre point of the quadrilateral.
>- Objective-C
@@ -127,18 +110,20 @@ Get the bounding rectangle of the quadrilateral.
>
>1.
```objc
-@property (nonatomic, readonly) CGRect *boundingRect;
+@property (nonatomic, readonly) CGPoint centrePoint;
```
2.
```swift
-var boundingRect: CGRect { get }
+var centrePoint: CGPoint { get }
```
**Return Value**
-The bounding rectangle of the quadrilateral.
+The centre point of the quadrilateral.
+
+### area
-**Code Snippet**
+Get the area of the quadrilateral.
>- Objective-C
@@ -146,16 +131,20 @@ The bounding rectangle of the quadrilateral.
>
>1.
```objc
-CGRect rect = [quadrilateral getBoundingRect];
+@property (nonatomic, readonly) NSUInteger area;
```
2.
```swift
-let rect = quadrilateral.getBoundingRect()
+var area: Int { get }
```
-### centrePoint
+**Return Value**
-Get the centre point of the quadrilateral.
+The area of the quadrilateral.
+
+### initWithPointArray(points:)
+
+The constructor. Creates a quadrilateral from an array of points.
>- Objective-C
@@ -163,18 +152,16 @@ Get the centre point of the quadrilateral.
>
>1.
```objc
-@property (nonatomic, readonly) CGPoint *centrePoint;
+- (instancetype)initWithPointArray:(NSArray *)points;
```
2.
```swift
-var centrePoint: CGPoint { get }
+init(points: [NSValue])
```
-**Return Value**
-
-The centre point of the quadrilateral.
+### initWithPointArray(points:quadId:)
-**Code Snippet**
+The constructor. Creates a quadrilateral from an array of points and an ID.
>- Objective-C
@@ -182,16 +169,16 @@ The centre point of the quadrilateral.
>
>1.
```objc
-CGPoint center = [quadrilateral getCentrePoint];
+- (instancetype)initWithPointArray:(NSArray *)points quadId:(NSInteger)quadId;
```
2.
```swift
-let center = quadrilateral.getCentrePoint()
+init(points: [NSValue], quadId: Int)
```
-### area
+### contains
-Get the area of the quadrilateral.
+Check whether the input point is contained by the quadrilateral.
>- Objective-C
@@ -199,28 +186,17 @@ Get the area of the quadrilateral.
>
>1.
```objc
-@property (nonatomic, readonly) NSInteger *area;
+- (BOOL)contains:(CGPoint)point;
```
2.
```swift
-var area: Int { get }
+func contains(_ point: CGPoint) -> Bool
```
-**Return Value**
+**Parameters**
-The area of the quadrilateral.
+`point`: Input a point.
-**Code Snippet**
+**Return Value**
-
->- Objective-C
->- Swift
->
->1.
-```objc
-NSInteger area = [quadrilateral getArea];
-```
-2.
-```swift
-let area = quadrilateral.getArea()
-```
+A `BOOL` value that indicates whether the point is contained by the quadrilateral.
diff --git a/programming/ios/api-reference/core/basic-structures/rect.md b/programming/ios/api-reference/core/basic-structures/rect.md
index 115afdd3..9123c272 100644
--- a/programming/ios/api-reference/core/basic-structures/rect.md
+++ b/programming/ios/api-reference/core/basic-structures/rect.md
@@ -29,7 +29,7 @@ The `DSRect` class represents a rectangle in 2D space, which contains four integ
class Rect : NSObject
```
-## Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
@@ -39,6 +39,10 @@ class Rect : NSObject
| [`bottom`](#bottom) | *CGFloat* | The distance between the bottom of the rect and the x-axis. If measuredInPercentage = 1, the value specifies the percentage comparing with the height of the parent. If measuredInPercentage = 0, the value specifies a pixel length. |
| [`measuredInPercentage`](#measuredinpercentage) | *BOOL* | Indicates if the rectangle's measurements are in percentages. |
+| Method | Description |
+| ------ | ----------- |
+| [`initWith(left:top:right:bottom:measuredInPercentage:)`](#initwithlefttoprightbottommeasuredinpercentage) | The constructor. Creates a DSRect from the specified parameters. |
+
### top
The distance between the top of the rect and the x-axis. If measuredInPercentage = 1, the value specifies the percentage comparing with the height of the parent. If measuredInPercentage = 0, the value specifies a pixel length.
@@ -123,3 +127,24 @@ Sets whether to use percentages to measure the region size.
```swift
var measuredInPercentage: Bool { get set }
```
+
+### initWith(left:top:right:bottom:measuredInPercentage:)
+
+The constructor. Creates a DSRect from the specified parameters.
+
+
+>- Objective-C
+>- Swift
+>
+>1.
+```objc
+- (instancetype)initWithLeft:(CGFloat)left
+ top:(CGFloat)top
+ right:(CGFloat)right
+ bottom:(CGFloat)bottom
+ measuredInPercentage:(BOOL)measuredInPercentage;
+```
+2.
+```swift
+init(left: CGFloat, top: CGFloat, right: CGFloat, bottom: CGFloat, measuredInPercentage: Bool)
+```
diff --git a/programming/ios/api-reference/core/basic-structures/vector4.md b/programming/ios/api-reference/core/basic-structures/vector4.md
index d3afb84d..8cdb6056 100644
--- a/programming/ios/api-reference/core/basic-structures/vector4.md
+++ b/programming/ios/api-reference/core/basic-structures/vector4.md
@@ -29,12 +29,16 @@ The `DSVector4` class represents a four-dimensional vector.
class Vector4 : NSObject
```
-## Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
| [`value`](#value) | *NSArray* | The components value of a four-dimensional vector. |
+| Method | Description |
+| ------ | ----------- |
+| [`initWithIntegerValue`](#initwithintegervalue) | The constructor. Creates a DSVector4 from the specified parameters. |
+
### value
The components value of a four-dimensional vector.
@@ -45,9 +49,29 @@ The components value of a four-dimensional vector.
>
>1.
```objc
-@property (nonatomic, copy) NSArray *value;
+@property (nonatomic, copy, readonly) NSArray *values;
+```
+2.
+```swift
+var value: [Int] { get }
+```
+
+### initWithIntegerValue
+
+The constructor. Creates a DSVector4 from the specified parameters.
+
+
+>- Objective-C
+>- Swift
+>
+>1.
+```objc
+- (instancetype)initWithIntegerValue:(NSInteger)v1
+ v2:(NSInteger)v2
+ v3:(NSInteger)v3
+ v4:(NSInteger)v4;
```
2.
```swift
-var value: [Int] { get set }
+init(v1: Int, v2: Int, v3: Int, v4: Int)
```
diff --git a/programming/ios/api-reference/core/basic-structures/video-frame-tag.md b/programming/ios/api-reference/core/basic-structures/video-frame-tag.md
index 486f17c7..49fb13a0 100644
--- a/programming/ios/api-reference/core/basic-structures/video-frame-tag.md
+++ b/programming/ios/api-reference/core/basic-structures/video-frame-tag.md
@@ -29,7 +29,7 @@ The `DSVideoFrameTag` class represents a video frame tag, which is a type of ima
class VideoFrameTag : ImageTag
```
-## Methods & Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
@@ -75,7 +75,7 @@ The quality of the video frame.
```
2.
```swift
-var quality: EnumVideoFrameQuality { get }
+var quality: FrameQuality { get }
```
### isCropped
@@ -122,7 +122,7 @@ The original width of the video frame.
>
>1.
```objc
-@property (nonatomic, readonly, assign) NSInteger originalWidth;
+@property (nonatomic, readonly, assign) NSUInteger originalWidth;
```
2.
```swift
@@ -139,7 +139,7 @@ The original height of the video frame.
>
>1.
```objc
-@property (nonatomic, readonly, assign) NSInteger originalHeight;
+@property (nonatomic, readonly, assign) NSUInteger originalHeight;
```
2.
```swift
@@ -157,27 +157,27 @@ The constructor of `DSVideoFrameTag`.
>1.
```objc
- (instancetype)initWithImageId:(NSInteger)imageId
- clarity:(NSInteger)clarity
quality:(DSVideoFrameQuality)quality
isCropped:(BOOL)isCropped
cropRegion:(CGRect)cropRegion
- originalWidth:(NSInteger)originalWidth
- originalHeight:(NSInteger)originalHeight;
+ originalWidth:(NSUInteger)originalWidth
+ originalHeight:(NSUInteger)originalHeight
+ clarity:(NSInteger)clarity;
```
2.
```swift
-init(imageId: Int, clarity: Int, quality: EnumVideoFrameQuality, isCropped: Bool, cropRegion: CGRect, originalWidth: Int, originalHeight: Int)
+init(imageId: Int, quality: FrameQuality, isCropped: Bool, cropRegion: CGRect, originalWidth: Int, originalHeight: Int, clarity: Int)
```
**Parameters**
`imageId`: The image ID of the video frame.
-`clarity`: The clarity of the video frame.
`quality`: The quality of the video frame.
`isCropped`: Whether the video frame is cropped.
`cropRegion`: The crop region of the video frame.
`originalWidth`: The original width of the video frame.
`originalHeight`: The original height of the video frame.
+`clarity`: The clarity of the video frame.
**Return Value**
diff --git a/programming/ios/api-reference/core/enum/buffer-overflow-protection-mode.md b/programming/ios/api-reference/core/enum/buffer-overflow-protection-mode.md
index d8ab9730..5e80046f 100644
--- a/programming/ios/api-reference/core/enum/buffer-overflow-protection-mode.md
+++ b/programming/ios/api-reference/core/enum/buffer-overflow-protection-mode.md
@@ -23,9 +23,9 @@ codeAutoHeight: true
typedef NS_ENUM(NSInteger, DSBufferOverflowProtectionMode)
{
/** New images are blocked when the buffer is full.*/
- DSBufferOverflowProtectionModeBlock = 0,
+ DSBufferOverflowProtectionModeBlock,
/** New images are appended at the end, and oldest images are pushed out from the beginning if thebuffer is full.*/
- DSBufferOverflowProtectionModeUpdate = 1,
+ DSBufferOverflowProtectionModeUpdate,
}NS_SWIFT_NAME(BufferOverflowProtectionMode);
```
>
@@ -33,8 +33,8 @@ typedef NS_ENUM(NSInteger, DSBufferOverflowProtectionMode)
public enum BufferOverflowProtectionMode : Int
{
/** New images are blocked when the buffer is full.*/
- block = 0
+ case block = 0
/** New images are appended at the end, and oldest images are pushed out from the beginning if thebuffer is full.*/
- update = 1
+ case update = 1
}
```
diff --git a/programming/ios/api-reference/core/enum/captured-result-item-type.md b/programming/ios/api-reference/core/enum/captured-result-item-type.md
index 7825845a..be20997f 100644
--- a/programming/ios/api-reference/core/enum/captured-result-item-type.md
+++ b/programming/ios/api-reference/core/enum/captured-result-item-type.md
@@ -20,41 +20,41 @@ codeAutoHeight: true
>
>
```objc
-typedef NS_ENUM(NSInteger, DSCapturedResultItemType)
+typedef NS_OPTIONS(NSInteger, DSCapturedResultItemType)
{
- /** The captured result is a original image. You can convert it into a DSOriginalImageResultItem. */
- DSCapturedResultItemTypeOriginalImage = 1,
- /** The captured result is a decoded barcode. You can convert it into a DSBarcodeResultItem. */
- DSCapturedResultItemTypeBarcode = 2,
- /** The captured result is a recognized text line. You can convert it into a DSTextLineResultItem. */
- DSCapturedResultItemTypeTextLine = 4,
- /** The captured result is a detected quadrilateral. You can convert it into a DSDetectedQuadResultItem. */
- DSCapturedResultItemTypeDetectedQuad = 8,
- /** The captured result is a deskewed image. You can convert it into a DSDeskewedImageResultItem. */
- DSCapturedResultItemTypeDeskewedImage = 16,
- /** The captured result is a parsed result. You can convert it into a DSParsedResultItem. */
- DSCapturedResultItemTypeParsedResult = 32,
- /** The captured result is a enhanced image. You can convert it into a DSEnhancedImageItem. */
- DSCapturedResultItemTypeEnhancedImage = 64
+ /** Captured result item type original image.*/
+ DSCapturedResultItemTypeOriginalImage = 1 << 0,
+ /** Captured result item type barcode.*/
+ DSCapturedResultItemTypeBarcode = 1 << 1,
+ /** Captured result item type text line.*/
+ DSCapturedResultItemTypeTextLine = 1 << 2,
+ /** Captured result item type detected quad.*/
+ DSCapturedResultItemTypeDetectedQuad = 1 << 3,
+ /** Captured result item type deskewed image.*/
+ DSCapturedResultItemTypeDeskewedImage = 1 << 4,
+ /** Captured result item type parsed content.*/
+ DSCapturedResultItemTypeParsedResult = 1 << 5,
+ /** Captured result item type enhanced image.*/
+ DSCapturedResultItemTypeEnhancedImage = 1 << 6
};
```
>
```swift
-public enum CapturedResultItemType : Int
-{
- /** The captured result is a original image. You can convert it into a DSOriginalImageResultItem. */
- originalImage = 1
- /** The captured result is a decoded barcode. You can convert it into a DSBarcodeResultItem. */
- barcode = 2
- /** The captured result is a recognized text line. You can convert it into a DSTextLineResultItem. */
- textLine = 4
- /** The captured result is a detected quadrilateral. You can convert it into a DSDetectedQuadResultItem. */
- detectedQuad = 8
- /** The captured result is a Deskewed image. You can convert it into a DSDeskewedImageResultItem. */
- deskewedImage = 16
- /** The captured result is a parsed result. You can convert it into a DSParsedResultItem. */
- parsedResult = 32
- /** The captured result is a enhanced image. You can convert it into a DSEnhancedImageItem. */
- enhancedImage = 64
-};
+struct CapturedResultItemType: OptionSet {
+ let rawValue: Int
+ /** Captured result item type original image.*/
+ static let originalImage = CapturedResultItemType(rawValue: 1 << 0)
+ /** Captured result item type barcode.*/
+ static let barcode = CapturedResultItemType(rawValue: 1 << 1)
+ /** Captured result item type text line.*/
+ static let textLine = CapturedResultItemType(rawValue: 1 << 2)
+ /** Captured result item type detected quad.*/
+ static let detectedQuad = CapturedResultItemType(rawValue: 1 << 3)
+ /** Captured result item type deskewed image.*/
+ static let deskewedImage = CapturedResultItemType(rawValue: 1 << 4)
+ /** Captured result item type parsed content.*/
+ static let parsedResult = CapturedResultItemType(rawValue: 1 << 5)
+ /** Captured result item type enhanced image.*/
+ static let enhancedImage = CapturedResultItemType(rawValue: 1 << 6)
+}
```
diff --git a/programming/ios/api-reference/core/enum/colour-channel-usage-type.md b/programming/ios/api-reference/core/enum/colour-channel-usage-type.md
index 42f8b828..69e2d288 100644
--- a/programming/ios/api-reference/core/enum/colour-channel-usage-type.md
+++ b/programming/ios/api-reference/core/enum/colour-channel-usage-type.md
@@ -22,35 +22,35 @@ codeAutoHeight: true
```objc
typedef NS_ENUM(NSInteger, DSColourChannelUsageType)
{
- /** Automatic color channel usage determination based on image pixel format and scene. */
- DSColourChannelUsageTypeAuto = 0,
- /** Use all available color channels for processing. */
- DSColourChannelUsageTypeFullChannel = 1,
- /** Use only the Y (luminance) channel for processing in images represented in the NV21 format. */
- DSColourChannelUsageTypeNV21YChannelOnly = 2,
- /** Use only the red channel for processing in RGB images.*/
- DSColourChannelUsageTypeRGBRChannelOnly = 3,
- /** Use only the green channel for processing in RGB images.*/
- DSColourChannelUsageTypeRGBGChannelOnly = 4,
- /** Use only the blue channel for processing in RGB images.*/
- DSColourChannelUsageTypeRGBBChannelOnly = 5
+ /** Automatic color channel usage determination based on image pixel format and scene. */
+ DSColourChannelUsageTypeAuto,
+ /** Use all available color channels for processing. */
+ DSColourChannelUsageTypeFullChannel,
+ /** Use only the Y (luminance) channel for processing in images represented in the NV21 format. */
+ DSColourChannelUsageTypeYChannelOnly,
+ /** Use only the red channel for processing in RGB images.*/
+ DSColourChannelUsageTypeRGBRChannelOnly,
+ /** Use only the green channel for processing in RGB images.*/
+ DSColourChannelUsageTypeRGBGChannelOnly,
+ /** Use only the blue channel for processing in RGB images.*/
+ DSColourChannelUsageTypeRGBBChannelOnly
};
```
>
```swift
public enum ColourChannelUsageType : Int
{
- /** Automatic color channel usage determination based on image pixel format and scene. */
- auto = 0,
- /** Use all available color channels for processing. */
- fullChannel = 1,
- /** Use only the Y (luminance) channel for processing in images represented in the NV21 format. */
- nv21YChannelOnly = 2,
- /** Use only the red channel for processing in RGB images.*/
- rgbrChannelOnly = 3,
- /** Use only the green channel for processing in RGB images.*/
- rgbgChannelOnly = 4,
- /** Use only the blue channel for processing in RGB images.*/
- rgbbChannelOnly = 5
+ /** Automatic color channel usage determination based on image pixel format and scene. */
+ case auto = 0
+ /** Use all available color channels for processing. */
+ case fullChannel = 1
+ /** Use only the Y (luminance) channel for processing in images represented in the NV21 format. */
+ case yChannelOnly = 2
+ /** Use only the red channel for processing in RGB images.*/
+ case rgbrChannelOnly = 3
+ /** Use only the green channel for processing in RGB images.*/
+ case rgbgChannelOnly = 4
+ /** Use only the blue channel for processing in RGB images.*/
+ case rgbbChannelOnly = 5
};
```
diff --git a/programming/ios/api-reference/core/enum/corner-type.md b/programming/ios/api-reference/core/enum/corner-type.md
index 47615b27..508dbbad 100644
--- a/programming/ios/api-reference/core/enum/corner-type.md
+++ b/programming/ios/api-reference/core/enum/corner-type.md
@@ -37,12 +37,12 @@ typedef NS_ENUM(NSInteger, DSCornerType)
public enum CornerType : Int
{
/** The corner is formed by two intersecting line segments. */
- intersected
+ case intersected
/** The corner is formed by two T intersecting line segments. */
- tIntersected
+ case tIntersected
/** The corner is formed by two cross intersecting line segments. */
- crossIntersected
+ case crossIntersected
/** The two line segments are not intersected but they definitely consist a corner. */
- notIntersected
+ case notIntersected
};
```
diff --git a/programming/ios/api-reference/core/enum/cross-verification-status.md b/programming/ios/api-reference/core/enum/cross-verification-status.md
index 8c1c8140..4b7688e9 100644
--- a/programming/ios/api-reference/core/enum/cross-verification-status.md
+++ b/programming/ios/api-reference/core/enum/cross-verification-status.md
@@ -35,10 +35,10 @@ typedef NS_ENUM(NSInteger, DSCrossVerificationStatus)
public enum CrossVerificationStatus : Int
{
/** The cross verification has not been performed yet. */
- notVerified,
+ case notVerified
/** The cross verification has been passed successfully. */
- passed,
+ case passed
/** The cross verification has failed. */
- failed
+ case failed
};
```
diff --git a/programming/ios/api-reference/core/enum/error-code.md b/programming/ios/api-reference/core/enum/error-code.md
index 25aa0091..4ef4aad7 100644
--- a/programming/ios/api-reference/core/enum/error-code.md
+++ b/programming/ios/api-reference/core/enum/error-code.md
@@ -245,177 +245,177 @@ typedef NS_ERROR_ENUM(DSErrorDomain, DSError) {
public enum ErrorCode : Int
{
/**Successful. */
- oK = 0
+ case ok = 0
/**Unknown error. */
- unknown = -10000
+ case unknown = -10000
/**Not enough memory to perform the operation. */
- noMemory = -10001
+ case noMemory = -10001
/**Null pointer */
- nullPointer = -10002
+ case nullPointer = -10002
/**License invalid*/
- licenseInvalid = -10003
+ case licenseInvalid = -10003
/**License expired*/
- licenseExpired = -10004
+ case licenseExpired = -10004
/**File not found*/
- fileNotFound = -10005
+ case fileNotFound = -10005
/**The file type is not supported. */
- filetypeNotSupported = -10006
+ case filetypeNotSupported = -10006
/**The BPP (Bits Per Pixel) is not supported. */
- bppNotSupported = -10007
+ case bppNotSupported = -10007
/**Failed to read the image. */
- imageReadFailed = -10012
+ case imageReadFailed = -10012
/**Failed to read the TIFF image. */
- tiffReadFailed = -10013
+ case tiffReadFailed = -10013
/**The DIB (Device-Independent Bitmaps) buffer is invalid. */
- dibBufferInvalid = -10018,
+ case dibBufferInvalid = -10018,
/**Failed to read the PDF image. */
- pdfReadFailed = -10021
+ case pdfReadFailed = -10021
/**The PDF DLL is missing. */
- pdfDllMissing = -10022
+ case pdfDllMissing = -10022
/**The page number is invalid. */
- pageNumberInvalid = -10023
+ case pageNumberInvalid = -10023
/**The custom size is invalid. */
- customSizeInvalid = -10024
+ case customSizeInvalid = -10024
/** timeout. */
- timeout = -10026
+ case timeout = -10026
/**Json parse failed*/
- jsonParseFailed = -10030
+ case jsonParseFailed = -10030
/**Json type invalid*/
- jsonTypeInvalid = -10031
+ case jsonTypeInvalid = -10031
/**Json key invalid*/
- jsonKeyInvalid = -10032
+ case jsonKeyInvalid = -10032
/**Json value invalid*/
- jsonValueInvalid = -10033
+ case jsonValueInvalid = -10033
/**Json name key missing*/
- jsonNameKeyMissing = -10034
+ case jsonNameKeyMissing = -10034
/**The value of the key "Name" is duplicated.*/
- jsonNameValueDuplicated = -10035
+ case jsonNameValueDuplicated = -10035
/**Template name invalid*/
- templateNameInvalid = -10036
+ case templateNameInvalid = -10036
/**The name reference is invalid.*/
- jsonNameReferenceInvalid = -10037
+ case jsonNameReferenceInvalid = -10037
/**Parameter value invalid*/
- parameterValueInvalid = -10038
+ case parameterValueInvalid = -10038
/**The domain of your current site does not match the domain bound in the current product key.*/
- domainNotMatch = -10039
+ case domainNotMatch = -10039
/**The license key does not match the license content.*/
- licenseKeyNotMatch = -10043
+ case licenseKeyNotMatch = -10043
/**Failed to set mode's argument.*/
- setModeArgumentError = -10051
+ case setModeArgumentError = -10051
/**Failed to get mode's argument.*/
- getModeArgumentError = -10055
+ case getModeArgumentError = -10055
/**The Intermediate Result Types license is invalid.*/
- irtLicenseInvalid = -10056
+ case irtLicenseInvalid = -10056
/**Failed to save file.*/
- fileSaveFailed = -10058
+ case fileSaveFailed = -10058
/**The stage type is invalid.*/
- stageTypeInvalid = -10059
+ case stageTypeInvalid = -10059
/**The image orientation is invalid.*/
- imageOrientationInvalid = -10060
+ case imageOrientationInvalid = -10060
/**Failed to convert complex tempalte to simplified settings.*/
- convertComplexTemplateError = -10061
+ case convertComplexTemplateError = -10061
/**Reject function call while capturing in progress.*/
- callRejectedWhenCapturing = -10062
+ case callRejectedWhenCapturing = -10062
/**The input image source was not found.*/
- noImageSource = -10063
+ case noImageSource = -10063
/**Failed to read directory.*/
- readDirectoryFailed = -10064
+ case readDirectoryFailed = -10064
/**[Name] Module not found.*/
/**Name : */
/**DynamsoftBarcodeReader*/
/**DynamsoftLabelRecognizer*/
/**DynamsoftDocumentNormalizer*/
- moduleNotFound = -10065
+ case moduleNotFound = -10065
/**The file already exists but overwriting is disabled.*/
- fileAlreadyExists = -10067
+ case fileAlreadyExists = -10067
/**The file path does not exist but cannot be created, or cannot be created for any other reason.*/
- createFileFailed = -10068
+ case createFileFailed = -10068
/**The input ImageData object contains invalid parameter(s).*/
- imageDataInvalid = -10069
+ case imageDataInvalid = -10069
/**The size of the input image does not meet the requirements.*/
- imageSizeNotMatch = -10070
+ case imageSizeNotMatch = -10070
/**The pixel format of the input image does not meet the requirements.*/
- imagePixelFormatNotMatch = -10071
+ case imagePixelFormatNotMatch = -10071
/**The section level result is irreplaceable.*/
- sectionLevelResultIrreplaceable = -10072
+ case sectionLevelResultIrreplaceable = -10072
/**The axis definition is incorrect.*/
- axisDefinitionIncorrect = -10073
+ case axisDefinitionIncorrect = -10073
/**The result is not replaceable due to type mismatch*/
- resultTypeMismatchIrreplaceable = -10074
+ case resultTypeMismatchIrreplaceable = -10074
/**Failed to load the PDF library.*/
- pdfLibraryLoadFailed = -10075
+ case pdfLibraryLoadFailed = -10075
/*The license is initialized successfully but detected invalid content in your key.*/
- licenseWarning = -10076
+ case licenseWarning = -10076
/*One or more unsupported JSON keys were encountered and ignored from the template.*/
- unsupportedJsonKeyWarning = -10077,
+ case unsupportedJsonKeyWarning = -10077,
/**Model file is not found*/
- modelFileNotFount = -10078,
+ case modelFileNotFount = -10078,
/**[PDF] No license found.*/
- pdfLicenseNotFound = -10079,
+ case pdfLicenseNotFound = -10079,
/**The rectangle is invalid.*/
- rectInvalid = -10080,
+ case rectInvalid = -10080,
/**No license.*/
- noLicense = -20000
+ case noLicense = -20000
/**Failed to read or write license cache. */
- licenseBufferFailed = -20002
+ case licenseBufferFailed = -20002
/**Falied to synchronize license info wirh license tracking server. */
- licenseSyncFailed = -20003
+ case licenseSyncFailed = -20003
/**Device does not match with license buffer. */
- deviceNotMatch = -20004
+ case deviceNotMatch = -20004
/**Falied to bind device. */
- bindDeviceFailed = -20005
+ case bindDeviceFailed = -20005
/**Install.*/
- instanceCountOverLimit = -20008
+ case instanceCountOverLimit = -20008
/**Trial License*/
- trialLicense = -20010
+ case trialLicense = -20010
/**The license is not valid for current version*/
- licenseVersionNotMatch = -20011
+ case licenseVersionNotMatch = -20011
/** -30000~-39999: DBR error code. */
/** The barcode format is invalid. */
- barcodeFormatInvalid = -30009
+ case barcodeFormatInvalid = -30009
/** The custom module size is invalid. */
- customModuleSizeInvalid = -30025
+ case customModuleSizeInvalid = -30025
/*[Barcode Reader] No license found.*/
- dbrLicenseNotFound = -30063
+ case dbrLicenseNotFound = -30063
/** -40000~-49999: DLR error code */
/** There is a conflict in the layout of TextLineGroup. */
- textLineGroupLayoutConflict = -40101
+ case textLineGroupLayoutConflict = -40101
/** There is a conflict in the regex of TextLineGroup. */
- textLineGroupRegexConflict = -40102
+ case textLineGroupRegexConflict = -40102
/*[Label Recognizer] No license found.*/
- dlrLicenseNotFound = -40103
+ case dlrLicenseNotFound = -40103
/** -50000~-59999: DDN error code. */
/** No content has been detected. */
- contentNotFound = -50056
+ case contentNotFound = -50056
/*The quardrilateral is invalid. */
- quardrilateralInvalid = -50057
+ case quardrilateralInvalid = -50057
/*[Document Normalizer] No license found.*/
- ddnLicenseNotFound = -50058
+ case ddnLicenseNotFound = -50058
/** -60000~-69999: DCE error code. */
/** The camera module is not exist. */
- cameraModelNotExist = -60003
+ case cameraModelNotExist = -60003
/** The camera id does not exist. */
- cameraIDNotExist = -60006
+ case cameraIDNotExist = -60006
/** The sensor does not exist. */
- noSensor = -60045
+ case noSensor = -60045
/** The camera type is not supported.*/
- cameraTypeNotSupported = -60046;
+ case cameraTypeNotSupported = -60046;
/**-70000~-79999: Panorama error code. */
/**The panorama license is invalid. */
- panoramaLicenseInvalid = -70060
+ case panoramaLicenseInvalid = -70060
/** -80000~-89999: Reserved error code. */
/**-90000~-99999: DCP error code. */
/** The resource path is not exist. */
- resourcePathNotExist = -90001
+ case resourcePathNotExist = -90001
/** Failed to load resource. */
- resourceLoadFailed = -90002
+ case resourceLoadFailed = -90002
/** The code specification is not found. */
- codeSpecificationNotFound = -90003
+ case codeSpecificationNotFound = -90003
/** The full code string is empty. */
- fullCodeEmpty = -90004
+ case fullCodeEmpty = -90004
/** Failed to preprocess the full code string */
- fullCodePreprocessFailed = -90005
+ case fullCodePreprocessFailed = -90005
/*[Code Parser] No license found.*/
- dcpLicenseNotFound = -90012
+ case dcpLicenseNotFound = -90012
}
```
diff --git a/programming/ios/api-reference/core/enum/grayscale-enhancement-mode.md b/programming/ios/api-reference/core/enum/grayscale-enhancement-mode.md
index 1c94883d..5da2e530 100644
--- a/programming/ios/api-reference/core/enum/grayscale-enhancement-mode.md
+++ b/programming/ios/api-reference/core/enum/grayscale-enhancement-mode.md
@@ -22,43 +22,43 @@ codeAutoHeight: true
```objc
typedef NS_ENUM(NSInteger, DSGrayscaleEnhancementMode)
{
+ /**Skips image preprocessing. */
+ DSGrayscaleEnhancementModeSkip = 0,
/**Not supported yet. */
- DSGrayscaleEnhancementModeAuto = 1,
+ DSGrayscaleEnhancementModeAuto = 1 << 0,
/**Takes the unpreprocessed image for following operations.*/
- DSGrayscaleEnhancementModeGeneral = 2,
+ DSGrayscaleEnhancementModeGeneral = 1 << 1,
/**Preprocesses the image using the gray equalization algorithm. Check @ref IPM for available argument settings.*/
- DSGrayscaleEnhancementModeGrayEqualize = 4,
+ DSGrayscaleEnhancementModeGrayEqualize = 1 << 2,
/**Preprocesses the image using the gray smoothing algorithm. Check @ref IPM for available argument settings.*/
- DSGrayscaleEnhancementModeGraySmooth = 8,
+ DSGrayscaleEnhancementModeGraySmooth = 1 << 3,
/**Preprocesses the image using the sharpening and smoothing algorithm. Check @ref IPM for available argument settings.*/
- DSGrayscaleEnhancementModeSharpenSmooth = 16,
- /**Reserved setting for image preprocessing mode.*/
- DSGrayscaleEnhancementModeRev = -2147483648,
- /**Skips image preprocessing. */
- DSGrayscaleEnhancementModeSkip = 0,
+ DSGrayscaleEnhancementModeSharpenSmooth = 1 << 4,
/**Placeholder value with no functional meaning. */
- DSGrayscaleEnhancementModeEnd = 0xFFFFFFFF
+ DSGrayscaleEnhancementModeEnd = -1,
+ /**Reserved setting for image preprocessing mode.*/
+ DSGrayscaleEnhancementModeRev = NSIntegerMin
};
```
>
```swift
public enum GrayscaleEnhancementMode : Int
{
+ /**Skips image preprocessing. */
+ case skip = 0
/**Not supported yet. */
- auto = 1
+ case auto = 1 << 0
/**Takes the unpreprocessed image for following operations.*/
- general = 2
+ case general = 1 << 1
/**Preprocesses the image using the gray equalization algorithm. Check @ref IPM for available argument settings.*/
- grayEqualize = 4
+ case grayEqualize = 1 << 2
/**Preprocesses the image using the gray smoothing algorithm. Check @ref IPM for available argument settings.*/
- graySmooth = 8
+ case graySmooth = 1 << 3
/**Preprocesses the image using the sharpening and smoothing algorithm. Check @ref IPM for available argument settings.*/
- sharpenSmooth = 16
- /**Reserved setting for image preprocessing mode.*/
- rev = -2147483648
- /**Skips image preprocessing. */
- skip = 0
+ case sharpenSmooth = 1 << 4
/**Placeholder value with no functional meaning. */
- end = 0xFFFFFFFF
+ case end = -1
+ /**Reserved setting for image preprocessing mode.*/
+ case rev = Int.min
}
```
diff --git a/programming/ios/api-reference/core/enum/grayscale-transformation-mode.md b/programming/ios/api-reference/core/enum/grayscale-transformation-mode.md
index 569bc7db..f77a836f 100644
--- a/programming/ios/api-reference/core/enum/grayscale-transformation-mode.md
+++ b/programming/ios/api-reference/core/enum/grayscale-transformation-mode.md
@@ -22,35 +22,35 @@ codeAutoHeight: true
```objc
typedef NS_ENUM(NSInteger, DSGrayscaleTransformationMode)
{
+ /** Skips grayscale transformation. */
+ DSGrayscaleTransformationModeSkip = 0,
/** Transforms to the inverted grayscale for further reference. This value is recommended for light on dark images. */
- DSGrayscaleTransformationModeInverted = 0x01,
+ DSGrayscaleTransformationModeInverted = 1 << 0,
/** Keeps the original grayscale for further reference. This value is recommended for dark on light images. */
- DSGrayscaleTransformationModeOriginal = 0x02,
+ DSGrayscaleTransformationModeOriginal = 1 << 1,
/**Lets the library choose an algorithm automatically for grayscale transformation.*/
- DSGrayscaleTransformationModeAuto = 0x04,
- /** Skips grayscale transformation. */
- DSGrayscaleTransformationModeSkip = 0x00,
- /** Reserved setting for grayscale transformation mode. */
- DSGrayscaleTransformationModeRev = -2147483648,
+ DSGrayscaleTransformationModeAuto = 1 << 2,
/** Placeholder value with no functional meaning. */
- DSGrayscaleTransformationModeEnd = 0xFFFFFFFF
+ DSGrayscaleTransformationModeEnd = -1,
+ /** Reserved setting for grayscale transformation mode. */
+ DSGrayscaleTransformationModeRev = NSIntegerMin
};
```
>
```swift
public enum GrayscaleTransformationMode : Int
{
+ /** Skips grayscale transformation. */
+ case skip = 0
/** Transforms to the inverted grayscale for further reference. This value is recommended for light on dark images. */
- inverted = 0x01
+ case inverted = 1 << 0
/** Keeps the original grayscale for further reference. This value is recommended for dark on light images. */
- original = 0x02
+ case original = 1 << 1
/**Lets the library choose an algorithm automatically for grayscale transformation.*/
- auto = 0x04
- /** Skips grayscale transformation. */
- skip = 0x00
- /** Reserved setting for grayscale transformation mode. */
- rev = -2147483648
+ case auto = 1 << 2
/** Placeholder value with no functional meaning. */
- end = 0xFFFFFFFF
+ case end = -1
+ /** Reserved setting for grayscale transformation mode. */
+ case rev = Int.min
}
```
diff --git a/programming/ios/api-reference/core/enum/image-capture-distance-mode.md b/programming/ios/api-reference/core/enum/image-capture-distance-mode.md
index c0f93f42..c5dd1454 100644
--- a/programming/ios/api-reference/core/enum/image-capture-distance-mode.md
+++ b/programming/ios/api-reference/core/enum/image-capture-distance-mode.md
@@ -33,8 +33,8 @@ typedef NS_ENUM(NSInteger, DSImageCaptureDistanceMode)
public enum ImageCaptureDistanceMode : Int
{
/** The image is taken by close-up shot camera. */
- near
+ case near
/** The image is taken by long shot camera. */
- far
+ case far
}
```
diff --git a/programming/ios/api-reference/core/enum/image-pixel-format.md b/programming/ios/api-reference/core/enum/image-pixel-format.md
index 40940bf2..f2cbec22 100644
--- a/programming/ios/api-reference/core/enum/image-pixel-format.md
+++ b/programming/ios/api-reference/core/enum/image-pixel-format.md
@@ -31,27 +31,29 @@ typedef NS_ENUM(NSInteger, DSImagePixelFormat)
/** NV21 */
DSImagePixelFormatNV21,
/** 16bit with RGB channel order stored in memory from high to low address*/
- DSImagePixelFormatRGB_565,
+ DSImagePixelFormatRGB565,
/** 16bit with RGB channel order stored in memory from high to low address*/
- DSImagePixelFormatRGB_555,
+ DSImagePixelFormatRGB555,
/** 24bit with RGB channel order stored in memory from high to low address*/
- DSImagePixelFormatRGB_888,
+ DSImagePixelFormatRGB888,
/** 32bit with ARGB channel order stored in memory from high to low address*/
- DSImagePixelFormatARGB_8888,
+ DSImagePixelFormatARGB8888,
/** 48bit with RGB channel order stored in memory from high to low address*/
- DSImagePixelFormatRGB_161616,
+ DSImagePixelFormatRGB161616,
/** 64bit with ARGB channel order stored in memory from high to low address*/
- DSImagePixelFormatARGB_16161616,
+ DSImagePixelFormatARGB16161616,
/** 32bit with ABGB channel order stored in memory from high to low address */
- DSImagePixelFormatABGR_8888,
+ DSImagePixelFormatABGR8888,
/** 64bit with ABGR channel order stored in memory from high to low address*/
- DSImagePixelFormatABGR_16161616,
+ DSImagePixelFormatABGR16161616,
/** 24bit with BGR channel order stored in memory from high to low address*/
- DSImagePixelFormatBGR_888,
+ DSImagePixelFormatBGR888,
/** 0:black, 255:white */
- DSImagePixelFormatBinary_8,
+ DSImagePixelFormatBinary8,
/**NV12 */
- DSImagePixelFormatNV12
+ DSImagePixelFormatNV12,
+ /** 0:white, 255:black */
+ DSImagePixelFormatBinary8Inverted
};
```
>
@@ -59,34 +61,36 @@ typedef NS_ENUM(NSInteger, DSImagePixelFormat)
public enum ImagePixelFormat : Int
{
/** 0:black, 1:white */
- binary
+ case binary
/** 0:white, 1:black */
- binaryInverted
+ case binaryInverted
/** 8-bit gray */
- grayScaled
+ case grayScaled
/** NV21 */
- NV21
+ case NV21
/** 16bit with RGB channel order stored in memory from high to low address*/
- RGB_565
+ case RGB565
/** 16bit with RGB channel order stored in memory from high to low address*/
- RGB_555
+ case RGB555
/** 24bit with RGB channel order stored in memory from high to low address*/
- RGB_888
+ case RGB888
/** 32bit with ARGB channel order stored in memory from high to low address*/
- ARGB_8888
+ case ARGB8888
/** 48bit with RGB channel order stored in memory from high to low address*/
- RGB_161616
+ case RGB161616
/** 64bit with ARGB channel order stored in memory from high to low address*/
- ARGB_16161616
+ case ARGB16161616
/** 32bit with ABGB channel order stored in memory from high to low address */
- ABGR_8888
+ case ABGR8888
/** 64bit with ABGR channel order stored in memory from high to low address*/
- ABGR_16161616
+ case ABGR16161616
/** 24bit with BGR channel order stored in memory from high to low address*/
- BGR_888
+ case BGR888
/** 0:black, 255:white */
- binary8
+ case binary8
/**NV12 */
- NV12
+ case NV12
+ /**NV12 */
+ case binary8Inverted
}
```
diff --git a/programming/ios/api-reference/core/enum/image-source-state.md b/programming/ios/api-reference/core/enum/image-source-state.md
index 8f0da73f..c75fb135 100644
--- a/programming/ios/api-reference/core/enum/image-source-state.md
+++ b/programming/ios/api-reference/core/enum/image-source-state.md
@@ -35,8 +35,8 @@ typedef NS_ENUM(NSInteger, DSImageSourceState)
public enum ImageSourceState : Int
{
/** The buffer of ImageSourceAdapter is temporarily empty. */
- bufferEmpty = 0
+ case bufferEmpty = 0
/** The source of ImageSourceAdapter is empty. */
- exhausted = 1
+ case exhausted = 1
};
```
diff --git a/programming/ios/api-reference/core/enum/image-tag-type.md b/programming/ios/api-reference/core/enum/image-tag-type.md
index bdc0344d..72944de1 100644
--- a/programming/ios/api-reference/core/enum/image-tag-type.md
+++ b/programming/ios/api-reference/core/enum/image-tag-type.md
@@ -23,9 +23,9 @@ codeAutoHeight: true
typedef NS_ENUM(NSInteger, DSImageTagType)
{
/**The image tag is a DSFileImageTag.*/
- DSImageTagTypeFileImage = 0,
+ DSImageTagTypeFileImage,
/**The image tag is a DSVideoFrameTag.*/
- DSImageTagTypeVideoFrame = 1,
+ DSImageTagTypeVideoFrame
};
```
>
@@ -33,8 +33,8 @@ typedef NS_ENUM(NSInteger, DSImageTagType)
public enum ImageTagType : Int
{
/**The image tag is a DSFileImageTag.*/
- fileImage = 0,
+ case fileImage
/**The image tag is a DSVideoFrameTag.*/
- videoFrame = 1,
+ case videoFrame
}
```
diff --git a/programming/ios/api-reference/core/enum/intermediate-result-unit-type.md b/programming/ios/api-reference/core/enum/intermediate-result-unit-type.md
index 5fc7a3da..c01f6ef0 100644
--- a/programming/ios/api-reference/core/enum/intermediate-result-unit-type.md
+++ b/programming/ios/api-reference/core/enum/intermediate-result-unit-type.md
@@ -91,72 +91,73 @@ typedef NS_OPTIONS(NSUInteger, DSIntermediateResultUnitType) {
```
>
```swift
-public enum IntermediateResultUnitType: Int {
- /** No intermediate result. */
- case null = 0
- /** A scaled full-color image. */
- case scaledColourImage = 1
- /** A color image that has been scaled down for efficiency. */
- case scaledDownColourImage = 1 << 1
- /** A grayscale image derived from the original input. */
- case grayscaleImage = 1 << 2
- /** A grayscale image that has undergone transformation. */
- case transformedGrayscaleImage = 1 << 3
- /** A grayscale image enhanced for further processing. */
- case enhancedGrayscaleImage = 1 << 4
- /** Regions pre-detected as potentially relevant for further analysis. */
- case predetectedRegions = 1 << 5
- /** A binary (black and white) image. */
- case binaryImage = 1 << 6
- /** Results from detecting textures within the image. */
- case textureDetectionResult = 1 << 7
- /** A grayscale image with textures removed to enhance subject details like text or barcodes. */
- case textureRemovedGrayscaleImage = 1 << 8
- /** A binary image with textures removed, useful for clear detection of subjects without background noise. */
- case textureRemovedBinaryImage = 1 << 9
- /** Detected contours within the image, which can help in identifying shapes and objects. */
- case contours = 1 << 10
- /** Detected line segments, useful in structural analysis of the image content. */
- case lineSegments = 1 << 11
- /** Identified text zones, indicating areas with potential textual content. */
- case textZones = 1 << 12
- /** A binary image with text regions removed. */
- case textRemovedBinaryImage = 1 << 13
- /** Zones identified as potential barcode areas, aiding in focused barcode detection. */
- case candidateBarcodeZones = 1 << 14
- /** Barcodes that have been localized but not yet decoded. */
- case localizedBarcodes = 1 << 15
- /** Barcode images scaled up or down for improving speed, readability or decoding accuracy. */
- case scaledBarcodeImage = 1 << 16
- /** Images of barcodes processed to resist deformation and improve decoding success. */
- case deformationResistedBarcodeImage = 1 << 17
- /** Barcode images that have been complemented. */
- case complementedBarcodeImage = 1 << 18
- /** Successfully decoded barcodes. */
- case decodedBarcodes = 1 << 19
- /** Detected long lines. */
- case longLines = 1 << 20
- /** Detected corners within the image. */
- case corners = 1 << 21
- /** Candidate edges identified as potential components of quadrilaterals. */
- case candidateQuadEdges = 1 << 22
- /** Successfully detected quadrilaterals. */
- case detectedQuads = 1 << 23
- /** Text lines that have been localized in preparation for recognition. */
- case localizedTextLines = 1 << 24
- /** Successfully recognized text lines. */
- case recognizedTextLines = 1 << 25
- /** Successfully deskewed images. */
- case deskewedImages = 1 << 26
- /** Detected short lines. */
- case shortLines = 1 << 27
- /** Recognized raw text lines. */
- rawTextLines = 1 << 28
- /**Detected logic lines.*/
- logicLines = 1 << 29
- /** Successfully enhanced images. */
- enhancedImages = 1 << 30
- /** A mask to select all types of intermediate results. */
- case all = 0xFFFFFFFFFFFFFFFF
+struct IntermediateResultUnitType: OptionSet {
+ let rawValue: Int
+ /** No intermediate result. */
+ static let null = IntermediateResultUnitType(rawValue: 0)
+ /** A scaled full-color image. */
+ static let scaledColourImage = IntermediateResultUnitType(rawValue: 1 << 0)
+ /** A color image that has been scaled down for efficiency. */
+ static let scaledDownColourImage = IntermediateResultUnitType(rawValue: 1 << 1)
+ /** A grayscale image derived from the original input. */
+ static let grayscaleImage = IntermediateResultUnitType(rawValue: 1 << 2)
+ /** A grayscale image that has undergone transformation. */
+ static let transformedGrayscaleImage = IntermediateResultUnitType(rawValue: 1 << 3)
+ /** A grayscale image enhanced for further processing. */
+ static let enhancedGrayscaleImage = IntermediateResultUnitType(rawValue: 1 << 4)
+ /** Regions pre-detected as potentially relevant for further analysis. */
+ static let predetectedRegions = IntermediateResultUnitType(rawValue: 1 << 5)
+ /** A binary (black and white) image. */
+ static let binaryImage = IntermediateResultUnitType(rawValue: 1 << 6)
+ /** Results from detecting textures within the image. */
+ static let textureDetectionResult = IntermediateResultUnitType(rawValue: 1 << 7)
+ /** A grayscale image with textures removed to enhance subject details like text or barcodes. */
+ static let textureRemovedGrayscaleImage = IntermediateResultUnitType(rawValue: 1 << 8)
+ /** A binary image with textures removed, useful for clear detection of subjects without background noise. */
+ static let textureRemovedBinaryImage = IntermediateResultUnitType(rawValue: 1 << 9)
+ /** Detected contours within the image, which can help in identifying shapes and objects. */
+ static let contours = IntermediateResultUnitType(rawValue: 1 << 10)
+ /** Detected line segments, useful in structural analysis of the image content. */
+ static let lineSegments = IntermediateResultUnitType(rawValue: 1 << 11)
+ /** Identified text zones, indicating areas with potential textual content. */
+ static let textZones = IntermediateResultUnitType(rawValue: 1 << 12)
+ /** A binary image with text regions removed. */
+ static let textRemovedBinaryImage = IntermediateResultUnitType(rawValue: 1 << 13)
+ /** Zones identified as potential barcode areas, aiding in focused barcode detection. */
+ static let candidateBarcodeZones = IntermediateResultUnitType(rawValue: 1 << 14)
+ /** Barcodes that have been localized but not yet decoded. */
+ static let localizedBarcodes = IntermediateResultUnitType(rawValue: 1 << 15)
+ /** Barcode images scaled up or down for improving speed, readability or decoding accuracy. */
+ static let scaledBarcodeImage = IntermediateResultUnitType(rawValue: 1 << 16)
+ /** Images of barcodes processed to resist deformation and improve decoding success. */
+ static let deformationResistedBarcodeImage = IntermediateResultUnitType(rawValue: 1 << 17)
+ /** Barcode images that have been complemented. */
+ static let complementedBarcodeImage = IntermediateResultUnitType(rawValue: 1 << 18)
+ /** Successfully decoded barcodes. */
+ static let decodedBarcodes = IntermediateResultUnitType(rawValue: 1 << 19)
+ /** Detected long lines. */
+ static let longLines = IntermediateResultUnitType(rawValue: 1 << 20)
+ /** Detected corners within the image. */
+ static let corners = IntermediateResultUnitType(rawValue: 1 << 21)
+ /** Candidate edges identified as potential components of quadrilaterals. */
+ static let candidateQuadEdges = IntermediateResultUnitType(rawValue: 1 << 22)
+ /** Successfully detected quadrilaterals. */
+ static let detectedQuads = IntermediateResultUnitType(rawValue: 1 << 23)
+ /** Text lines that have been localized in preparation for recognition. */
+ static let localizedTextLines = IntermediateResultUnitType(rawValue: 1 << 24)
+ /** Successfully recognized text lines. */
+ static let recognizedTextLines = IntermediateResultUnitType(rawValue: 1 << 25)
+ /** Successfully deskewed images. */
+ static let deskewedImages = IntermediateResultUnitType(rawValue: 1 << 26)
+ /** Detected short lines. */
+ static let shortLines = IntermediateResultUnitType(rawValue: 1 << 27)
+ /** Recognized raw text lines. */
+ rawTextLines = IntermediateResultUnitType(rawValue: 1 << 28)
+ /**Detected logic lines.*/
+ logicLines = IntermediateResultUnitType(rawValue: 1 << 29)
+ /** Successfully enhanced images. */
+ enhancedImages = IntermediateResultUnitType(rawValue: 1 << 30)
+ /** A mask to select all types of intermediate results. */
+ static let all = 0xFFFFFFFFFFFFFFFF
}
```
diff --git a/programming/ios/api-reference/core/enum/log-mode.md b/programming/ios/api-reference/core/enum/log-mode.md
index 79d618f8..0703e62f 100644
--- a/programming/ios/api-reference/core/enum/log-mode.md
+++ b/programming/ios/api-reference/core/enum/log-mode.md
@@ -25,11 +25,11 @@ typedef NS_ENUM(NSInteger, DSLogMode)
/**
* Output the log information in the console.
*/
- DSLogModeConsole = 1,
+ DSLogModeConsole = 1 << 0,
/**
* Output the log information to a log file.
*/
- DSLogModeFile = 2,
+ DSLogModeFile = 1 << 1,
};
```
>
@@ -39,10 +39,10 @@ public enum LogMode : Int
/**
* Output the log information in the console.
*/
- console = 0x01
+ case console = 1 << 0
/**
* Output the log information to a log file.
*/
- file = 0x02
+ case file = 1 << 1
};
```
diff --git a/programming/ios/api-reference/core/enum/pdf-reading-mode.md b/programming/ios/api-reference/core/enum/pdf-reading-mode.md
index b43972b4..8a1a7527 100644
--- a/programming/ios/api-reference/core/enum/pdf-reading-mode.md
+++ b/programming/ios/api-reference/core/enum/pdf-reading-mode.md
@@ -23,14 +23,14 @@ codeAutoHeight: true
typedef NS_ENUM(NSInteger, DSPDFReadingMode)
{
/** Capture content from vector data in PDF file. */
- DSPDFReadingModeVector = 0x01,
+ DSPDFReadingModeVector = 1,
/** The default value.
* Outputs raster data found in the PDFs.
* Depending on the argument Resolution, the SDK may rasterize the PDF pages.
* Check the template for available argument settings. */
- DSPDFReadingModeRaster = 0x02,
+ DSPDFReadingModeRaster = 2,
/** Reserved setting for PDF reading mode.*/
- DSPDFReadingModeRev = -2147483648
+ DSPDFReadingModeRev = NSIntegerMin
};
```
>
@@ -38,13 +38,13 @@ typedef NS_ENUM(NSInteger, DSPDFReadingMode)
public enum PDFReadingMode : Int
{
/** Capture content from vector data in PDF file. */
- vector = 0x01,
+ case vector = 1
/** The default value.
* Outputs raster data found in the PDFs.
* Depending on the argument Resolution, the SDK may rasterize the PDF pages.
* Check the template for available argument settings. */
- raster = 0x02,
+ case raster = 2
/** Reserved setting for PDF reading mode.*/
- rev = -2147483648
+ case rev = Int.min
};
```
diff --git a/programming/ios/api-reference/core/enum/raster-data-source.md b/programming/ios/api-reference/core/enum/raster-data-source.md
index ecd082d5..3d24b0f7 100644
--- a/programming/ios/api-reference/core/enum/raster-data-source.md
+++ b/programming/ios/api-reference/core/enum/raster-data-source.md
@@ -22,9 +22,9 @@ breadcrumbText: RasterDataSource
typedef NS_ENUM(NSInteger, DSRasterDataSource)
{
/**The raster data source type of the PDF file is "pages". Only available for PDFReadingMode raster.*/
- DSRasterDataSourceRasterizedPages = 0,
+ DSRasterDataSourceRasterizedPages,
/**The raster data source type of the PDF file is "images".*/
- DSRasterDataSourceExtractedImages = 1
+ DSRasterDataSourceExtractedImages
}NS_SWIFT_NAME(RasterDataSource);
```
>
@@ -32,8 +32,8 @@ typedef NS_ENUM(NSInteger, DSRasterDataSource)
public enum RasterDataSource : Int
{
/**The raster data source type of the PDF file is "pages". Only available for PDFReadingMode raster.*/
- rasterizedPages = 0,
+ case rasterizedPages
/**The raster data source type of the PDF file is "images".*/
- extractedImages = 1
+ case extractedImages
}
```
diff --git a/programming/ios/api-reference/core/enum/region-object-element-type.md b/programming/ios/api-reference/core/enum/region-object-element-type.md
index 1889d9bb..92b03698 100644
--- a/programming/ios/api-reference/core/enum/region-object-element-type.md
+++ b/programming/ios/api-reference/core/enum/region-object-element-type.md
@@ -23,21 +23,21 @@ codeAutoHeight: true
typedef NS_ENUM(NSInteger, DSRegionObjectElementType)
{
/**The type of subclass PredetectedRegionElement.*/
- DSRegionObjectElementTypePredetectedRegion = 0,
+ DSRegionObjectElementTypePredetectedRegion,
/**The type of subclass LocalizedBarcodeElement.*/
- DSRegionObjectElementTypeLocalizedBarcode = 1,
+ DSRegionObjectElementTypeLocalizedBarcode,
/**The type of subclass DecodedBarcodeElement.*/
- DSRegionObjectElementTypeDecodedBarcode = 2,
+ DSRegionObjectElementTypeDecodedBarcode,
/**The type of subclass LocalizedTextLineElement.*/
- DSRegionObjectElementTypeLocalizedTextLine = 3,
+ DSRegionObjectElementTypeLocalizedTextLine,
/**The type of subclass RecognizedTextLineElement.*/
- DSRegionObjectElementTypeRecognizedTextLine = 4,
+ DSRegionObjectElementTypeRecognizedTextLine,
/**The type of subclass DetectedQuadElement.*/
- DSRegionObjectElementTypeDetectedQuad = 5,
+ DSRegionObjectElementTypeDetectedQuad,
/**The type of subclass DeskewedImageElement.*/
- DSRegionObjectElementTypeDeskewedImage = 6,
+ DSRegionObjectElementTypeDeskewedImage,
/**The type of subclass EnhancedImageElement.*/
- DSRegionObjectElementTypeEnhancedImage = 7
+ DSRegionObjectElementTypeEnhancedImage
};
```
>
@@ -45,20 +45,20 @@ typedef NS_ENUM(NSInteger, DSRegionObjectElementType)
public enum RegionObjectElementType : Int
{
/**The type of subclass PredetectedRegionElement.*/
- predetectedRegion = 0,
+ case predetectedRegion
/**The type of subclass LocalizedBarcodeElement.*/
- localizedBarcode = 1,
+ case localizedBarcode
/**The type of subclass DecodedBarcodeElement.*/
- decodedBarcode = 2,
+ case decodedBarcode
/**The type of subclass LocalizedTextLineElement.*/
- localizedTextLine = 3,
+ case localizedTextLine
/**The type of subclass RecognizedTextLineElement.*/
- recognizedTextLine = 4,
+ case recognizedTextLine
/**The type of subclass DetectedQuadElement.*/
- detectedQuad = 5,
+ case detectedQuad
/**The type of subclass DeskewedImageElement.*/
- deskewedImage = 6
+ case deskewedImag
/**The type of subclass EnhancedImageElement.*/
- enhancedImage = 7
+ case enhancedImage
}
```
diff --git a/programming/ios/api-reference/core/enum/section-type.md b/programming/ios/api-reference/core/enum/section-type.md
index b7b86014..d11faff4 100644
--- a/programming/ios/api-reference/core/enum/section-type.md
+++ b/programming/ios/api-reference/core/enum/section-type.md
@@ -24,21 +24,23 @@ codeAutoHeight: true
typedef NS_ENUM(NSInteger, DSSectionType)
{
/**No section type is specified.*/
- DSSectionTypeNull = 0,
+ DSSectionTypeNull,
/**The result is output by "region prediction" section.*/
- DSSectionTypeRegionPredection = 1,
+ DSSectionTypeRegionPredection,
/**The result is output by "barcode localization" section.*/
- DSSectionTypeBarcodeLocalization = 2,
+ DSSectionTypeBarcodeLocalization,
/**The result is output by "barcode decoding" section.*/
- DSSectionTypeBarcodeDecoding = 3,
+ DSSectionTypeBarcodeDecoding,
/**The result is output by "text line localization" section.*/
- DSSectionTypeTextLineLocalization = 4,
+ DSSectionTypeTextLineLocalization,
/**The result is output by "text line recognition" section.*/
- DSSectionTypeTextLineRecognition = 5,
+ DSSectionTypeTextLineRecognition,
/**The result is output by "document detection" section.*/
- DSSectionTypeDocumentDetection = 6,
- /**The result is output by "document normalization" section.*/
- DSSectionTypeDocumentNormalization = 7
+ DSSectionTypeDocumentDetection,
+ /** The section type is "document deskewing".*/
+ DSSectionTypeDocumentDeskewing,
+ /** The section type is "image enhancement".*/
+ DSSectionTypeImageEnhancement
};
```
>
@@ -46,22 +48,22 @@ typedef NS_ENUM(NSInteger, DSSectionType)
public enum SectionType : Int
{
/**No section type is specified.*/
- null = 0,
+ case null
/**The result is output by "region prediction" section.*/
- regionPredection = 1,
+ case regionPredection
/**The result is output by "barcode localization" section.*/
- barcodeLocalization = 2,
+ case barcodeLocalization
/**The result is output by "barcode decoding" section.*/
- barcodeDecoding = 3,
+ case barcodeDecoding
/**The result is output by "text line localization" section.*/
- textLineLocalization = 4,
+ case textLineLocalization
/**The result is output by "text line recognition" section.*/
- textLineRecognition = 5,
+ case textLineRecognition
/**The result is output by "document detection" section.*/
- documentDetection = 6,
+ case documentDetection
/**The result is output by "document deskewing" section.*/
- documentDeskewing = 7,
+ case documentDeskewing
/**The result is output by "document enhancement" section.*/
- documentEnhancement = 8
+ case documentEnhancement
}
```
diff --git a/programming/ios/api-reference/core/enum/transform-matrix-type.md b/programming/ios/api-reference/core/enum/transform-matrix-type.md
index c9bd2f93..323bba9c 100644
--- a/programming/ios/api-reference/core/enum/transform-matrix-type.md
+++ b/programming/ios/api-reference/core/enum/transform-matrix-type.md
@@ -21,31 +21,35 @@ breadcrumbText: TransformMatrixType
```objc
typedef NS_ENUM(NSInteger, DSTransformMatrixType)
{
- /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/
+ /** Represents a transformation matrix that converts coordinates from the local image to the original image.*/
DSTransformMatrixTypeLocalToOriginalImage,
- /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/
+ /** Represents a transformation matrix that converts coordinates from the original image to the local image.*/
DSTransformMatrixTypeOriginalToLocalImage,
- /**Represents a transformation matrix that converts coordinates from the rotated image to the original image.*/
+ /** Represents a transformation matrix that converts coordinates from the rotated image to the original image.*/
DSTransformMatrixTypeRotatedToOriginalImage,
- /**Represents a transformation matrix that converts coordinates from the original image to the rotated image.*/
+ /** Represents a transformation matrix that converts coordinates from the original image to the rotated image.*/
DSTransformMatrixTypeOriginalToRotatedImage,
- /**Represents a transformation matrix that converts coordinates from the local image to the section image.*/
- DSTransformMatrixTypeLocalToSectionImage,
- /**Represents a transformation matrix that converts coordinates from the section image to the local image.*/
- DSTransformMatrixTypeSectionToLocalImage
+ /** Represents a transformation matrix that converts coordinates from the local image to the section image.*/
+ DSTransformMatrixTypeLocalToSectionImage,
+ /** Represents a transformation matrix that converts coordinates from the section image to the local image.*/
+ DSTransformMatrixTypeSectionToLocalImage
}NS_SWIFT_NAME(TransformMatrixType);
```
>
```swift
public enum TransformMatrixType : Int
{
- /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/
- localToOriginalImage
- /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/
- originalToLocalImage
- /**Represents a transformation matrix that converts coordinates from the rotated image to the original image.*/
- rotatedToOriginalImage
- /**Represents a transformation matrix that converts coordinates from the original image to the rotated image.*/
- originalToRotatedImage
+ /**Represents a transformation matrix that converts coordinates from the local image to the original image.*/
+ case localToOriginalImage
+ /**Represents a transformation matrix that converts coordinates from the original image to the local image.*/
+ case originalToLocalImage
+ /**Represents a transformation matrix that converts coordinates from the rotated image to the original image.*/
+ case rotatedToOriginalImage
+ /**Represents a transformation matrix that converts coordinates from the original image to the rotated image.*/
+ case originalToRotatedImage
+ /** Represents a transformation matrix that converts coordinates from the local image to the section image.*/
+ case localToSectionImage
+ /** Represents a transformation matrix that converts coordinates from the section image to the local image.*/
+ case sectionToLocalImage
}
```
diff --git a/programming/ios/api-reference/core/enum/video-frame-quality.md b/programming/ios/api-reference/core/enum/video-frame-quality.md
index c832d078..26632f82 100644
--- a/programming/ios/api-reference/core/enum/video-frame-quality.md
+++ b/programming/ios/api-reference/core/enum/video-frame-quality.md
@@ -20,14 +20,14 @@ codeAutoHeight: true
>
>
```objc
-typedef NS_ENUM(NSInteger, DSVideoFrameQuality)
+typedef NS_ENUM(NSInteger, DSFrameQuality)
{
/**The frame quality is measured to be high.*/
- VideoFrameQualityHigh,
+ FrameQualityHIGH,
/**The frame quality is measured to be low.*/
- VideoFrameQualityLow,
+ FrameQualityLOW,
/**The frame quality is unknown.*/
- VideoFrameQualityUnknown
+ FrameQualityUNKNOWN
};
```
>
@@ -35,10 +35,10 @@ typedef NS_ENUM(NSInteger, DSVideoFrameQuality)
public enum VideoFrameQuality : Int
{
/**The frame quality is measured to be high.*/
- high,
+ case high
/**The frame quality is measured to be low.*/
- low,
+ case low
/**The frame quality is unknown.*/
- unknown
+ case unknown
}
```
diff --git a/programming/ios/api-reference/core/intermediate-results/binary-image-unit.md b/programming/ios/api-reference/core/intermediate-results/binary-image-unit.md
index 94d1d931..b807f297 100644
--- a/programming/ios/api-reference/core/intermediate-results/binary-image-unit.md
+++ b/programming/ios/api-reference/core/intermediate-results/binary-image-unit.md
@@ -64,7 +64,7 @@ Sets the image data for the binary image.
```
2.
```swift
-func setImageData(_ imageData: DSImageData?) -> Int
+func setImageData(_ imageData: ImageData?) -> Int
```
**Parameters**
@@ -89,7 +89,7 @@ Gets the image data for the binary image.
```
2.
```swift
-func getImageData() -> DSImageData?
+func getImageData() -> ImageData?
```
**Return Value**
diff --git a/programming/ios/api-reference/core/intermediate-results/colour-image-unit.md b/programming/ios/api-reference/core/intermediate-results/colour-image-unit.md
index 28d2a04a..2af48628 100644
--- a/programming/ios/api-reference/core/intermediate-results/colour-image-unit.md
+++ b/programming/ios/api-reference/core/intermediate-results/colour-image-unit.md
@@ -64,7 +64,7 @@ Sets the image data for the colour image.
```
2.
```swift
-func setImageData(_ imageData: DSImageData?) -> Int
+func setImageData(_ imageData: ImageData?) -> Int
```
**Parameters**
@@ -89,7 +89,7 @@ Gets the image data for the colour image.
```
2.
```swift
-func getImageData() -> DSImageData?
+func getImageData() -> ImageData?
```
**Return Value**
diff --git a/programming/ios/api-reference/core/intermediate-results/enhanced-grayscale-image-unit.md b/programming/ios/api-reference/core/intermediate-results/enhanced-grayscale-image-unit.md
index fa2d1686..e48dc8f5 100644
--- a/programming/ios/api-reference/core/intermediate-results/enhanced-grayscale-image-unit.md
+++ b/programming/ios/api-reference/core/intermediate-results/enhanced-grayscale-image-unit.md
@@ -64,7 +64,7 @@ Sets the image data for the enhanced grayscale image.
```
2.
```swift
-func setImageData(_ imageData: DSImageData?) -> Int
+func setImageData(_ imageData: ImageData?) -> Int
```
**Parameters**
@@ -89,7 +89,7 @@ Gets the image data for the enhanced grayscale image.
```
2.
```swift
-func getImageData() -> DSImageData?
+func getImageData() -> ImageData?
```
**Return Value**
diff --git a/programming/ios/api-reference/core/intermediate-results/grayscale-image-unit.md b/programming/ios/api-reference/core/intermediate-results/grayscale-image-unit.md
index 95f7738a..3a033ae2 100644
--- a/programming/ios/api-reference/core/intermediate-results/grayscale-image-unit.md
+++ b/programming/ios/api-reference/core/intermediate-results/grayscale-image-unit.md
@@ -64,7 +64,7 @@ Sets the image data for the grayscale image.
```
2.
```swift
-func setImageData(_ imageData: DSImageData?) -> Int
+func setImageData(_ imageData: ImageData?) -> Int
```
**Parameters**
@@ -89,7 +89,7 @@ Gets the image data for the grayscale image.
```
2.
```swift
-func getImageData() -> DSImageData?
+func getImageData() -> ImageData?
```
**Return Value**
diff --git a/programming/ios/api-reference/core/intermediate-results/intermediate-result-extra-info.md b/programming/ios/api-reference/core/intermediate-results/intermediate-result-extra-info.md
index 6b7977e3..0a00d1e6 100644
--- a/programming/ios/api-reference/core/intermediate-results/intermediate-result-extra-info.md
+++ b/programming/ios/api-reference/core/intermediate-results/intermediate-result-extra-info.md
@@ -48,7 +48,7 @@ The name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-d
>
>1.
```objc
-@property(nonatomic, copy, readonly) NSString *targetROIDefName;
+@property (nonatomic, readonly, copy) NSString *targetROIDefName;
```
2.
```swift
@@ -65,7 +65,7 @@ The name of the processing task to which this result belongs.
>
>1.
```objc
-@property(nonatomic, copy, readonly) NSString *taskName;
+@property (nonatomic, readonly, copy) NSString *taskName;
```
2.
```swift
@@ -82,7 +82,7 @@ The property indicates whether the result is at the section level.
>
>1.
```objc
-@property(nonatomic, assign, readonly) bool *isSectionLevelResult;
+@property (nonatomic, readonly, assign) BOOL isSectionLevelResult;
```
2.
```swift
@@ -99,9 +99,9 @@ The type of section that generates the result, if applicable, as defined by the
>
>1.
```objc
-@property(nonatomic, assign, readonly) DSSectionType sectionType;
+@property (nonatomic, readonly, assign) DSSectionType sectionType;
```
2.
```swift
-var sectionType: EnumSectionType { get }
+var sectionType: SectionType { get }
```
diff --git a/programming/ios/api-reference/core/intermediate-results/intermediate-result-manager.md b/programming/ios/api-reference/core/intermediate-results/intermediate-result-manager.md
deleted file mode 100644
index 57882508..00000000
--- a/programming/ios/api-reference/core/intermediate-results/intermediate-result-manager.md
+++ /dev/null
@@ -1,161 +0,0 @@
----
-layout: default-layout
-title: DSIntermediateResultManager - Dynamsoft Core Module iOS Edition API Reference
-description: The class DSIntermediateResultManager of Dynamsoft Core Module manages intermediate results generated during data capturing. It provides methods to add and remove intermediate result receivers, as well as to get original image data using an image hash id.
-keywords: intermediate result manager, objective-c, swift
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-ignore: true
----
-
-# DSIntermediateResultManager
-
-> You are reading a history page of `DynamsoftCore`. Start from v3.2.10, the `DSIntermediateResultManager` class is moved to the `DynamsoftCaptureVisionRouter` module. View the [`DynamsoftCaptureVisionRouter.DSIntermediateResultManager`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html) for the latest version.
-
-The `DSIntermediateResultManager` class manages intermediate results generated during data capturing. It provides methods to add and remove intermediate result receivers, as well as to get original image data using an image hash id.
-
-## Definition
-
-*Assembly:* DynamsoftCaptureVisionBundle.xcframework
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-@interface DSIntermediateResultManager: NSObject
-```
-2.
-```swift
-class IntermediateResultManager : NSObject
-```
-
-## Methods
-
-| Method | Description |
-| ------ | ----------- |
-| [`addResultReceiver`](#addresultreceiver) | Adds a [`DSIntermediateResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) object as the receiver of intermediate results. |
-| [`removeResultReceiver`](#removeresultreceiver) | Removes the specified [`DSIntermediateResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) object. |
-| [`getOriginalImage`](#getoriginalimage) | Gets the original image data. |
-
-### addResultReceiver
-
-Adds a [`DSIntermediateResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) object as the receiver of intermediate results.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (BOOL)addResultReceiver:(id)receiver;
-```
-2.
-```swift
-func addResultReceiver(_ receiver: DSIntermediateResultReceiver)
-```
-
-**Parameters**
-
-`receiver`: A delegate object of [`DSIntermediateResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html).
-
-**Return Value**
-
-A `BOOL` value that indicates whether the result receiver is added successfully.
-
-**Code Snippet**
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-BOOL result = [resultManager addResultReceiver:receiver];
-```
-2.
-```swift
-resultManager.addResultReceiver(receiver)
-```
-
-### removeResultReceiver
-
-Removes the specified [`DSIntermediateResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) object.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (BOOL)removeResultReceiver:(id)receiver;
-```
-2.
-```swift
-func removeResultReceiver(_ receiver: DSIntermediateResultReceiver)
-```
-
-**Parameters**
-
-`receiver`: A delegate object of [`DSIntermediateResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html).
-
-**Return Value**
-
-A `BOOL` value that indicates whether the result receiver is removed successfully.
-
-**Code Snippet**
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-result = [resultManager removeResultReceiver:receiver];
-```
-2.
-```swift
-resultManager.removeResultReceiver(receiver)
-```
-
-### getOriginalImage
-
-Gets the original image data.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (DSImageData)getOriginalImage:(NSString)imageHashId;
-```
-2.
-```swift
-func getOriginalImage(_ imageHashId: String) -> DSImageData
-```
-
-**Parameters**
-
-`imageHashId`: The image hash ID.
-
-**Return Value**
-
-The original image data as [`DSImageData`](../basic-structures/image-data.md).
-
-**Code Snippet**
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-DSImageData *imageData = [resultManager getOriginalImage:imageHashId];
-```
-2.
-```swift
-let imageData = resultManager.getOriginalImage(imageHashId)
-```
diff --git a/programming/ios/api-reference/core/intermediate-results/intermediate-result-receiver.md b/programming/ios/api-reference/core/intermediate-results/intermediate-result-receiver.md
deleted file mode 100644
index 14c264b2..00000000
--- a/programming/ios/api-reference/core/intermediate-results/intermediate-result-receiver.md
+++ /dev/null
@@ -1,705 +0,0 @@
----
-layout: default-layout
-title: DSIntermediateResultReceiver - Dynamsoft Core Module iOS Edition API Reference
-description: The protocol DSIntermediateResultReceiver includes methods for monitoring the output of intermediate results.
-keywords: protocol, objective-c, swift
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-ignore: true
----
-
-# DSIntermediateResultReceiver
-
-> You are reading a history page of `DynamsoftCore`. Start from v3.2.10, the `DSIntermediateResultReceiver` class is moved to the `DynamsoftCaptureVisionRouter` module. View the [`DynamsoftCaptureVisionRouter.DSIntermediateResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) for the latest version.
-
-The `DSIntermediateResultReceiver` protocol includes methods for monitoring the output of intermediate results.
-
-## Definition
-
-*Assembly:* DynamsoftCaptureVisionBundle.xcframework
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-@protocol DSIntermediateResultReceiver
-```
-2.
-```swift
-protocol IntermediateResultReceiver: NSObjectProtocol
-```
-
-## Methods
-
-| Method | Description |
-| ------ | ----------- |
-| [`getObservationParameters`](#getobservationparameters) | Get an `ObservationParameters` object to configure the observation settings. |
-| [`onPredetectedRegionsReceived`](#onpredetectedregionsreceived) | The method for monitoring the output of `PredetectedRegionsUnit`. |
-| [`onLocalizedBarcodesReceived`](#onlocalizedbarcodesreceived) | The method for monitoring the output of `LocalizedBarcodesUnit`. |
-| [`onDecodedBarcodesReceived`](#ondecodedbarcodesreceived) | The method for monitoring the output of `DecodedBarcodesUnit`. |
-| [`onLocalizedTextLinesReceived`](#onlocalizedtextlinesreceived) | The method for monitoring the output of `LocalizedTextLinesUnit`. |
-| [`onRecognizedTextLinesReceived`](#onrecognizedtextlinesreceived) | The method for monitoring the output of `RecognizedTextLinesUnit`. |
-| [`onDetectedQuadsReceived`](#ondetectedquadsreceived) | The method for monitoring the output of `DetectedQuadsUnit`. |
-| [`onNormalizedImagesReceived`](#onnormalizedimagesreceived) | The method for monitoring the output of `NormalizedImagesUnit`. |
-| [`onColourImageUnitReceived`](#oncolourimageunitreceived) | The method for monitoring the output of `ColourImageUnit`. |
-| [`onScaledDownColourImageUnitReceived`](#onscaleddowncolourimageunitreceived) | The method for monitoring the output of `ScaledDownColourImageUnit`. |
-| [`onGrayscaleImageUnitReceived`](#ongrayscaleimageunitreceived) | The method for monitoring the output of `GrayscaleImageUnit`. |
-| [`onTransformedGrayscaleImageUnitReceived`](#ontransformedgrayscaleimageunitreceived) | The method for monitoring the output of `TransformedGrayscaleImageUnit`. |
-| [`onEnhancedGrayscaleImageUnitReceived`](#onenhancedgrayscaleimageunitreceived) | The method for monitoring the output of `EnhancedGrayscaleImageUnit`. |
-| [`onBinaryImageUnitReceived`](#onbinaryimageunitreceived) | The method for monitoring the output of `BinaryImageUnit`. |
-| [`onTextureDetectionResultUnitReceived`](#ontexturedetectionresultunitreceived) | The method for monitoring the output of `TextureDetectionResultUnit`. |
-| [`onTextureRemovedGrayscaleImageUnitReceived`](#ontextureremovedgrayscaleimageunitreceived) | The method for monitoring the output of `TextureRemovedGrayscaleImageUnit`. |
-| [`onTextureRemovedBinaryImageUnitReceived`](#ontextureremovedbinaryimageunitreceived) | The method for monitoring the output of `TextureRemovedBinaryImageUnit`. |
-| [`onContoursUnitReceived`](#oncontoursunitreceived) | The method for monitoring the output of `ContoursUnit`. |
-| [`onLineSegmentsUnitReceived`](#onlinesegmentsunitreceived) | The method for monitoring the output of `LineSegmentsUnit`. |
-| [`onTextZonesUnitReceived`](#ontextzonesunitreceived) | The method for monitoring the output of `TextZonesUnit`. |
-| [`onTextRemovedBinaryImageUnitReceived`](#ontextremovedbinaryimageunitreceived) | The method for monitoring the output of `TextRemovedBinaryImageUnit`. |
-| [`onLongLinesUnitReceived`](#onlonglinesunitreceived) | The method for monitoring the output of `LongLinesUnit`. |
-| [`onCornersUnitReceived`](#oncornersunitreceived) | The method for monitoring the output of `CornersUnit`. |
-| [`onCandidateQuadEdgesUnitReceived`](#oncandidatequadedgesunitreceived) | The method for monitoring the output of `CandidateQuadEdgesUnit`. |
-| [`onCandidateBarcodeZonesUnitReceived`](#oncandidatebarcodezonesunitreceived) | The method for monitoring the output of `CandidateBarcodeZonesUnit`. |
-| [`onScaledUpBarcodeImageUnitReceived`](#onscaledupbarcodeimageunitreceived) | The method for monitoring the output of `ScaledUpBarcodeImageUnit`. |
-| [`onDeformationResistedBarcodeImageUnitReceived`](#ondeformationresistedbarcodeimageunitreceived) | The method for monitoring the output of `DeformationResistedBarcodeImageUnit`. |
-| [`onComplementedBarcodeImageUnitReceived`](#oncomplementedbarcodeimageunitreceived) | The method for monitoring the output of `ComplementedBarcodeImageUnit`. |
-| [`onTaskResultsReceived`](#ontaskresultsreceived) | The method for monitoring the output of task results. |
-
-### getObservationParameters
-
-Get a `ObservationParameters` object to configure the observation settings.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-ObservationParameters getObservationParameters();
-```
-2.
-```swift
-func onPredetectedRegionsReceived(_ unit: PredetectedRegionsUnit, info: IntermediateResultExtraInfo)
-```
-
-**Return Value**
-
-An `ObservationParameters` object.
-
-### onPredetectedRegionsReceived
-
-The method for monitoring the output of `PredetectedRegionsUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onPredetectedRegionsReceived(PredetectedRegionsUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onPredetectedRegionsReceived(_ unit: PredetectedRegionsUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `PredetectedRegionsUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onLocalizedBarcodesReceived
-
-The method for monitoring the output of `LocalizedBarcodesUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onLocalizedBarcodesReceived(LocalizedBarcodesUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onLocalizedBarcodesReceived(_ unit: LocalizedBarcodesUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `LocalizedBarcodesUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onDecodedBarcodesReceived
-
-The method for monitoring the output of `DecodedBarcodesUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onDecodedBarcodesReceived(DecodedBarcodesUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onDecodedBarcodesReceived(_ unit: DecodedBarcodesUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `DecodedBarcodesUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onLocalizedTextLinesReceived
-
-The method for monitoring the output of `LocalizedTextLines`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onLocalizedTextLinesReceived(LocalizedTextLinesUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onLocalizedTextLinesReceived(_ unit: LocalizedTextLinesUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `LocalizedTextLines` object output by the library.
-`info`: The extra info of the result.
-
-### onRecognizedTextLinesReceived
-
-The method for monitoring the output of `RecognizedTextLinesUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onRecognizedTextLinesReceived(RecognizedTextLinesUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onRecognizedTextLinesReceived(_ unit: RecognizedTextLinesUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `RecognizedTextLinesUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onDetectedQuadsReceived
-
-The method for monitoring the output of `DetectedQuadsUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onDetectedQuadsReceived(DetectedQuadsUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onDetectedQuadsReceived(_ unit: DetectedQuadsUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `DetectedQuadsUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onNormalizedImagesReceived
-
-The method for monitoring the output of `NormalizedImagesUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onNormalizedImagesReceived(NormalizedImagesUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onNormalizedImagesReceived(_ unit: NormalizedImagesUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `NormalizedImagesUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onColourImageUnitReceived
-
-The method for monitoring the output of `ColourImageUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onColourImageUnitReceived(ColourImageUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onColourImageUnitReceived(_ unit: ColourImageUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `ColourImageUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onScaledDownColourImageUnitReceived
-
-The method for monitoring the output of `ScaledDownColourImageUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onScaledDownColourImageUnitReceived(ScaledDownColourImageUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onScaledDownColourImageUnitReceived(_ unit: ScaledDownColourImageUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `ScaledDownColourImageUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onGrayscaleImageUnitReceived
-
-The method for monitoring the output of `GrayscaleImageUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onGrayscaleImageUnitReceived(GrayscaleImageUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onGrayscaleImageUnitReceived(_ unit: GrayscaleImageUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `GrayscaleImageUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onTransformedGrayscaleImageUnitReceived
-
-The method for monitoring the output of `TransformedGrayscaleImageUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onTransformedGrayscaleImageUnitReceived(TransformedGrayscaleImageUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onTransformedGrayscaleImageUnitReceived(_ unit: TransformedGrayscaleImageUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `TransformedGrayscaleImageUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onEnhancedGrayscaleImageUnitReceived
-
-The method for monitoring the output of `EnhancedGrayscaleImageUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onEnhancedGrayscaleImageUnitReceived(EnhancedGrayscaleImageUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onEnhancedGrayscaleImageUnitReceived(_ unit: EnhancedGrayscaleImageUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: An `EnhancedGrayscaleImageUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onBinaryImageUnitReceived
-
-The method for monitoring the output of `BinaryImageUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onBinaryImageUnitReceived(BinaryImageUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onBinaryImageUnitReceived(_ unit: BinaryImageUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `BinaryImageUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onTextureDetectionResultUnitReceived
-
-The method for monitoring the output of `TextureDetectionResultUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onTextureDetectionResultUnitReceived(TextureDetectionResultUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onTextureDetectionResultUnitReceived(_ unit: TextureDetectionResultUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `TextureDetectionResultUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onTextureRemovedGrayscaleImageUnitReceived
-
-The method for monitoring the output of `TextureRemovedGrayscaleImageUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onTextureRemovedGrayscaleImageUnitReceived(TextureRemovedGrayscaleImageUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onTextureRemovedGrayscaleImageUnitReceived(_ unit: TextureRemovedGrayscaleImageUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `TextureRemovedGrayscaleImageUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onTextureRemovedBinaryImageUnitReceived
-
-The method for monitoring the output of `TextureRemovedBinaryImageUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onTextureRemovedBinaryImageUnitReceived(TextureRemovedBinaryImageUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onTextureRemovedBinaryImageUnitReceived(_ unit: TextureRemovedBinaryImageUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `TextureRemovedBinaryImageUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onContoursUnitReceived
-
-The method for monitoring the output of `ContoursUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onContoursUnitReceived(ContoursUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onContoursUnitReceived(_ unit: ContoursUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `ContoursUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onLineSegmentsUnitReceived
-
-The method for monitoring the output of `LineSegmentsUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onLineSegmentsUnitReceived(LineSegmentsUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onLineSegmentsUnitReceived(_ unit: LineSegmentsUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `LineSegmentsUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onTextZonesUnitReceived
-
-The method for monitoring the output of `TextZonesUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onTextZonesUnitReceived(TextZonesUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onTextZonesUnitReceived(_ unit: TextZonesUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `TextZonesUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onTextRemovedBinaryImageUnitReceived
-
-The method for monitoring the output of `TextRemovedBinaryImageUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onTextRemovedBinaryImageUnitReceived(TextRemovedBinaryImageUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onTextRemovedBinaryImageUnitReceived(_ unit: TextRemovedBinaryImageUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `TextRemovedBinaryImageUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onLongLinesUnitReceived
-
-The method for monitoring the output of `LongLinesUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onLongLinesUnitReceived(LongLinesUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onLongLinesUnitReceived(_ unit: LongLinesUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `LongLinesUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onCornersUnitReceived
-
-The method for monitoring the output of `CornersUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onCornersUnitReceived(CornersUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onCornersUnitReceived(_ unit: CornersUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `CornersUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onCandidateQuadEdgesUnitReceived
-
-The method for monitoring the output of `CandidateQuadEdgesUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onCandidateQuadEdgesUnitReceived(CandidateQuadEdgesUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onCandidateQuadEdgesUnitReceived(_ unit: CandidateQuadEdgesUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `CandidateQuadEdgesUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onCandidateBarcodeZonesUnitReceived
-
-The method for monitoring the output of `CandidateBarcodeZonesUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onCandidateBarcodeZonesUnitReceived(CandidateBarcodeZonesUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onCandidateBarcodeZonesUnitReceived(_ unit: CandidateBarcodeZonesUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `CandidateBarcodeZonesUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onScaledUpBarcodeImageUnitReceived
-
-The method for monitoring the output of `ScaledUpBarcodeImageUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onScaledUpBarcodeImageUnitReceived(ScaledUpBarcodeImageUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onScaledUpBarcodeImageUnitReceived(_ unit: ScaledUpBarcodeImageUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `ScaledUpBarcodeImageUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onDeformationResistedBarcodeImageUnitReceived
-
-The method for monitoring the output of `DeformationResistedBarcodeImageUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onDeformationResistedBarcodeImageUnitReceived(DeformationResistedBarcodeImageUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onDeformationResistedBarcodeImageUnitReceived(_ unit: DeformationResistedBarcodeImageUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `DeformationResistedBarcodeImageUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onComplementedBarcodeImageUnitReceived
-
-The method for monitoring the output of `ComplementedBarcodeImageUnit`.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onComplementedBarcodeImageUnitReceived(ComplementedBarcodeImageUnit unit, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onComplementedBarcodeImageUnitReceived(_ unit: ComplementedBarcodeImageUnit, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: A `ComplementedBarcodeImageUnit` object output by the library.
-`info`: The extra info of the result.
-
-### onTaskResultsReceived
-
-The method for monitoring the output of `IntermediateResult`.
-
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-void onTaskResultsReceived(IntermediateResult result, IntermediateResultExtraInfo info);
-```
-2.
-```swift
-func onTaskResultsReceived(_ unit: IntermediateResult, info: IntermediateResultExtraInfo)
-```
-
-**Parameters**
-
-`unit`: An `IntermediateResult` object output by the library.
-`info`: The extra info of the result.
diff --git a/programming/ios/api-reference/core/intermediate-results/intermediate-result-unit.md b/programming/ios/api-reference/core/intermediate-results/intermediate-result-unit.md
index 3e16c66e..7a897b21 100644
--- a/programming/ios/api-reference/core/intermediate-results/intermediate-result-unit.md
+++ b/programming/ios/api-reference/core/intermediate-results/intermediate-result-unit.md
@@ -110,7 +110,7 @@ Gets the type of the intermediate result unit, defined by the enumeration [`DSIn
```
2.
```swift
-func getType() -> DSIntermediateResultUnitType
+func getType() -> IntermediateResultUnitType
```
**Return Value**
@@ -131,7 +131,7 @@ Gets the transformation matrix via [`DSTransformMatrixType`]({{ site.dcv_ios_api
```
2.
```swift
-func getTransformMatrix(_ type: DSTransformMatrixType) -> CGAffineTransform
+func getTransformMatrix(_ type: TransformMatrixType) -> CGAffineTransform
```
**Parameters**
@@ -182,7 +182,7 @@ Replaces the content of the intermediate result unit.
```
2.
```swift
-func replace(_ oldUnit: DSIntermediateResultUnit) -> NSInteger
+func replace(_ oldUnit: IntermediateResultUnit) -> NSInteger
```
**Parameters**
diff --git a/programming/ios/api-reference/core/intermediate-results/intermediate-result.md b/programming/ios/api-reference/core/intermediate-results/intermediate-result.md
index 21c8a695..a755f053 100644
--- a/programming/ios/api-reference/core/intermediate-results/intermediate-result.md
+++ b/programming/ios/api-reference/core/intermediate-results/intermediate-result.md
@@ -45,7 +45,7 @@ An array of `DSIntermediateResultUnit` objects, each representing a different ty
>
>1.
```objc
-@property(nonatomic, strong, nonnull, readonly) NSArray * intermediateResultUnits;
+@property (nonatomic, readonly, copy, nullable) NSArray * intermediateResultUnits;
```
2.
```swift
diff --git a/programming/ios/api-reference/core/intermediate-results/line-segments-unit.md b/programming/ios/api-reference/core/intermediate-results/line-segments-unit.md
index da8b968e..e5fc2e53 100644
--- a/programming/ios/api-reference/core/intermediate-results/line-segments-unit.md
+++ b/programming/ios/api-reference/core/intermediate-results/line-segments-unit.md
@@ -204,7 +204,7 @@ Sets a line segment.
```objc
-(NSInteger)setLineSegment:(NSInteger)index
line:(DSLineSegment *)line
- matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;
+ matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;
```
2.
```swift
diff --git a/programming/ios/api-reference/core/intermediate-results/observation-parameters.md b/programming/ios/api-reference/core/intermediate-results/observation-parameters.md
index 03bdb0ff..b4d9060d 100644
--- a/programming/ios/api-reference/core/intermediate-results/observation-parameters.md
+++ b/programming/ios/api-reference/core/intermediate-results/observation-parameters.md
@@ -160,5 +160,5 @@ let observed = observationParameters.isTaskObserved("TextRecognition")
Defines the type of intermediate result unit that indicates skipping default calculations and replacing with input data units.
```objc
-@property (nonatomic, nullable, copy) DSIntermediateResultUnitType resultUnitTypesOnlyForInput;
+@property (nonatomic, assign) DSIntermediateResultUnitType resultUnitTypesOnlyForInput;
```
diff --git a/programming/ios/api-reference/core/intermediate-results/region-object-element.md b/programming/ios/api-reference/core/intermediate-results/region-object-element.md
index 176007d0..21eb33f6 100644
--- a/programming/ios/api-reference/core/intermediate-results/region-object-element.md
+++ b/programming/ios/api-reference/core/intermediate-results/region-object-element.md
@@ -94,7 +94,7 @@ Gets the type of the region object element, defined by the enumeration [`DSRegio
```
2.
```swift
-func getType() -> DSRegionObjectElementType
+func getType() -> RegionObjectElementType
```
**Return Value**
@@ -115,7 +115,7 @@ Gets the original image that produce this element.
```
2.
```swift
-func getImageData() -> DSImageData?
+func getImageData() -> ImageData?
```
**Return Value**
diff --git a/programming/ios/api-reference/core/intermediate-results/scaled-down-colour-image-unit.md b/programming/ios/api-reference/core/intermediate-results/scaled-down-colour-image-unit.md
index 7665a841..49441195 100644
--- a/programming/ios/api-reference/core/intermediate-results/scaled-down-colour-image-unit.md
+++ b/programming/ios/api-reference/core/intermediate-results/scaled-down-colour-image-unit.md
@@ -64,7 +64,7 @@ Sets the image data for the scaled-down colour image.
```
2.
```swift
-func setImageData(_ imageData: DSImageData?) -> Int
+func setImageData(_ imageData: ImageData?) -> Int
```
**Parameters**
@@ -89,7 +89,7 @@ Gets the image data for the scaled-down colour image.
```
2.
```swift
-func getImageData() -> DSImageData?
+func getImageData() -> ImageData?
```
**Return Value**
diff --git a/programming/ios/api-reference/core/intermediate-results/short-lines-unit.md b/programming/ios/api-reference/core/intermediate-results/short-lines-unit.md
index c1fd7340..f3206bf3 100644
--- a/programming/ios/api-reference/core/intermediate-results/short-lines-unit.md
+++ b/programming/ios/api-reference/core/intermediate-results/short-lines-unit.md
@@ -171,7 +171,7 @@ Adds a short line to this unit.
>1.
```objc
-(NSInteger)addShortLine:(DSLineSegment*)line
- matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;
+ matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;
```
2.
```swift
diff --git a/programming/ios/api-reference/core/intermediate-results/text-zone.md b/programming/ios/api-reference/core/intermediate-results/text-zone.md
index 88bee7cb..cd3b2573 100644
--- a/programming/ios/api-reference/core/intermediate-results/text-zone.md
+++ b/programming/ios/api-reference/core/intermediate-results/text-zone.md
@@ -29,13 +29,17 @@ The `TextZone` class describes a text zone.
class TextZone: NSObject
```
-## Attributes
+## Attributes & Methods
| Attributes | Type | Description |
| ---------- | ---- | ----------- |
| [`location`](#location) | *DSQuadrilateral * \** | The location of the text zone. |
| [`charContoursIndices`](#charcontourindices) | *NSArray * \** | The indices of the character contours. |
+| Method | Description |
+| ------ | ----------- |
+| [`initWithLocation`](#initwithlocation) | The constructor. Creates a DSRect from the specified parameters. |
+
### location
The location of the text zone.
@@ -46,7 +50,7 @@ The location of the text zone.
>
>1.
```objc
-@property (nonatomic, copy) DSQuadrilateral * location;
+@property (nonatomic, strong) DSQuadrilateral * location;
```
2.
```swift
@@ -63,9 +67,27 @@ The indices of the character contours.
>
>1.
```objc
-@property (nonatomic, nullable, copy) NSArray * charContoursIndices;
+@property (nonatomic, copy, nullable) NSArray *charContoursIndices;
+```
+2.
+```swift
+var charContoursIndices: [NSNumber]? { get set }
+```
+
+### initWithLocation
+
+The constructor. Creates a `DSTextZone` from the location and the character contour indices.
+
+
+>- Objective-C
+>- Swift
+>
+>1.
+```objc
+- (instancetype)initWithLocation:(DSQuadrilateral *)location
+ charContoursIndiceArray:(nullable NSArray *)charContoursIndices;
```
2.
```swift
-var charContoursIndices: [Int]? { get set }
+init(location: Quadrilateral, charContoursIndices: [NSNumber]?)
```
diff --git a/programming/ios/api-reference/core/intermediate-results/text-zones-unit.md b/programming/ios/api-reference/core/intermediate-results/text-zones-unit.md
index b388188f..3fafd58f 100644
--- a/programming/ios/api-reference/core/intermediate-results/text-zones-unit.md
+++ b/programming/ios/api-reference/core/intermediate-results/text-zones-unit.md
@@ -131,11 +131,11 @@ Removes the text zone at the specified index.
>
>1.
```objc
--(void)removeTextZone:(NSInteger)index;
+- (NSInteger)removeTextZone:(NSInteger)index;
```
2.
```swift
-func removeTextZone(index: Int)
+func removeTextZone(_ index: Int) -> Int
```
**Parameters**
@@ -153,7 +153,7 @@ Adds a text zone to this unit.
>1.
```objc
-(NSInteger)addTextZone:(DSTextZone*)textZone
- matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;
+ matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;
```
2.
```swift
@@ -182,7 +182,7 @@ Sets the text zone at the specified index.
```objc
-(NSInteger)setTextZone:(NSInteger)index
textZone:(DSTextZone*)textZone
- matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;
+ matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;
```
2.
```swift
diff --git a/programming/ios/api-reference/core/intermediate-results/texture-detection-result-unit.md b/programming/ios/api-reference/core/intermediate-results/texture-detection-result-unit.md
index 5731043d..95923990 100644
--- a/programming/ios/api-reference/core/intermediate-results/texture-detection-result-unit.md
+++ b/programming/ios/api-reference/core/intermediate-results/texture-detection-result-unit.md
@@ -30,14 +30,14 @@ NS_SWIFT_NAME(TextureDetectionResultUnit)
class TextureDetectionResultUnit : IntermediateResultUnit
```
-## Attributes
+## Methods
-| Attributes | Type | Description |
-| ---------- | ---- | ----------- |
-| [`xSpacing`](#xspacing) | *NSInteger* | This value represents the detected horizontal distance in pixels between consecutive texture patterns, providing an indication of the texture's density and orientation within the image. |
-| [`ySpacing`](#yspacing) | *NSInteger* | The spacing between texture stripes in the y-direction. Similar to `xSpacing`, this value measures the vertical distance between texture patterns. texture's characteristics and spatial distribution. |
-
-## Inherited Methods
+| Method | Description |
+|------- |-------------|
+| [`getXSpacing`](#xspacing) | Gets the detected horizontal distance in pixels between consecutive texture patterns, providing an indication of the texture's density and orientation within the image. |
+| [`setXSpacing`](#xspacing) | Sets the x-direction spacing of the texture. |
+| [`getYSpacing`](#yspacing) | Gets the spacing between texture stripes in the y-direction. Similar to `xSpacing`, this value measures the vertical distance between texture patterns. texture's characteristics and spatial distribution. |
+| [`setYSpacing`](#yspacing) | Sets the y-direction spacing of the texture. |
The following methods are inherited from class [`IntermediateResultUnit`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html).
@@ -51,9 +51,43 @@ The following methods are inherited from class [`IntermediateResultUnit`]({{ sit
| [`clone`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html#clone) | Creates a copy of the intermediate result unit. |
| [`replace`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html#replace) | Replaces the content of the intermediate result unit. |
-### xSpacing
+### getXSpacing
+
+Gets the detected horizontal distance in pixels between consecutive texture patterns, providing an indication of the texture's density and orientation within the image.
+
+
+>- Objective-C
+>- Swift
+>
+>1.
+```objc
+- (NSInteger)getXSpacing;
+```
+2.
+```swift
+func getXSpacing() -> Int
+```
+
+### setXSpacing
+
+Sets the x-direction spacing of the texture.
+
+
+>- Objective-C
+>- Swift
+>
+>1.
+```objc
+- (void)setXSpacing:(NSInteger)xSpacing;
+```
+2.
+```swift
+func setXSpacing(xSpacing: Int)
+```
+
+### getYSpacing
-This value represents the detected horizontal distance in pixels between consecutive texture patterns, providing an indication of the texture's density and orientation within the image.
+Sets the spacing between texture stripes in the y-direction. Similar to `xSpacing`, this value measures the vertical distance between texture patterns. texture's characteristics and spatial distribution.
>- Objective-C
@@ -61,16 +95,16 @@ This value represents the detected horizontal distance in pixels between consecu
>
>1.
```objc
-@property (nonatomic, assign) NSInteger xSpacing
+- (NSInteger)getYSpacing;
```
2.
```swift
-var xSpacing: Int { get set }
+func getYSpacing() -> Int
```
-### ySpacing
+### setYSpacing
-The spacing between texture stripes in the y-direction. Similar to `xSpacing`, this value measures the vertical distance between texture patterns. texture's characteristics and spatial distribution.
+Sets the y-direction spacing of the texture.
>- Objective-C
@@ -78,9 +112,9 @@ The spacing between texture stripes in the y-direction. Similar to `xSpacing`, t
>
>1.
```objc
-@property (nonatomic, assign) NSInteger ySpacing
+- (void)setYSpacing:(NSInteger)ySpacing;
```
2.
```swift
-var ySpacing: Int { get set }
+func setYSpacing(ySpacing: Int)
```
diff --git a/programming/ios/api-reference/core/intermediate-results/texture-removed-grayscale-image-unit.md b/programming/ios/api-reference/core/intermediate-results/texture-removed-grayscale-image-unit.md
index 9e21b842..e04060ab 100644
--- a/programming/ios/api-reference/core/intermediate-results/texture-removed-grayscale-image-unit.md
+++ b/programming/ios/api-reference/core/intermediate-results/texture-removed-grayscale-image-unit.md
@@ -36,8 +36,6 @@ class TextureRemovedGrayscaleImageUnit : IntermediateResultUnit
| [`setImageData`](#setimagedata) | Sets the image data for the texture-removed grayscale image. |
| [`getImageData`](#getimagedata) | Gets the image data for the texture-removed grayscale image. |
-## Inherited Methods
-
The following methods are inherited from class [`IntermediateResultUnit`]({{ site.dcv_ios_api }}core/intermediate-results/intermediate-result-unit.html).
| Method | Description |
@@ -64,7 +62,7 @@ Sets the image data for the texture-removed grayscale image.
```
2.
```swift
-func setImageData(_ imageData: DSImageData?) -> Int
+func setImageData(_ imageData: ImageData?) -> Int
```
**Parameters**
@@ -89,7 +87,7 @@ Gets the image data for the texture-removed grayscale image.
```
2.
```swift
-func getImageData() -> DSImageData?
+func getImageData() -> ImageData?
```
**Return Value**
diff --git a/programming/ios/api-reference/core/intermediate-results/transformed-grayscale-image-unit.md b/programming/ios/api-reference/core/intermediate-results/transformed-grayscale-image-unit.md
index 901cdb4e..6b2a8fe9 100644
--- a/programming/ios/api-reference/core/intermediate-results/transformed-grayscale-image-unit.md
+++ b/programming/ios/api-reference/core/intermediate-results/transformed-grayscale-image-unit.md
@@ -64,7 +64,7 @@ Sets the image data for the transformed grayscale image.
```
2.
```swift
-func setImageData(_ imageData: DSImageData?) -> Int
+func setImageData(_ imageData: ImageData?) -> Int
```
**Parameters**
@@ -89,7 +89,7 @@ Gets the image data for the transformed grayscale image.
```
2.
```swift
-func getImageData() -> DSImageData?
+func getImageData() -> ImageData?
```
**Return Value**
diff --git a/programming/ios/api-reference/license/license-manager.md b/programming/ios/api-reference/license/license-manager.md
index 6c6a8e11..15f7471f 100644
--- a/programming/ios/api-reference/license/license-manager.md
+++ b/programming/ios/api-reference/license/license-manager.md
@@ -23,7 +23,7 @@ The `DSLicenseManager` class provides a set of APIs to manage SDK licensing.
>1.
```objc
@interface DSLicenseManager:NSObject
-```
+```
2.
```swift
class LicenseManager : NSObject
@@ -47,7 +47,7 @@ Initializes the license for the application using a license key.
>
>1.
```objc
-+ (void)initLicense:(NSString* )license verificationDelegate:(id _Nullable)delegate;
++ (void)initLicense:(NSString* )license verificationDelegate:(nullable id _Nullable)delegate;
```
2.
```swift
@@ -70,7 +70,7 @@ Assigns a distinctive name to the device, correlating it with its UUID.
>
>1.
```objc
-+ (void)setDeviceFriendlyName:(NSString* )name;
++ (void)setDeviceFriendlyName:(NSString *)name;
```
2.
```swift
@@ -91,11 +91,11 @@ Get the unique identifier of the device.
>
>1.
```objc
-+ (NSString *)getDeviceUUID;
++ (nullable NSString *)getDeviceUUID;
```
2.
```swift
-class func getDeviceUUID() -> String
+class func getDeviceUUID() -> String?
```
**Return Value**
diff --git a/programming/ios/api-reference/license/license-verification-listener.md b/programming/ios/api-reference/license/license-verification-listener.md
index 871bf792..11c8c81a 100644
--- a/programming/ios/api-reference/license/license-verification-listener.md
+++ b/programming/ios/api-reference/license/license-verification-listener.md
@@ -43,7 +43,8 @@ The callback triggered when the license verification result is available.
>
>1.
```objc
-- (void)onLicenseVerified:(BOOL)isSuccess error:(NSError * _Nullable)error;
+- (void)onLicenseVerified:(BOOL)isSuccess
+ error:(nullable NSError *)error;
```
2.
```swift
diff --git a/programming/ios/api-reference/utility/directory-fetcher.md b/programming/ios/api-reference/utility/directory-fetcher.md
index f861ae5d..861ff3b1 100644
--- a/programming/ios/api-reference/utility/directory-fetcher.md
+++ b/programming/ios/api-reference/utility/directory-fetcher.md
@@ -114,9 +114,9 @@ Sets the directory path and filter for the file search.
>1.
```objc
- (BOOL)setDirectory:(NSString *)directoryPath
- filter:(nullable NSString *)filter
- recursive:(BOOL)recursive
- error:(NSError * _Nullable * _Nullable)error;
+ filter:(NSString *)filter
+ recursive:(BOOL)recursive
+ error:(NSError * _Nullable * _Nullable)error;
```
2.
```swift
@@ -173,7 +173,7 @@ Set the pages to read.
>
>1.
```objc
--(BOOL)setPages:(NSArray *)pages
+-(BOOL)setPages:(NSArray *)pages
error:(NSError *_Nullable *_Nullable)error;
```
2.
diff --git a/programming/ios/api-reference/utility/file-fetcher.md b/programming/ios/api-reference/utility/file-fetcher.md
index 98e88cfc..99d64c34 100644
--- a/programming/ios/api-reference/utility/file-fetcher.md
+++ b/programming/ios/api-reference/utility/file-fetcher.md
@@ -78,8 +78,9 @@ Sets the file with a file path.
```
2.
```swift
-func setFile(withPath filePath: String) throws
+func setFileWithPath( _filePath: String) throws
```
+
**Parameters**
`filePath`: The file path.
@@ -108,7 +109,7 @@ Sets the file with file bytes.
```
2.
```swift
-func setFile(withBytes fileBytes: Data) throws
+func setFileWithBytes( _fileBytes: Data) throws
```
**Parameters**
@@ -138,7 +139,7 @@ Sets the file with a `DSImageData` object.
```
2.
```swift
-func setFile(withBuffer buffer: ImageData) throws
+func setFileWithBuffer( _buffer: ImageData) throws
```
**Parameters**
@@ -167,7 +168,7 @@ Sets the file with a `UIImage`.
```
2.
```swift
-func setFile(withImage image: UIImage) throws
+func setFileWithImage( _image: UIImage) throws
```
**Parameters**
@@ -202,27 +203,6 @@ func hasNextImageToFetch() -> Bool
A bool value that indicates whether there is a next image to fetch.
-### getImage
-
-Get the image data of the image.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
--(DSImageData *)getImage;
-```
-2.
-```swift
-func getImage() -> ImageData
-```
-
-**Return Value**
-
-A `DSImageData` as the image.
-
### setPages
Set the pages to read.
@@ -233,7 +213,7 @@ Set the pages to read.
>
>1.
```objc
--(BOOL)setPages:(NSArray *)pages
+-(BOOL)setPages:(NSArray *)pages
error:(NSError *_Nullable *_Nullable)error;
```
2.
diff --git a/programming/ios/api-reference/utility/image-drawer.md b/programming/ios/api-reference/utility/image-drawer.md
index 833962d5..20484a8d 100644
--- a/programming/ios/api-reference/utility/image-drawer.md
+++ b/programming/ios/api-reference/utility/image-drawer.md
@@ -51,7 +51,7 @@ Add quadrilaterals on the image.
```objc
- (DSImageData *)drawOnImage:(DSImageData *)image
quads:(NSArray *)quads
- colour:(UIColor)colour
+ colour:(UIColor *)colour
thickness:(NSInteger)thickness;
```
2.
@@ -85,7 +85,7 @@ Add lines on the image.
```objc
- (DSImageData *)drawOnImage:(DSImageData *)image
lineSegments:(NSArray *)lineSegments
- colour:(UIColor)colour
+ colour:(UIColor *)colour
thickness:(NSInteger)thickness;
```
2.
@@ -118,7 +118,7 @@ Add contours on the image.
```objc
- (DSImageData *)drawOnImage:(DSImageData *)image
contours:(NSArray *)contours
- colour:(UIColor)colour
+ colour:(UIColor *)colour
thickness:(NSInteger)thickness;
```
2.
@@ -151,7 +151,7 @@ Add corners on the image.
```objc
- (DSImageData *)drawOnImage:(DSImageData *)image
corners:(NSArray *)corners
- colour:(UIColor)colour
+ colour:(UIColor *)colour
thickness:(NSInteger)thickness;
```
2.
@@ -184,7 +184,7 @@ Add edges on the image.
```objc
- (DSImageData *)drawOnImage:(DSImageData *)image
edges:(NSArray *)edges
- colour:(UIColor)colour
+ colour:(UIColor *)colour
thickness:(NSInteger)thickness;
```
2.
diff --git a/programming/ios/api-reference/utility/image-io.md b/programming/ios/api-reference/utility/image-io.md
index 9c7dd6fa..b2d4fef1 100644
--- a/programming/ios/api-reference/utility/image-io.md
+++ b/programming/ios/api-reference/utility/image-io.md
@@ -38,30 +38,6 @@ class ImageIO : NSObject
| [`saveToFile`](#savetofile) | Saves an image to the specified path and format. |
| [`saveToMemory`](#savetomemory) | Saves an image to the memory. |
-```objc
-/**
- * Reads an image from a file.
- * @param [in] filePath The path of the image file.
- * @param [in,out] error An NSError pointer.
- *
- * @return Returns a DSImageData object representing the image.
- */
-- (DSImageData *)readFromFile:(NSString *)filePath
- error:(NSError * _Nullable * _Nullable)error;
-
-/**
- * Reads an image from a file in memory.
- * @param [in] fileBytes A NSData object that points to a file in memory.
- * @param [in,out] error An NSError pointer.
- *
- * @return Returns a DSImageData object representing the image.
- */
-- (DSImageData *)readFromMemory:(NSData *)fileBytes
- error:(NSError * _Nullable * _Nullable)error;
-
-
-```
-
### saveToFile
Saves an image to the specified path and format. The desired file format is inferred from the file extension provided in the `path` parameter.
@@ -79,7 +55,7 @@ Saves an image to the specified path and format. The desired file format is infe
```
2.
```swift
-func save(toFile imageData: ImageData, path: String, overWrite: Bool) throws -> Bool
+func saveToFile( _imageData: ImageData, path: String, overWrite: Bool) throws -> Bool
```
**Parameters**
@@ -116,9 +92,9 @@ Saves an image to the memory.
>
>1.
```objc
-- (NSData *)saveToMemory:(DSImageData *)imageData
- imageFormat:(DSImageFileFormat)imageFormat
- error:(NSError * _Nullable * _Nullable)error;
+- (nullable NSData *)saveToMemory:(DSImageData *)imageData
+ imageFormat:(DSImageFileFormat)imageFormat
+ error:(NSError * _Nullable * _Nullable)error;
```
2.
```swift
@@ -154,8 +130,8 @@ Reads an image from the specified path and format.
>
>1.
```objc
-- (DSImageData *)readFromFile:(NSString *)filePath
- error:(NSError * _Nullable * _Nullable)error;
+- (nullable DSImageData *)readFromFile:(NSString *)filePath
+ error:(NSError * _Nullable * _Nullable)error;
```
2.
```swift
@@ -188,8 +164,8 @@ Reads an image from the memory.
>
>1.
```objc
-- (DSImageData *)readFromMemory:(NSData *)fileBytes
- error:(NSError * _Nullable * _Nullable)error;
+- (nullable DSImageData *)readFromMemory:(NSData *)fileBytes
+ error:(NSError * _Nullable * _Nullable)error;
```
2.
```swift
diff --git a/programming/ios/api-reference/utility/image-manager.md b/programming/ios/api-reference/utility/image-manager.md
deleted file mode 100644
index b677adb8..00000000
--- a/programming/ios/api-reference/utility/image-manager.md
+++ /dev/null
@@ -1,249 +0,0 @@
----
-layout: default-layout
-title: DSImageManager - Dynamsoft Capture Vision Router Module iOS Edition API Reference
-description: The class DSImageManager of Dynamsoft Capture Vision Router Module is a utility class for managing and manipulating images. It provides functionality for saving images to files and drawing various shapes on images.
-keywords: image manager, objective-c, swift
-needGenerateH3Content: true
-needAutoGenerateSidebar: true
-noTitleIndex: true
-ignore: true
----
-
-# DSImageManager
-
-The `DSImageManager` class is a utility class for managing and manipulating images. It provides functionality for saving images to files and drawing various shapes on images.
-
-## Definition
-
-*Assembly:* DynamsoftCaptureVisionBundle.xcframework
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-@interface DSImageManager : NSObject
-```
-2.
-```swift
-class ImageManager : NSObject
-```
-
-## Methods
-
-| Method | Description |
-| ------ | ----------- |
-| [`saveToFile`](#savetofile) | Saves an image to the specified path and format. |
-| [`drawOnImage(image,quads,colour,thickness)`](#drawonimageimagequadscolourthickness) | Add quadrilaterals on the image. |
-| [`drawOnImage(image,lines,colour,thickness)`](#drawonimageimagelinesegmentscolourthickness) | Add lines on the image. |
-| [`drawOnImage(image,contours,colour,thickness)`](#drawonimageimagecontourscolourthickness) | Add contours on the image. |
-| [`drawOnImage(image,corners,colour,thickness)`](#drawonimageimagecornerscolourthickness) | Add corners on the image. |
-| [`drawOnImage(image,edges,colour,thickness)`](#drawonimageimageedgescolourthickness) | Add edges on the image. |
-
-### saveToFile
-
-Saves an image to the specified path and format. The desired file format is inferred from the file extension provided in the `path` parameter.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (BOOL)saveToFile:(DSImageData *)imageData
- path:(NSString *)path
- overWrite:(BOOL)overWrite
- error:(NSError * _Nullable * _Nullable)error;
-```
-2.
-```swift
-func save(toFile imageData: ImageData, path: String, overWrite: Bool) throws -> Bool
-```
-
-**Parameters**
-
-`imageData`: The image to be saved, of type `ImageData`.
-
-`path`: The file path, name and extension name, as a string, under which the image will be saved.
-
-`overWrite`: A flag indicating whether to overwrite the file if it already exists. Defaults to true.
-
-`error`: An `NSError` pointer. If an error occurs, it will represent the error information.
-
-**Error**
-
-| Error Code | Value | Description |
-| :--------- | :---- | :---------- |
-| EC_NULL_POINTER | -10002 | The ImageData object is null. |
-| EC_FILE_TYPE_NOT_SUPPORTED | -10006 | The file type is not supported. |
-| EC_FILE_ALREADY_EXISTS | -10067 | The file already exists but overwriting is disabled. |
-| EC_CREATE_FILE_FAILED | -10068 | The file path does not exist but cannot be created, or the file cannot be created for any other reason. |
-| EC_IMGAE_DATA_INVALID | -10069 | The input ImageData object contains invalid parameter(s). |
-
-**Return Value**
-
-A `BOOL` value that indicates whether the file is saved successfully.
-
-### drawOnImage(image,quads,colour,thickness)
-
-Add quadrilaterals on the image.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (DSImageData *)drawOnImage:(DSImageData *)image
- quads:(NSArray *)quads
- colour:(UIColor)colour
- thickness:(NSInteger)thickness;
-```
-2.
-```swift
-func drawOnImage(_ image: ImageData, quads: [Quadrilateral], colour: UIColor, thickness: Int) -> ImageData
-```
-**Parameters**
-
-`image`: The `ImageData` to modify.
-
-`quads`: An array of `Quadrilateral` objects to be added on the image.
-
-`colour`: A `UIColor` that specifies the targeting colour.
-
-`thickness`: The width of the border.
-
-**Return Value**
-
-The modified `ImageData`.
-
-### drawOnImage(image,lineSegments,colour,thickness)
-
-Add lines on the image.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (DSImageData *)drawOnImage:(DSImageData *)image
- lineSegments:(NSArray *)lineSegments
- colour:(UIColor)colour
- thickness:(NSInteger)thickness;
-```
-2.
-```swift
-func drawOnImage(_ image: ImageData, lineSegments: [LineSegment], colour: UIColor, thickness: Int) -> ImageData
-```
-**Parameters**
-
-`image`: The `ImageData` to modify.
-
-`lineSegments`: An array of `LineSegment` objects to be added on the image.
-
-`colour`: A `UIColor` that specifies the targeting colour.
-
-`thickness`: The width of the lines.
-
-**Return Value**
-
-The modified `ImageData`.
-
-### drawOnImage(image,contours,colour,thickness)
-
-Add contours on the image.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (DSImageData *)drawOnImage:(DSImageData *)image
- contours:(NSArray *)contours
- colour:(UIColor)colour
- thickness:(NSInteger)thickness;
-```
-2.
-```swift
-func drawOnImage(_ image: ImageData, contours: [Contour], colour: UIColor, thickness: Int) -> ImageData
-```
-**Parameters**
-
-`image`: The `ImageData` to modify.
-
-`contours`: An array of `Contour` objects to be added on the image.
-
-`colour`: A `UIColor` that specifies the targeting colour.
-
-`thickness`: The width of the borders.
-
-**Return Value**
-
-The modified `ImageData`.
-
-### drawOnImage(image,corners,colour,thickness)
-
-Add corners on the image.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (DSImageData *)drawOnImage:(DSImageData *)image
- corners:(NSArray *)corners
- colour:(UIColor)colour
- thickness:(NSInteger)thickness;
-```
-2.
-```swift
-func drawOnImage(_ image: ImageData, corners: [Corner], colour: UIColor, thickness: Int) -> ImageData
-```
-**Parameters**
-
-`image`: The `ImageData` to modify.
-
-`corners`: An array of `Corner` objects to be added on the image.
-
-`colour`: A `UIColor` that specifies the targeting colour.
-
-`thickness`: The width of the lines.
-
-**Return Value**
-
-The modified `ImageData`.
-
-### drawOnImage(image,edges,colour,thickness)
-
-Add edges on the image.
-
-
->- Objective-C
->- Swift
->
->1.
-```objc
-- (DSImageData *)drawOnImage:(DSImageData *)image
- edges:(NSArray *)edges
- colour:(UIColor)colour
- thickness:(NSInteger)thickness;
-```
-2.
-```swift
-func drawOnImage(_ image: ImageData, edges: [Edge], colour: UIColor, thickness: Int) -> ImageData
-```
-
-**Parameters**
-
-`image`: The `ImageData` to modify.
-`edges`: An array of `DSEdge` objects to be added on the image.
-`colour`: A `UIColor` that specifies the targeting colour.
-`thickness`: The width of the lines.
-
-**Return Value**
-
-The modified `ImageData`.
diff --git a/programming/ios/api-reference/utility/image-processor.md b/programming/ios/api-reference/utility/image-processor.md
index 31a9cd08..2d14ddcd 100644
--- a/programming/ios/api-reference/utility/image-processor.md
+++ b/programming/ios/api-reference/utility/image-processor.md
@@ -36,8 +36,8 @@ class ImageProcessor : NSObject
| [`cropImage(imageData,rect)`](#cropimageimagedatarect) | Crops an image based on the provided rectangle or quadrilateral. |
| [`cropAndDeskewImage(imageData,quad,dstWidth,dstHeight,padding)`](#cropanddeskewimageimagedataquaddstwidthdstheightpaddingerrorcode) | Crops and deskew an image based on the provided quadrilateral and additional information. |
| [`cropAndDeskewImage(imageData,quad)`](#cropanddeskewimageimagedataquad) | Crops and deskew an image based on the provided quadrilateral. |
-| [`adjust(imageData,brightness)`](#adjustbrightness) | Adjusts the brightness of an image. |
-| [`adjust(imageData,contrast)`](#adjustcontrast) | Adjusts the contrast of an image. |
+| [`adjust(imageData,brightness)`](#adjustimagedatabrightness) | Adjusts the brightness of an image. |
+| [`adjust(imageData,contrast)`](#adjustimagedatacontrast) | Adjusts the contrast of an image. |
| [`filterImage`](#filterimage) | Applies a filter to an image. |
| [`convertToGray(imageData)`](#converttograyimagedata) | Converts an image to grayscale. |
| [`convertToGray(imageData,rgb)`](#converttograyimagedatargb) | Converts an image to grayscale. |
@@ -56,9 +56,9 @@ Crops an image based on the provided rectangle.
>
>1.
```objc
-- (DSImageData *)cropImage:(DSImageData *)imageData
- rect:(DSRect *)rect
- error:(NSError * _Nullable * _Nullable)error;
+- (nullable DSImageData *)cropImage:(DSImageData *)imageData
+ rect:(DSRect *)rect
+ error:(NSError * _Nullable * _Nullable)error;
```
2.
```swift
diff --git a/programming/ios/api-reference/utility/multi-frame-result-cross-filter.md b/programming/ios/api-reference/utility/multi-frame-result-cross-filter.md
index 79e805da..3fe8a266 100644
--- a/programming/ios/api-reference/utility/multi-frame-result-cross-filter.md
+++ b/programming/ios/api-reference/utility/multi-frame-result-cross-filter.md
@@ -33,20 +33,20 @@ class MultiFrameResultCrossFilter: NSObject, CapturedResultFilter
| Method | Description |
| ------ | ----------- |
-| [`enableLatestOverlapping`](#enablelatestoverlapping) | Enables or disables the to-the-latest overlapping feature of one or multiple specific result item types. This feature can sharpenly increase the read-rate performance when decoding multiple barcodes under the video streaming. |
| [`enableResultCrossVerification`](#enableresultcrossverification) | Enables or disables the verification of one or multiple specific result item types. |
+| [`isResultCrossVerificationEnabled`](#isresultcrossverificationenabled) | Checks if verification is active for a given result item type. |
| [`enableResultDeduplication`](#enableresultdeduplication) | Enables or disables the deduplication process for one or multiple specific result item types. |
+| [`setDuplicateForgetTime`](#setduplicateforgettime) | Sets the interval during which duplicates are disregarded for specific result item types. |
| [`getDuplicateForgetTime`](#getduplicateforgettime) | Gets the interval during which duplicates are disregarded for a given result item type. |
-| [`getMaxOverlappingFrames`](#getmaxoverlappingframes) | Get the maximum overlapping frames count for a given result item type. |
-| [`isLatestOverlappingEnabled`](#islatestoverlappingenabled) | Checks if to-the-latest overlapping is active for a given result item type. |
-| [`isResultCrossVerificationEnabled`](#isresultcrossverificationenabled) | Checks if verification is active for a given result item type. |
| [`isResultDeduplicationEnabled`](#isresultdeduplicationenabled) | Checks if deduplication is active for a given result item type. |
-| [`setDuplicateForgetTime`](#setduplicateforgettime) | Sets the interval during which duplicates are disregarded for specific result item types. |
+| [`enableLatestOverlapping`](#enablelatestoverlapping) | Enables or disables the to-the-latest overlapping feature of one or multiple specific result item types. This feature can sharpenly increase the read-rate performance when decoding multiple barcodes under the video streaming. |
| [`setMaxOverlappingFrames`](#setmaxoverlappingframes) | Set the maximum overlapping frames count for a given result item type. |
+| [`getMaxOverlappingFrames`](#getmaxoverlappingframes) | Get the maximum overlapping frames count for a given result item type. |
+| [`isLatestOverlappingEnabled`](#islatestoverlappingenabled) | Checks if to-the-latest overlapping is active for a given result item type. |
-### enableLatestOverlapping
+### enableResultCrossVerification
-Enables or disables the to-the-latest overlapping feature of one or multiple specific result item types. This feature can sharpenly increase the read-rate performance when decoding multiple barcodes under the video streaming.
+Enables or disables the verification of one or multiple specific result item types.
>- Objective-C
@@ -54,23 +54,23 @@ Enables or disables the to-the-latest overlapping feature of one or multiple spe
>
>1.
```objc
-- (void)enableLatestOverlapping:(DSCapturedResultItemType)resultItemTypes
- isEnabled:(BOOL)isEnabled;
+- (void)enableResultCrossVerification:(DSCapturedResultItemType)resultItemType
+ isEnabled:(BOOL)isEnabled;
```
2.
```swift
-func enableLatestOverlapping(resultItemTypes: DSCapturedResultItemType, isEnabled: Bool)
+func enableResultCrossVerification(resultItemType: DSCapturedResultItemType, isEnabled: Bool)
```
**Parameters**
-`[in] type`: Specifies the result item type with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
+`resultItemType`: Specifies one or multiple specific result item types, which can be defined using [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
-`[in] enable`: Bool to toggle to-the-latest overlapping on or off.
+`isEnabled`: A BOOL value that indicates whether to enable the result cross verification feature.
-### enableResultCrossVerification
+### isResultCrossVerificationEnabled
-Enables or disables the verification of one or multiple specific result item types.
+Checks if verification is active for a given result item type.
>- Objective-C
@@ -78,19 +78,20 @@ Enables or disables the verification of one or multiple specific result item typ
>
>1.
```objc
-- (void)enableResultCrossVerification:(DSCapturedResultItemType)resultItemType
- isEnabled:(BOOL)isEnabled;
+- (bool)isResultCrossVerificationEnabled:(DSCapturedResultItemType)resultItemType;
```
2.
```swift
-func enableResultCrossVerification(resultItemType: DSCapturedResultItemType, isEnabled: Bool)
+func isResultCrossVerificationEnabled(resultItemType: DSCapturedResultItemType) -> Bool
```
**Parameters**
-`resultItemType`: Specifies one or multiple specific result item types, which can be defined using [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
+`resultItemType`: Specifies the result item type with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
-`isEnabled`: A BOOL value that indicates whether to enable the result cross verification feature.
+**Return Value**
+
+Boolean indicating the status of verification for the specified type.
### enableResultDeduplication
@@ -116,9 +117,9 @@ func enableResultDeduplication(resultItemType: DSCapturedResultItemType, isEnabl
`isEnabled`: A BOOL value that indicates whether to enable the result deduplication feature.
-### getDuplicateForgetTime
+### setDuplicateForgetTime
-Gets the interval during which duplicates are disregarded for a given result item type.
+Sets the interval during which duplicates are disregarded for specific result item types.
>- Objective-C
@@ -126,24 +127,23 @@ Gets the interval during which duplicates are disregarded for a given result ite
>
>1.
```objc
-- (NSInteger)getDuplicateForgetTime:(DSCapturedResultItemType)resultItemType;
+- (void)setDuplicateForgetTime:(DSCapturedResultItemType)resultItemType
+ duplicateForgetTime:(NSInteger)duplicateForgetTime;
```
2.
```swift
-func getDuplicateForgetTime(resultItemType: DSCapturedResultItemType) -> Int
+func setDuplicateForgetTime(resultItemType: DSCapturedResultItemType, duplicateForgetTime: Int)
```
**Parameters**
-`resultItemType`: Specifies the result item type with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
-
-**Return Value**
+`resultItemType`: Specifies one or multiple specific result item types, which can be defined using [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
-The set interval for the specified item type.
+`duplicateForgetTime`: The duplicate forget time of the specified capture result type.
-### getMaxOverlappingFrames
+### getDuplicateForgetTime
-Get the maximum overlapping frames count for a given result item type.
+Gets the interval during which duplicates are disregarded for a given result item type.
>- Objective-C
@@ -151,24 +151,24 @@ Get the maximum overlapping frames count for a given result item type.
>
>1.
```objc
-- (NSInteger)getMaxOverlappingFrames:(DSCapturedResultItemType)resultItemType;
+- (NSInteger)getDuplicateForgetTime:(DSCapturedResultItemType)resultItemType;
```
2.
```swift
-func getMaxOverlappingFrames(resultItemType: DSCapturedResultItemType) -> Int
+func getDuplicateForgetTime(resultItemType: DSCapturedResultItemType) -> Int
```
**Parameters**
-`[in] type`: Specifies the result item type with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
+`resultItemType`: Specifies the result item type with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
**Return Value**
-The maximum overlapping frame count for the overlapping.
+The set interval for the specified item type.
-### isLatestOverlappingEnabled
+### isResultDeduplicationEnabled
-Checks if to-the-latest overlapping is active for a given result item type.
+Checks if deduplication is active for a given result item type.
>- Objective-C
@@ -176,24 +176,24 @@ Checks if to-the-latest overlapping is active for a given result item type.
>
>1.
```objc
-- (BOOL)isLatestOverlappingEnabled:(DSCapturedResultItemType)resultItemTypes;
+- (bool)isResultDeduplicationEnabled:(DSCapturedResultItemType)resultItemType;
```
2.
```swift
-func isLatestOverlappingEnabled(resultItemType: DSCapturedResultItemType) -> Bool
+func isResultDeduplicationEnabled(resultItemType: DSCapturedResultItemType) -> Bool
```
**Parameters**
-`[in] type`: Specifies the result item type with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
+`resultItemType`: Specifies the result item type with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
**Return Value**
-Boolean indicating the to-the-latest overlapping status for the specified type.
+Boolean indicating the deduplication status for the specified type.
-### isResultDeduplicationEnabled
+### enableLatestOverlapping
-Checks if deduplication is active for a given result item type.
+Enables or disables the to-the-latest overlapping feature of one or multiple specific result item types. This feature can sharpenly increase the read-rate performance when decoding multiple barcodes under the video streaming.
>- Objective-C
@@ -201,24 +201,23 @@ Checks if deduplication is active for a given result item type.
>
>1.
```objc
-- (bool)isResultDeduplicationEnabled:(DSCapturedResultItemType)resultItemType;
+- (void)enableLatestOverlapping:(DSCapturedResultItemType)resultItemTypes
+ isEnabled:(BOOL)isEnabled;
```
2.
```swift
-func isResultDeduplicationEnabled(resultItemType: DSCapturedResultItemType) -> Bool
+func enableLatestOverlapping(resultItemTypes: DSCapturedResultItemType, isEnabled: Bool)
```
**Parameters**
-`resultItemType`: Specifies the result item type with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
-
-**Return Value**
+`[in] type`: Specifies the result item type with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
-Boolean indicating the deduplication status for the specified type.
+`[in] enable`: Bool to toggle to-the-latest overlapping on or off.
-### isResultCrossVerificationEnabled
+### setMaxOverlappingFrames
-Checks if verification is active for a given result item type.
+Set the maximum overlapping frames count for a given result item type.
>- Objective-C
@@ -226,24 +225,23 @@ Checks if verification is active for a given result item type.
>
>1.
```objc
-- (bool)isResultCrossVerificationEnabled:(DSCapturedResultItemType)resultItemType;
+- (void)setMaxOverlappingFrames:(DSCapturedResultItemType)resultItemTypes
+ maxOverlappingFrames:(NSInteger)maxOverlappingFrames;
```
2.
```swift
-func isResultCrossVerificationEnabled(resultItemType: DSCapturedResultItemType) -> Bool
+func setMaxOverlappingFrames(resultItemType: DSCapturedResultItemType, maxOverlappingFrames: Int)
```
**Parameters**
-`resultItemType`: Specifies the result item type with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
-
-**Return Value**
+`[in] type`: Specifies the result item type with [`EnumCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
-Boolean indicating the status of verification for the specified type.
+`[in] maxOverlappingFrames`: The maximum overlapping frame count for the overlapping.
-### setDuplicateForgetTime
+### getMaxOverlappingFrames
-Sets the interval during which duplicates are disregarded for specific result item types.
+Get the maximum overlapping frames count for a given result item type.
>- Objective-C
@@ -251,23 +249,24 @@ Sets the interval during which duplicates are disregarded for specific result it
>
>1.
```objc
-- (void)setDuplicateForgetTime:(DSCapturedResultItemType)resultItemType
- duplicateForgetTime:(NSInteger)duplicateForgetTime;
+- (NSInteger)getMaxOverlappingFrames:(DSCapturedResultItemType)resultItemType;
```
2.
```swift
-func setDuplicateForgetTime(resultItemType: DSCapturedResultItemType, duplicateForgetTime: Int)
+func getMaxOverlappingFrames(resultItemType: DSCapturedResultItemType) -> Int
```
**Parameters**
-`resultItemType`: Specifies one or multiple specific result item types, which can be defined using [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
+`[in] type`: Specifies the result item type with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
-`duplicateForgetTime`: The duplicate forget time of the specified capture result type.
+**Return Value**
-### setMaxOverlappingFrames
+The maximum overlapping frame count for the overlapping.
-Set the maximum overlapping frames count for a given result item type.
+### isLatestOverlappingEnabled
+
+Checks if to-the-latest overlapping is active for a given result item type.
>- Objective-C
@@ -275,16 +274,17 @@ Set the maximum overlapping frames count for a given result item type.
>
>1.
```objc
-- (void)setMaxOverlappingFrames:(DSCapturedResultItemType)resultItemTypes
- maxOverlappingFrames:(NSInteger)maxOverlappingFrames;
+- (BOOL)isLatestOverlappingEnabled:(DSCapturedResultItemType)resultItemTypes;
```
2.
```swift
-func setMaxOverlappingFrames(resultItemType: DSCapturedResultItemType, maxOverlappingFrames: Int)
+func isLatestOverlappingEnabled(resultItemType: DSCapturedResultItemType) -> Bool
```
**Parameters**
-`[in] type`: Specifies the result item type with [`EnumCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
+`[in] type`: Specifies the result item type with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift).
-`[in] maxOverlappingFrames`: The maximum overlapping frame count for the overlapping.
+**Return Value**
+
+Boolean indicating the to-the-latest overlapping status for the specified type.
diff --git a/programming/maui/api-reference/utility/image-io.md b/programming/maui/api-reference/utility/image-io.md
index 7ef37440..6965f0e9 100644
--- a/programming/maui/api-reference/utility/image-io.md
+++ b/programming/maui/api-reference/utility/image-io.md
@@ -1,16 +1,16 @@
---
layout: default-layout
-title: ImageIO - Dynamsoft Capture Vision Router Module MAUI Edition API Reference
-description: The class ImageIO of Dynamsoft Capture Vision MAUI is a utility class that provides functionality for reading and saving images.
+title: DMImageIO - Dynamsoft Capture Vision Router Module MAUI Edition API Reference
+description: The class DMImageIO of Dynamsoft Capture Vision MAUI is a utility class that provides functionality for reading and saving images.
keywords: image IO, MAUI
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---
-# ImageIO
+# DMImageIO
-The `ImageIO` class is a utility class that provides functionality for reading and saving images.
+The `DMImageIO` class is a utility class that provides functionality for reading and saving images.
## Definition
@@ -19,7 +19,7 @@ The `ImageIO` class is a utility class that provides functionality for reading a
*Assembly:* Dynamsoft.Utility.Maui
```csharp
-class ImageIO
+class DMImageIO
```
## Methods