Skip to content

Commit 1ec5216

Browse files
a362758199a362758199
committed
move switchCapturingTemplate() to Multiple-Image Processing section
1 parent d7d260d commit 1ec5216

File tree

3 files changed

+54
-54
lines changed

3 files changed

+54
-54
lines changed

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

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,17 @@ The `CaptureVisionRouter` class defines how a user interacts with image-processi
3535

3636
### Multiple-Image Processing
3737

38-
| Name | Description |
39-
| ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
40-
| [setInput()](./multiple-image-processing.md#setinput) | Sets up an image source to provide images for continuous processing. |
41-
| [getInput()](./multiple-image-processing.md#getinput) | Returns the image source object. |
42-
| [addResultReceiver()](./multiple-image-processing.md#addresultreceiver) | Adds a `CapturedResultReceiver` object as the receiver of captured results. |
43-
| [removeResultReceiver()](./multiple-image-processing.md#removeresultreceiver) | Removes the specified `CapturedResultReceiver` object. |
44-
| [addResultFilter()](./multiple-image-processing.md#addresultfilter) | Adds a `MultiFrameResultCrossFilter` object to filter non-essential results. |
45-
| [removeResultFilter()](./multiple-image-processing.md#removeresultfilter) | Removes the specified `MultiFrameResultCrossFilter` object. |
46-
| [startCapturing()](./multiple-image-processing.md#startcapturing) | Initiates a capturing process based on a specified template. |
47-
| [stopCapturing()](./multiple-image-processing.md#stopcapturing) | Stops the capturing process. |
38+
| Name | Description |
39+
| ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
40+
| [setInput()](./multiple-image-processing.md#setinput) | Sets up an image source to provide images for continuous processing. |
41+
| [getInput()](./multiple-image-processing.md#getinput) | Returns the image source object. |
42+
| [addResultReceiver()](./multiple-image-processing.md#addresultreceiver) | Adds a `CapturedResultReceiver` object as the receiver of captured results. |
43+
| [removeResultReceiver()](./multiple-image-processing.md#removeresultreceiver) | Removes the specified `CapturedResultReceiver` object. |
44+
| [addResultFilter()](./multiple-image-processing.md#addresultfilter) | Adds a `MultiFrameResultCrossFilter` object to filter non-essential results. |
45+
| [removeResultFilter()](./multiple-image-processing.md#removeresultfilter) | Removes the specified `MultiFrameResultCrossFilter` object. |
46+
| [startCapturing()](./multiple-image-processing.md#startcapturing) | Initiates a capturing process based on a specified template. |
47+
| [stopCapturing()](./multiple-image-processing.md#stopcapturing) | Stops the capturing process. |
48+
| [switchCapturingTemplate()](./multiple-image-processing.md#switchcapturingtemplate) | Switches the currently active capturing template during the image processing workflow. |
4849

4950
<!-- | [addImageSourceStateListener()](./multiple-image-processing.md#addimagesourcestatelistener) | Adds an `ImageSourceStateListener` object that monitors changes in the state of an image source. |
5051
| [removeImageSourceStateListener()](./multiple-image-processing.md#removeimagesourcestatelistener) | Removes the specified `ImageSourceStateListener` object. | -->

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

Lines changed: 43 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,17 @@ breadcrumbText: CVR JavaScript CaptureVisionRouter
1111

1212
# CaptureVisionRouter Multiple Image Processing
1313

14-
| Name | Description |
15-
| ----------------------------------------------- | ---------------------------------------------------------------------------- |
16-
| [setInput()](#setinput) | Sets up an image source to provide images for continuous processing. |
17-
| [getInput()](#getinput) | Returns the image source object. |
18-
| [addResultReceiver()](#addresultreceiver) | Adds a `CapturedResultReceiver` object as the receiver of captured results. |
19-
| [removeResultReceiver()](#removeresultreceiver) | Removes the specified `CapturedResultReceiver` object. |
20-
| [addResultFilter()](#addresultfilter) | Adds a `MultiFrameResultCrossFilter` object to filter non-essential results. |
21-
| [removeResultFilter()](#removeresultfilter) | Removes the specified `MultiFrameResultCrossFilter` object. |
22-
| [startCapturing()](#startcapturing) | Initiates a capturing process based on a specified template. |
23-
| [stopCapturing()](#stopcapturing) | Stops the capturing process. |
14+
| Name | Description |
15+
| ----------------------------------------------------- | -------------------------------------------------------------------------------------- |
16+
| [setInput()](#setinput) | Sets up an image source to provide images for continuous processing. |
17+
| [getInput()](#getinput) | Returns the image source object. |
18+
| [addResultReceiver()](#addresultreceiver) | Adds a `CapturedResultReceiver` object as the receiver of captured results. |
19+
| [removeResultReceiver()](#removeresultreceiver) | Removes the specified `CapturedResultReceiver` object. |
20+
| [addResultFilter()](#addresultfilter) | Adds a `MultiFrameResultCrossFilter` object to filter non-essential results. |
21+
| [removeResultFilter()](#removeresultfilter) | Removes the specified `MultiFrameResultCrossFilter` object. |
22+
| [startCapturing()](#startcapturing) | Initiates a capturing process based on a specified template. |
23+
| [stopCapturing()](#stopcapturing) | Stops the capturing process. |
24+
| [switchCapturingTemplate()](#switchcapturingtemplate) | Switches the currently active capturing template during the image processing workflow. |
2425

2526
<!--
2627
| [addImageSourceStateListener()](#addimagesourcestatelistener) | Adds an `ImageSourceStateListener` object that monitors changes in the state of an image source. |
@@ -380,4 +381,35 @@ router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
380381
await router.startCapturing("ReadSingleBarcode");
381382
// ...
382383
router.stopCapturing();
383-
```
384+
```
385+
386+
## switchCapturingTemplate
387+
388+
Switches the currently active capturing template during the image processing workflow. This allows dynamic reconfiguration of the capture process without restarting or reinitializing the system, enabling different settings or rules to be applied on the fly.
389+
390+
**Syntax**
391+
392+
```typescript
393+
switchCapturingTemplate(templateName: string): Promise<void>;
394+
```
395+
396+
**Parameters**
397+
398+
`templateName`: The name of the new capturing template to apply.
399+
400+
**Return Value**
401+
402+
A promise that resolves when the operation has completed.
403+
404+
**Code snippet**
405+
406+
```javascript
407+
let router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
408+
await router.startCapturing("ReadSingleBarcode");
409+
// Switching to ReadRateFirst template
410+
await router.switchCapturingTemplate("ReadBarcodes_ReadRateFirst");
411+
```
412+
413+
**Remarks**
414+
415+
Introduced in Dynamsoft Barcode Reader Bundle version 11.2.2000 and Dynamsoft Capture Vision Bundle version 3.2.2000.

‎programming/javascript/api-reference/capture-vision-router/settings.md‎

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ breadcrumbText: CVR JavaScript CaptureVisionRouter
2020
| [getTemplateNames()](#gettemplatenames) | Retrieves the names of all the currently available templates. |
2121
| [updateSettings()](#updatesettings) | Updates the specified `CaptureVisionTemplate` with an updated `SimplifiedCaptureVisionSettings` object. |
2222
| [resetSettings()](#resetsettings) | Restores all runtime settings to their original default values. |
23-
| [switchCapturingTemplate()](#switchcapturingtemplate) | Switches the currently active capturing template during the image processing workflow. |
24-
2523

2624
## initSettings
2725

@@ -236,34 +234,3 @@ A promise that resolves when the operation has completed. It provides an object
236234
let router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
237235
await router.resetSettings();
238236
```
239-
240-
## switchCapturingTemplate
241-
242-
Switches the currently active capturing template during the image processing workflow. This allows dynamic reconfiguration of the capture process without restarting or reinitializing the system, enabling different settings or rules to be applied on the fly.
243-
244-
**Syntax**
245-
246-
```typescript
247-
switchCapturingTemplate(templateName: string): Promise<void>;
248-
```
249-
250-
**Parameters**
251-
252-
`templateName`: The name of the new capturing template to apply.
253-
254-
**Return Value**
255-
256-
A promise that resolves when the operation has completed.
257-
258-
**Code snippet**
259-
260-
```javascript
261-
let router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
262-
await router.startCapturing("ReadSingleBarcode");
263-
// Switching to ReadRateFirst template
264-
await router.switchCapturingTemplate("ReadBarcodes_ReadRateFirst");
265-
```
266-
267-
**Remarks**
268-
269-
Introduced in Dynamsoft Barcode Reader Bundle version 11.2.2000 and Dynamsoft Capture Vision Bundle version 3.2.2000.

0 commit comments

Comments
 (0)