Skip to content

Commit 9b40de0

Browse files
Tom-DynamsoftTom-Dynamsoft
committed
updated a few api names, lihks
1 parent b13c0ff commit 9b40de0

File tree

4 files changed

+57
-38
lines changed

4 files changed

+57
-38
lines changed

‎programming/javascript/api-reference/core/intermediate-result/intermediate-result-manager.md‎

Whitespace-only changes.

‎programming/javascript/api-reference/cvr/auxiliary.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ description: This page introduces APIs related to the auxiliary APIs of CaptureV
55
keywords: capture vision, auxiliary, instance, api reference, javascript, js
66
needAutoGenerateSidebar: true
77
needGenerateH3Content: false
8-
permalink: /programming/javascript/api-reference/cvr/instantiate.html
8+
permalink: /programming/javascript/api-reference/cvr/auxiliary.html
99
---
1010

11-
# Javascript API Reference - `CaptureVisionRouter` Instantiation
11+
# Javascript API Reference - Auxiliary Methods
1212

13-
| API Name | Description |
14-
| ------------------------------------------------------------- | ----------------------------------------------------------------- |
15-
| [getIntermediateResultManager](auxiliary.md#) | Whether to save the original image into a <canvas> element. |
16-
| [getVersion](auxiliary.md#getVersion) |
13+
| API Name | Description |
14+
| ------------------------------------------------------------- | -------------------------------------------------------- |
15+
| [getIntermediateResultManager](#getintermediateresultmanager) | Returns an `IntermediateResultManager` object. |
16+
| [getVersion](#getversion) | Returns the version of the `CaptureVisionRouter` object. |
1717

1818
## getIntermediateResultManager
1919

‎programming/javascript/api-reference/cvr/index.md‎

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -42,40 +42,41 @@ The APIs for this class include:
4242

4343
### Process a Single Image or File
4444

45-
| API Name | Description |
46-
| --------------------- | --------------------------------------------------------- |
47-
| [capture()](#capture) | Process an image or file to derive important information. |
45+
| API Name | Description |
46+
| -------------------------------------- | --------------------------------------------------------- |
47+
| [capture()](single-process.md#capture) | Process an image or file to derive important information. |
4848

4949
### Process multiple images from an Image Source
5050

51-
| API Name | Description |
52-
| ----------------------------------------------------- | --------------------------------------------------------------------- |
53-
| [setInput](#setimagesource) | Sets an image source for continous scanning. |
54-
| [addImageSourceStateListener](#onuniqueread) | . |
55-
| [removeImageSourceStateListener](#onimageread) | This event is triggered after the library finishes scanning an image. |
56-
| [addResultReceiver()](#startscanning) | Starts continuous scanning of incoming images. |
57-
| [removeResultReceiver()](#stopscanning) | Stops continuous scanning. |
58-
| [addCaptureStateListener()](#pausescanning) | Pause continuous scanning but keep the video stream. |
59-
| [removeCaptureStateListener()](#resumescanning) | Resumes continuous scanning. |
60-
| [startCapturing()](#getscansettings) | Returns the current scan settings. |
61-
| [stopCapturing()](#updatescansettings) | Changes scan settings with the object passed in. |
51+
| API Name | Description |
52+
| --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
53+
| [setInput](consecutive-process.md#setinput) | Sets an image source to provide images for consecutive process. |
54+
| [addCaptureStateListener()](consecutive-process.md#addcapturestatelistener) | Adds an object that listens to the state changes of the capture process. |
55+
| [removeCaptureStateListener()](consecutive-process.md#removecapturestatelistener) | Removes an object which listens to the state changes of the capture process. |
56+
| [addImageSourceStateListener](consecutive-process.md#addimagesourcestatelistener) | Adds an object that listens to state changes of the image source. |
57+
| [removeImageSourceStateListener](consecutive-process.md#removeimagesourcestatelistener) | Removes an object which listens to state changes of the image source. |
58+
| [addResultReceiver()](consecutive-process.md#addresultreceiver) | Adds an object as the receiver of captured results. |
59+
| [removeResultReceiver()](consecutive-process.md#removeresultreceiver) | Removes an object which was added as a receiver of captured results. |
60+
| [startCapturing()](consecutive-process.md#startcapturing) | Starts to process images consecutively. |
61+
| [stopCapturing()](consecutive-process.md#stopcapturing) | Stops the consecutive process. |
62+
6263

6364
### Change Settings
6465

65-
| API Name | Description |
66-
| ------------------------------------------------- | ---------------------------------------------------------------------------- |
67-
| [initSettings()](#getruntimesettings) | Returns the current runtime settings. |
68-
| [outputSettings](#initruntimesettingswithstring) | Initializes the Runtime Settings with the settings in the given JSON string. |
69-
| [getSimplifiedSettings()](#updateruntimesettings) | Updates runtime settings with a given struct or a preset template. |
70-
| [updateSettings()](#resetruntimesettings) | Resets all parameters to default values. |
71-
| [resetSettings()](#outputruntimesettingstostring) | Return the current RuntimeSettings in the form of a string. |
66+
| API Name | Description |
67+
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
68+
| [initSettings()](settings.md#initsettings) | Initializes settings with either a file or a string. |
69+
| [outputSettings](settings.md#outputsettings) | Outputs a `CaptureVisionTemplate` specified by its name. |
70+
| [getSimplifiedSettings()](settings.md#getsimplifiedsettings) | Returns a `SimplifiedCaptureVisionSettings` object for manipulating a specified `CaptureVisionTemplate`. |
71+
| [updateSettings()](settings.md#updatesettings) | Updates a specified `CaptureVisionTemplate` with updated an updated `SimplifiedCaptureVisionSettings` object. |
72+
| [resetSettings()](settings.md#resetsettings) | Resets settings to factory default. |
7273

7374
### Auxiliary
7475

75-
| API Name | Description |
76-
| ------------------------------------------------------------- | ----------------------------------------------------------------- |
76+
| API Name | Description |
77+
| --------------------------------------------- | ----------------------------------------------------------------- |
7778
| [getIntermediateResultManager](auxiliary.md#) | Whether to save the original image into a <canvas> element. |
78-
| [getVersion](auxiliary.md#getVersion) | |
79+
| [getVersion](auxiliary.md#getVersion) | |
7980

8081
## Interfaces and Enums
8182

‎programming/javascript/api-reference/cvr/settings.md‎

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ permalink: /programming/javascript/api-reference/cvr/settings.html
1010

1111
# Javascript API Reference - `CaptureVisionRouter` Instantiation
1212

13-
| API Name | Description |
14-
| ------------------------------------------------- | ---------------------------------------------------------------------------- |
15-
| [initSettings()](#getruntimesettings) | Returns the current runtime settings. |
16-
| [outputSettings](#initruntimesettingswithstring) | Initializes the Runtime Settings with the settings in the given JSON string. |
17-
| [getSimplifiedSettings()](#updateruntimesettings) | Updates runtime settings with a given struct or a preset template. |
18-
| [updateSettings()](#resetruntimesettings) | Resets all parameters to default values. |
19-
| [resetSettings()](#outputruntimesettingstostring) | Return the current RuntimeSettings in the form of a string. |
13+
| API Name | Description |
14+
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
15+
| [initSettings()](#initsettings) | Initializes settings with either a file or a string. |
16+
| [outputSettings](#outputsettings) | Outputs a `CaptureVisionTemplate` specified by its name. |
17+
| [getSimplifiedSettings()](#getsimplifiedsettings) | Returns a `SimplifiedCaptureVisionSettings` object for manipulating a specified `CaptureVisionTemplate`. |
18+
| [updateSettings()](#updatesettings) | Updates a specified `CaptureVisionTemplate` with updated an updated `SimplifiedCaptureVisionSettings` object. |
19+
| [resetSettings()](#resetsettings) | Resets settings to factory default. |
2020

2121

2222
## createInstance
@@ -35,4 +35,22 @@ A promise that resolves to the initalized `CaptureVisionRouter` object.
3535

3636
```js
3737
let router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
38-
```
38+
```
39+
40+
## initSettings
41+
42+
Returns the current runtime settings.
43+
44+
## outputSettings
45+
46+
Initializes the Runtime Settings with the settings in the given JSON string.
47+
48+
## getSimplifiedSettings
49+
50+
Updates runtime settings with a given struct or a preset template.
51+
## updateSettings
52+
53+
Resets all parameters to default values.
54+
## resetSettings
55+
56+
Return the current RuntimeSettings in the form of a string.

0 commit comments

Comments
 (0)