Skip to content

Commit 761a863

Browse files
update to internal commit f2b3c78b
1 parent 001ce66 commit 761a863

File tree

4 files changed

+28
-45
lines changed

4 files changed

+28
-45
lines changed

programming/javascript/api-reference/capture-vision-router/capture-vision-router-module.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -89,17 +89,16 @@ The `CaptureVisionRouterModule` class defines common functionality in the `Captu
8989

9090
## CapturedResultReceiver Class
9191

92-
The `CapturedResultReceiver` class is designed as a standardized way for retrieving captured results in the Dynamsoft Capture Vision architecture. It adopts an event-driven approach, with events dedicated to various result types, such as the original image, decoded barcodes, recognized text lines, detected quads, normalized images, and parsed results, etc.
93-
94-
| Name | Description |
95-
| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
96-
| [onCapturedResultReceived()](./captured-result-receiver.md#oncapturedresultreceived) | Event triggered when a generic captured result is available. |
97-
| [onOriginalImageResultReceived()](./captured-result-receiver.md#onoriginalimageresultreceived) | Event triggered when the original image result is available. |
98-
| [onDecodedBarcodesReceived()](./captured-result-receiver.md#ondecodedbarcodesreceived) | Event triggered when decoded barcodes are available. |
99-
| [onRecognizedTextLinesReceived()](./captured-result-receiver.md#onrecognizedtextlinesreceived) | Event triggered when recognized text lines are available. |
100-
| [onDetectedQuadsReceived()](./captured-result-receiver.md#ondetectedquadsreceived) | Event triggered when detected quads are available. |
101-
| [onNormalizedImagesReceived()](./captured-result-receiver.md#onnormalizedimagesreceived) | Event triggered when normalized images are available. |
102-
| [onParsedResultsReceived()](./captured-result-receiver.md#onparsedresultsreceived) | Event triggered when parsed results are available. |
92+
The `CapturedResultReceiver` class is designed as a standardized way for retrieving captured results in the Dynamsoft Capture Vision architecture. It adopts an event-driven approach, with events dedicated to various result types, such as the original image, decoded barcodes, recognized text lines, processed documents, and parsed results, etc.
93+
94+
| Name | Description |
95+
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
96+
| [onCapturedResultReceived()](./captured-result-receiver.md#oncapturedresultreceived) | Event triggered when a generic captured result is available. |
97+
| [onOriginalImageResultReceived()](./captured-result-receiver.md#onoriginalimageresultreceived) | Event triggered when the original image result is available. |
98+
| [onDecodedBarcodesReceived()](./captured-result-receiver.md#ondecodedbarcodesreceived) | Event triggered when decoded barcodes are available. |
99+
| [onRecognizedTextLinesReceived()](./captured-result-receiver.md#onrecognizedtextlinesreceived) | Event triggered when recognized text lines are available. |
100+
| [onProcessedDocumentResultReceived()](./captured-result-receiver.md#onprocesseddocumentresultreceived) | Event triggered when processed documents are available. |
101+
| [onParsedResultsReceived()](./captured-result-receiver.md#onparsedresultsreceived) | Event triggered when parsed results are available. |
103102

104103
## IntermediateResultManager Class
105104

@@ -124,7 +123,6 @@ The `IntermediateResultReceiver` class is designed as a standardized way for ret
124123
| [onLocalizedTextLinesReceived()](./intermediate-result-receiver.md#onlocalizedtextlinesreceived) | Event triggered when localized text lines are received. |
125124
| [onRecognizedTextLinesReceived()](./intermediate-result-receiver.md#onrecognizedtextlinesreceived) | Event triggered when recognized text lines are received. |
126125
| [onDetectedQuadsReceived()](./intermediate-result-receiver.md#ondetectedquadsreceived) | Event triggered when detected quads are received. |
127-
| [onNormalizedImagesReceived()](./intermediate-result-receiver.md#onnormalizedimagesreceived) | Event triggered when normalized images are received. |
128126
| [onColourImageUnitReceived()](./intermediate-result-receiver.md#oncolourimageunitreceived) | Event triggered when a colour image unit is received. |
129127
| [onScaledDownColourImageUnitReceived()](./intermediate-result-receiver.md#onscaleddowncolourimageunitreceived) | Event triggered when a scaled-down colour image unit is received. |
130128
| [onGrayscaleImageUnitReceived()](./intermediate-result-receiver.md#ongrayscaleimageunitreceived) | Event triggered when a grayscale image unit is received. |

programming/javascript/api-reference/capture-vision-router/interfaces/captured-result-filter.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,20 @@ breadcrumbText: JS CapturedResultFilter Interface
1313

1414
# CapturedResultFilter
1515

16-
The `CapturedResultReceiver` class is designed as a standardized way for retrieving captured results in the Dynamsoft Capture Vision architecture. It adopts an event-driven approach, with events dedicated to various result types, such as the original image, decoded barcodes, recognized text lines, detected quads, normalized images, and parsed results, etc.
16+
The `CapturedResultReceiver` class is designed as a standardized way for retrieving captured results in the Dynamsoft Capture Vision architecture. It adopts an event-driven approach, with events dedicated to various result types, such as the original image, decoded barcodes, recognized text lines, processed documents, and parsed results, etc.
1717

1818
```typescript
1919
class CapturedResultReceiver {
2020
onCapturedResultReceived?(result: CapturedResult): void;
2121
onOriginalImageResultReceived?(result: OriginalImageResultItem): void;
2222
onDecodedBarcodesReceived?(result: DecodedBarcodesResult): void;
2323
onRecognizedTextLinesReceived?(result: RecognizedTextLinesResult):void;
24-
onDetectedQuadsReceived?(result: DetectedQuadsResult): void;
25-
onNormalizedImagesReceived?(result: NormalizedImagesResult): void;
24+
onProcessedDocumentResultReceived?(result: DetectedQuadsResult): void;
2625
onParsedResultsReceived?(result: ParsedResult): void;
2726
}
2827
```
2928

30-
31-
32-
The `CapturedResultFilter` interface defines the standard way to get processing results. It contains several callback functions for different types of results, including original image, decoded barcodes, recognized text lines, detected quads, normalized images, and parsed results.
29+
The `CapturedResultFilter` interface defines the standard way to get processing results. It contains several callback functions for different types of results, including original image, decoded barcodes, recognized text lines, processed documents, and parsed results.
3330

3431

3532
## OnOriginalImageResultReceived
@@ -68,29 +65,17 @@ onRecognizedTextLinesReceived(result: DLR.RecognizedTextLinesResult): void;
6865

6966
`result`: The recognized text lines result.
7067

71-
## OnDetectedQuadsReceived
72-
73-
Callback function for detected quads results. It will be called once for each detected quads result.
74-
75-
```typescript
76-
onDetectedQuadsReceived(result: DDN.DetectedQuadsResult): void;
77-
```
78-
79-
**Parameters**
80-
81-
`result`: The detected quads result.
82-
83-
## OnNormalizedImagesReceived
68+
## onProcessedDocumentResultReceived
8469

85-
Callback function for normalized images results. It will be called once for each normalized images result.
70+
Callback function for processed document results. It will be called once for each processed documents result.
8671

8772
```typescript
88-
onNormalizedImagesReceived(result: DDN.NormalizedImagesResult): void;
73+
onProcessedDocumentResultReceived(result: DDN.ProcessedDocumentResult): void;
8974
```
9075

9176
**Parameters**
9277

93-
`result`: The normalized images result.
78+
`result`: The processed documents result.
9479

9580
## OnParsedResultsReceived
9681

programming/javascript/api-reference/core/basic-structures/captured-result.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The `CapturedResult` interface describes the basic structure of a result object
1919
>
2020
> * dynamsoft-barcode-reader: [DecodedBarcodesResult](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interfaces/decoded-barcodes-result.html)
2121
> * dynamsoft-label-recognizer: [RecognizedTextLinesResult](https://www.dynamsoft.com/label-recognition/docs/web/programming/javascript/api-reference/interfaces/recognized-textlines-result.html)
22-
> * dynamsoft-document-normalizer: [DetectedQuadsResult](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/detected-quads-result.html) or [NormalizedImagesResult](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/normalized-images-result.html)
22+
> * dynamsoft-document-normalizer: [ProcessedDocumentResult](https://www.dynamsoft.com/document-normalizer/docs/web/programming/javascript/api-reference/interfaces/processed-document-result.html)
2323
> * dynamsoft-code-parser: [ParsedResult](https://www.dynamsoft.com/code-parser/docs/web/programming/javascript/api-reference/interfaces/parsed-result.html)
2424
2525
```typescript

