Skip to content

Commit 2f98eb5

Browse files
update to internal commit f8efb7e3
1 parent 94f3707 commit 2f98eb5

File tree

13 files changed

+161
-131
lines changed

13 files changed

+161
-131
lines changed

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ repositoryUrl: https://github.com/dynamsoft-docs/capture-vision-docs-js/blob/mai
22
repository: dynamsoft-docs/capture-vision-docs-js
33
docFullPath: https://www.dynamsoft.com/capture-vision/docs/web/
44
firstLevelUrl: /capture-vision/docs/web/
5+
docRootName: "Dynamsoft Capture Vision JS Edition"
56
docHomePage: /capture-vision/docs/core/introduction/
67

78
introduction: /capture-vision/docs/core/introduction/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,6 @@ static getVersion(): string;
2828
**Code snippet**
2929

3030
```javascript
31-
const version = Dynamsoft.CaptureVisionRouter.CaptureVisionRouterModule.getVersion();
31+
const version = Dynamsoft.CVR.CaptureVisionRouterModule.getVersion();
3232
console.log(version);
3333
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The APIs for this class are:
7272
| [updateSettings()](./settings.md#updatesettings) | Updates a specified `CaptureVisionTemplate` with an updated `SimplifiedCaptureVisionSettings` object. |
7373
| [resetSettings()](./settings.md#resetsettings) | Resets settings to factory default. |
7474

75-
### Others
75+
### Intermediate Result
7676

7777
| API Name | Description |
7878
| --------------------------------------------------------------------------------------- | ---------------------------------------------- |

programming/javascript/api-reference/capture-vision-router/interfaces/intermediate-result-receiver.md

Lines changed: 26 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,14 @@ The `IntermediateResultReceiver` interface is responsible for receiving intermed
1414

1515
```typescript
1616
interface IntermediateResultReceiver {
17-
getObservationParameters(): ObservationParameters;
1817
onTaskResultsReceived?(result: IntermediateResult, info: IntermediateResultExtraInfo): void;
1918
onPredetectedRegionsReceived?(result: PredetectedRegionsUnit, info: IntermediateResultExtraInfo): void;
20-
onLocalizedBarcodesReceived?(result: DBR.IntermediateResult.LocalizedBarcodesUnit, info: IntermediateResultExtraInfo): void;
21-
onDecodedBarcodesReceived?(result: DBR.IntermediateResult.DecodedBarcodesUnit, info: IntermediateResultExtraInfo): void;
22-
onLocalizedTextLinesReceived?(result: DLR.IntermediateResult.LocalizedTextLinesUnit, info: IntermediateResultExtraInfo): void;
23-
onRecognizedTextLinesReceived?(result: DLR.IntermediateResult.RecognizedTextLinesUnit, info: IntermediateResultExtraInfo): void;
24-
onDetectedQuadsReceived?(result: DDN.IntermediateResult.DetectedQuadsUnit, info: IntermediateResultExtraInfo): void;
25-
onNormalizedImagesReceived?(result: DDN.IntermediateResult.NormalizedImagesUnit, info: IntermediateResultExtraInfo): void;
19+
onLocalizedBarcodesReceived?(result: LocalizedBarcodesUnit, info: IntermediateResultExtraInfo): void;
20+
onDecodedBarcodesReceived?(result: DecodedBarcodesUnit, info: IntermediateResultExtraInfo): void;
21+
onLocalizedTextLinesReceived?(result: LocalizedTextLinesUnit, info: IntermediateResultExtraInfo): void;
22+
onRecognizedTextLinesReceived?(result: RecognizedTextLinesUnit, info: IntermediateResultExtraInfo): void;
23+
onDetectedQuadsReceived?(result: DetectedQuadsUnit, info: IntermediateResultExtraInfo): void;
24+
onNormalizedImagesReceived?(result: NormalizedImagesUnit, info: IntermediateResultExtraInfo): void;
2625
onColourImageUnitReceived?(result: ColourImageUnit, info: IntermediateResultExtraInfo): void;
2726
onScaledDownColourImageUnitReceived?(result: ScaledDownColourImageUnit, info: IntermediateResultExtraInfo): void;
2827
onGrayscaleImageUnitReceived?(result: GrayscaleImageUnit, info: IntermediateResultExtraInfo): void;
@@ -36,13 +35,13 @@ interface IntermediateResultReceiver {
3635
onLineSegmentsUnitReceived?(result: LineSegmentsUnit, info: IntermediateResultExtraInfo): void;
3736
onTextZonesUnitReceived?(result: TextZonesUnit, info: IntermediateResultExtraInfo): void;
3837
onTextRemovedBinaryImageUnitReceived?(result: TextRemovedBinaryImageUnit, info: IntermediateResultExtraInfo): void;
39-
onLongLinesUnitReceived?(result: DDN.IntermediateResult.LongLinesUnit, info: IntermediateResultExtraInfo): void;
40-
onCornersUnitReceived?(result: DDN.IntermediateResult.CornersUnit, info: IntermediateResultExtraInfo): void;
41-
onCandidateQuadEdgesUnitReceived?(result: DDN.IntermediateResult.CandidateQuadEdgesUnit, info: IntermediateResultExtraInfo): void;
42-
onCandidateBarcodeZonesUnitReceived?(result: DBR.IntermediateResult.LocalizedBarcodesUnit, info: IntermediateResultExtraInfo): void;
43-
onScaledUpBarcodeImageUnitReceived?(result: DBR.IntermediateResult.ScaledUpBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
44-
onDeformationResistedBarcodeImageUnitReceived?(result: DBR.IntermediateResult.DeformationResistedBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
45-
onComplementedBarcodeImageUnitReceived?(result: DBR.IntermediateResult.ComplementedBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
38+
onLongLinesUnitReceived?(result: LongLinesUnit, info: IntermediateResultExtraInfo): void;
39+
onCornersUnitReceived?(result: CornersUnit, info: IntermediateResultExtraInfo): void;
40+
onCandidateQuadEdgesUnitReceived?(result: CandidateQuadEdgesUnit, info: IntermediateResultExtraInfo): void;
41+
onCandidateBarcodeZonesUnitReceived?(result: LocalizedBarcodesUnit, info: IntermediateResultExtraInfo): void;
42+
onScaledUpBarcodeImageUnitReceived?(result: ScaledUpBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
43+
onDeformationResistedBarcodeImageUnitReceived?(result: DeformationResistedBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
44+
onComplementedBarcodeImageUnitReceived?(result: ComplementedBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
4645
}
4746

4847
```
@@ -79,18 +78,6 @@ interface IntermediateResultReceiver {
7978
| [onDeformationResistedBarcodeImageUnitReceived()](#ondeformationresistedbarcodeimageunitreceived) | Called when deformation resisted barcode image units have been received. |
8079
| [onComplementedBarcodeImageUnitReceived()](#oncomplementedbarcodeimageunitreceived) | Called when complemented barcode image units have been received. |
8180

82-
## getObservedParameters
83-
84-
Gets the observed parameters of the intermediate result receiver.
85-
86-
```typescript
87-
getObservationParameters(): ObservationParameters;
88-
```
89-
90-
**Return value**
91-
92-
Returns the object of CObservedParameters. The default parameters are to observe all intermediate result unit types and all tasks.
93-
9481
## onTaskResultsReceived
9582

9683
Called when a task result has been received.
@@ -124,7 +111,7 @@ onPredetectedRegionsReceived?(result: PredetectedRegionsUnit, info: Intermediate
124111
Called when localized barcodes have been received.
125112
126113
```typescript
127-
onLocalizedBarcodesReceived?(result: DBR.IntermediateResult.LocalizedBarcodesUnit, info: IntermediateResultExtraInfo): void;
114+
onLocalizedBarcodesReceived?(result: LocalizedBarcodesUnit, info: IntermediateResultExtraInfo): void;
128115
```
129116
130117
**Parameters**
@@ -138,7 +125,7 @@ onLocalizedBarcodesReceived?(result: DBR.IntermediateResult.LocalizedBarcodesUni
138125
Called when decoded barcodes have been received.
139126
140127
```typescript
141-
onDecodedBarcodesReceived?(result: DBR.IntermediateResult.DecodedBarcodesUnit, info: IntermediateResultExtraInfo): void;
128+
onDecodedBarcodesReceived?(result: DecodedBarcodesUnit, info: IntermediateResultExtraInfo): void;
142129
```
143130
144131
**Parameters**
@@ -152,7 +139,7 @@ onDecodedBarcodesReceived?(result: DBR.IntermediateResult.DecodedBarcodesUnit, i
152139
Called when localized text lines have been received.
153140
154141
```typescript
155-
onLocalizedTextLinesReceived?(result: DLR.IntermediateResult.LocalizedTextLinesUnit, info: IntermediateResultExtraInfo): void;
142+
onLocalizedTextLinesReceived?(result: LocalizedTextLinesUnit, info: IntermediateResultExtraInfo): void;
156143
```
157144
158145
**Parameters**
@@ -166,7 +153,7 @@ onLocalizedTextLinesReceived?(result: DLR.IntermediateResult.LocalizedTextLinesU
166153
Called when recognized text lines have been received.
167154
168155
```typescript
169-
onRecognizedTextLinesReceived?(result: DLR.IntermediateResult.RecognizedTextLinesUnit, info: IntermediateResultExtraInfo): void;
156+
onRecognizedTextLinesReceived?(result: RecognizedTextLinesUnit, info: IntermediateResultExtraInfo): void;
170157
```
171158
172159
**Parameters**
@@ -180,7 +167,7 @@ onRecognizedTextLinesReceived?(result: DLR.IntermediateResult.RecognizedTextLine
180167
Called when detected quadrilaterals have been received.
181168
182169
```typescript
183-
onDetectedQuadsReceived?(result: DDN.IntermediateResult.DetectedQuadsUnit, info: IntermediateResultExtraInfo): void;
170+
onDetectedQuadsReceived?(result: DetectedQuadsUnit, info: IntermediateResultExtraInfo): void;
184171
```
185172
186173
**Parameters**
@@ -194,7 +181,7 @@ onDetectedQuadsReceived?(result: DDN.IntermediateResult.DetectedQuadsUnit, info:
194181
Called when normalized images have been received.
195182
196183
```typescript
197-
onNormalizedImagesReceived?(result: DDN.IntermediateResult.NormalizedImagesUnit, info: IntermediateResultExtraInfo): void;
184+
onNormalizedImagesReceived?(result: NormalizedImagesUnit, info: IntermediateResultExtraInfo): void;
198185
```
199186
200187
**Parameters**
@@ -390,7 +377,7 @@ onTextRemovedBinaryImageUnitReceived?(result: TextRemovedBinaryImageUnit, info:
390377
Called when a long lines unit is received.
391378
392379
```typescript
393-
onLongLinesUnitReceived?(result: DDN.IntermediateResult.LongLinesUnit, info: IntermediateResultExtraInfo): void;
380+
onLongLinesUnitReceived?(result: LongLinesUnit, info: IntermediateResultExtraInfo): void;
394381
```
395382
396383
**Parameters**
@@ -404,7 +391,7 @@ onLongLinesUnitReceived?(result: DDN.IntermediateResult.LongLinesUnit, info: Int
404391
Called when a corners unit is received.
405392
406393
```typescript
407-
onCornersUnitReceived?(result: DDN.IntermediateResult.CornersUnit, info: IntermediateResultExtraInfo): void;
394+
onCornersUnitReceived?(result: CornersUnit, info: IntermediateResultExtraInfo): void;
408395
```
409396
410397
**Parameters**
@@ -418,7 +405,7 @@ onCornersUnitReceived?(result: DDN.IntermediateResult.CornersUnit, info: Interme
418405
Called when a candidate quad edges unit is received.
419406
420407
```typescript
421-
onCandidateQuadEdgesUnitReceived?(result: DDN.IntermediateResult.CandidateQuadEdgesUnit, info: IntermediateResultExtraInfo): void;
408+
onCandidateQuadEdgesUnitReceived?(result: CandidateQuadEdgesUnit, info: IntermediateResultExtraInfo): void;
422409
```
423410
424411
**Parameters**
@@ -432,7 +419,7 @@ onCandidateQuadEdgesUnitReceived?(result: DDN.IntermediateResult.CandidateQuadEd
432419
Called when a candidate barcode zones unit is received.
433420
434421
```typescript
435-
onCandidateBarcodeZonesUnitReceived?(result: DBR.IntermediateResult.LocalizedBarcodesUnit, info: IntermediateResultExtraInfo): void;
422+
onCandidateBarcodeZonesUnitReceived?(result: LocalizedBarcodesUnit, info: IntermediateResultExtraInfo): void;
436423
```
437424
438425
**Parameters**
@@ -446,7 +433,7 @@ onCandidateBarcodeZonesUnitReceived?(result: DBR.IntermediateResult.LocalizedBar
446433
Called when a scaled up barcode image unit is received.
447434
448435
```typescript
449-
onScaledUpBarcodeImageUnitReceived?(result: DBR.IntermediateResult.ScaledUpBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
436+
onScaledUpBarcodeImageUnitReceived?(result: ScaledUpBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
450437
```
451438
452439
**Parameters**
@@ -460,7 +447,7 @@ onScaledUpBarcodeImageUnitReceived?(result: DBR.IntermediateResult.ScaledUpBarco
460447
Called when a deformation resisted barcode image unit is received.
461448
462449
```typescript
463-
onDeformationResistedBarcodeImageUnitReceived?(result: DBR.IntermediateResult.DeformationResistedBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
450+
onDeformationResistedBarcodeImageUnitReceived?(result: DeformationResistedBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
464451
```
465452
466453
**Parameters**
@@ -474,7 +461,7 @@ onDeformationResistedBarcodeImageUnitReceived?(result: DBR.IntermediateResult.De
474461
Called when a complemented barcode image unit is received.
475462
476463
```typescript
477-
onComplementedBarcodeImageUnitReceived?(result: DBR.IntermediateResult.ComplementedBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
464+
onComplementedBarcodeImageUnitReceived?(result: ComplementedBarcodeImageUnit, info: IntermediateResultExtraInfo): void;
478465
```
479466
480467
**Parameters**

programming/javascript/api-reference/capture-vision-router/intermediate-result.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ permalink: /programming/javascript/api-reference/capture-vision-router/intermedi
1414

1515
| API Name | Description |
1616
| --------------------------------------------------------------- | --------------------------------------------------------- |
17-
| [getIntermediateResultManager()](#getintermediateresultmanager) | Returns an `CIntermediateResultManager` object. |
17+
| [getIntermediateResultManager()](#getintermediateresultmanager) | Returns an `IntermediateResultManager` object. |
1818

1919
## GetIntermediateResultManager
2020

@@ -23,7 +23,7 @@ Returns an object that manages the saving and retrieval of intermediate results.
2323
**Syntax**
2424

2525
```typescript
26-
getIntermediateResultManager(): Core.IntermediateResult.IntermediateResultManager;
26+
getIntermediateResultManager(): Dynamsoft.CVR.IntermediateResultManager;
2727
```
2828

2929
**Parameters**

programming/javascript/api-reference/capture-vision-router/multiple-image-processing-v2.0.10.md

Lines changed: 31 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ None.
4545
**Code snippet**
4646

4747
```javascript
48-
cvr = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
48+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
4949
let view = await Dynamsoft.DCE.CameraView.createInstance();
50-
dce = await Dynamsoft.DCE.CameraEnhancer.createInstance(view);
51-
cvr.setInput(dce);
50+
cameraEnhancer = await Dynamsoft.DCE.CameraEnhancer.createInstance(view);
51+
router.setInput(cameraEnhancer);
5252
```
5353

5454
## getInput
@@ -96,13 +96,13 @@ None.
9696
**Code snippet**
9797
9898
```javascript
99-
cvr = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
99+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
100100
let csl = {
101101
onCaptureStateChanged(state) {
102102
console.log("run CaptureStateListener", state);
103103
}
104104
}
105-
cvr.addCaptureStateListener(csl);
105+
router.addCaptureStateListener(csl);
106106
```
107107
108108
## removeCaptureStateListener
@@ -126,13 +126,13 @@ None.
126126
**Code snippet**
127127
128128
```javascript
129-
cvr = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
129+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
130130
let csl = {
131131
onCaptureStateChanged(state) {
132132
console.log("run CaptureStateListener", state);
133133
}
134134
}
135-
cvr.removeCaptureStateListener(csl);
135+
router.removeCaptureStateListener(csl);
136136
```
137137
-->
138138

@@ -157,15 +157,19 @@ None.
157157
**Code snippet**
158158

159159
```javascript
160-
cvr = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
161-
let isasl = {
160+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
161+
let listener = {
162162
onImageSourceStateListener(state) {
163163
console.log("run ImageSourceAdapterStatusListener", state);
164164
}
165165
}
166-
cvr.addImageSourceStateListener(isasl);
166+
router.addImageSourceStateListener(listener);
167167
```
168168

169+
**See Also**
170+
171+
* [ImageSourceState]({{ site.enums }}core/image-source-state.html?lang=js)
172+
169173
## removeImageSourceStateListener
170174

171175
Removes an object which listens to state changes of the image source.
@@ -187,13 +191,13 @@ None.
187191
**Code snippet**
188192

189193
```javascript
190-
cvr = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
191-
let isasl = {
194+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
195+
let listener = {
192196
onImageSourceStateListener(state) {
193197
console.log("run ImageSourceAdapterStatusListener", state);
194198
}
195199
}
196-
cvr.removeImageSourceStateListener(isasl);
200+
router.removeImageSourceStateListener(listener);
197201
```
198202

199203
## addResultReceiver
@@ -217,12 +221,12 @@ None.
217221
**Code snippet**
218222

219223
```javascript
220-
cvr = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
224+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
221225
const resultReceiver = new Dynamsoft.CVR.CapturedResultReceiver();
222226
resultReceiver.onDetectedQuadsReceived(result) {
223227
//* Do something with the result */
224228
};
225-
cvr.addResultReceiver(resultReceiver);
229+
router.addResultReceiver(resultReceiver);
226230
```
227231

228232
## removeResultReceiver
@@ -246,13 +250,13 @@ None.
246250
**Code snippet**
247251

248252
```javascript
249-
cvr = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
253+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
250254
const resultReceiver = new Dynamsoft.CVR.CapturedResultReceiver();
251255
resultReceiver.onDetectedQuadsReceived(result) {
252256
//* Do something with the result */
253257
};
254-
cvr.addResultReceiver(resultReceiver);
255-
cvr.removeResultReceiver(resultReceiver);
258+
router.addResultReceiver(resultReceiver);
259+
router.removeResultReceiver(resultReceiver);
256260
```
257261

258262
## addResultFilter
@@ -275,8 +279,8 @@ Returns a promise that resolves when the result filter have been successfully ad
275279

276280
```javascript
277281
filter = new Dynamsoft.Utility.MultiFrameResultCrossFilter();
278-
cvr = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
279-
cvr.addResultReceiver(filter);
282+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
283+
router.addResultReceiver(filter);
280284
```
281285

282286
> In the provided code snippet, the default filter implementation is utilized. This filter can offer cross-validation and de-duplication functionalities. To utilize this filter, it's necessary to include the corresponding package `dynamsoft-utility`.
@@ -305,9 +309,9 @@ None.
305309

306310
```javascript
307311
filter = new Dynamsoft.Utility.MultiFrameResultCrossFilter();
308-
cvr = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
309-
cvr.addResultReceiver(filter);
310-
cvr.removeResultFilter(filter);
312+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
313+
router.addResultReceiver(filter);
314+
router.removeResultFilter(filter);
311315
```
312316

313317
## startCapturing
@@ -331,8 +335,8 @@ Returns a promise that resolves to void.
331335
**Code snippet**
332336

333337
```javascript
334-
cvr = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
335-
await cvr.startCapturing();
338+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
339+
await router.startCapturing();
336340
```
337341

338342
## stopCapturing
@@ -356,6 +360,6 @@ None.
356360
**Code snippet**
357361

358362
```javascript
359-
cvr = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
360-
cvr.stopCapturing();
363+
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
364+
router.stopCapturing();
361365
```

0 commit comments

Comments
 (0)