programming/javascript/api-reference/utility/multi-frame-result-cross-filter.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Enables or disables the latest overlapping of specific result item types.
3636
> Please note that this feature is currently only available for barcodes reading.
3737
3838
```typescript
39-
enableLatestOverlapping(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", enabled: boolean): void;
39+
enableLatestOverlapping(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image" | "enhanced_image", enabled: boolean): void;
4040
```
4141

4242
**Parameters**
@@ -58,7 +58,7 @@ None.
5858
Checks if latest overlapping is active for a given result item type.
5959

6060
```typescript
61-
isLatestOverlappingEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): boolean;
61+
isLatestOverlappingEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image" | "enhanced_image"): boolean;
6262
```
6363

6464
**Parameters**
@@ -78,7 +78,7 @@ Boolean indicating the status of the latest overlapping for the specified type.
7878
Enables or disables the verification of specific result item types.
7979

8080
```typescript
81-
enableResultCrossVerification(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", enabled: boolean): void;
81+
enableResultCrossVerification(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image" | "enhanced_image", enabled: boolean): void;
8282
```
8383

8484
**Parameters**
@@ -100,7 +100,7 @@ None.
100100
Checks if verification is active for a given result item type.
101101

102102
```typescript
103-
isResultCrossVerificationEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): boolean;
103+
isResultCrossVerificationEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image" | "enhanced_image"): boolean;
104104
```
105105

106106
**Parameters**
@@ -120,7 +120,7 @@ Boolean indicating the status of verification for the specified type.
120120
Enables or disables the deduplication process for specific result item types.
121121

122122
```typescript
123-
enableResultDeduplication(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", enabled: boolean): void;
123+
enableResultDeduplication(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image" | "enhanced_image", enabled: boolean): void;
124124
```
125125

126126
**Parameters**
@@ -142,7 +142,7 @@ None.
142142
Checks if deduplication is active for a given result item type.
143143

144144
```typescript
145-
isResultDeduplicationEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): boolean;
145+
isResultDeduplicationEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image" | "enhanced_image"): boolean;
146146
```
147147

148148
**Parameters**
@@ -162,7 +162,7 @@ Boolean indicating the deduplication status for the specified type.
162162
Sets the interval during which duplicates are disregarded for specific result item types.
163163

164164
```typescript
165-
setDuplicateForgetTime(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", time: number): void;
165+
setDuplicateForgetTime(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image" | "enhanced_image", time: number): void;
166166
```
167167

168168
**Parameters**
@@ -184,7 +184,7 @@ None.
184184
Retrieves the interval during which duplicates are disregarded for a given result item type.
185185

186186
```typescript
187-
getDuplicateForgetTime(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): number;
187+
getDuplicateForgetTime(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image" | "enhanced_image"): number;
188188
```
189189

190190
**Parameters**
@@ -204,7 +204,7 @@ The set interval for the specified item type.
204204
Set the maximum overlapping frames count for a given result item type.
205205

206206
```typescript
207-
setMaxOverlappingFrames(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", maxOverlappingFrames: number): void;
207+
setMaxOverlappingFrames(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image" | "enhanced_image", maxOverlappingFrames: number): void;
208208
```
209209

210210
**Parameters**
@@ -226,7 +226,7 @@ None.
226226
Get the maximum overlapping frames count for a given result item type.
227227

228228
```typescript
229-
getMaxOverlappingFrames(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): number;
229+
getMaxOverlappingFrames(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image" | "enhanced_image"): number;
230230
```
231231

232232
**Parameters**

0 commit comments

Comments
 (0)