You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
keywords: Dynamic Web TWAIN, TWAIN, About, Documentation
7
7
breadcrumbText: About Dynamic Web TWAIN
8
8
description: Dynamic Web TWAIN SDK Documentation. This will help you integrate document scanning into your app, no matter whether you are building a workflow from scratch or optimizing an existing workflow.
9
-
permalink: /about/
10
9
ignore: true
11
10
---
12
11
@@ -22,18 +21,18 @@ Being in the market for over 17 years, it has won the trust of many fortune 500
@@ -14,7 +13,7 @@ With the increasing use of barcode reading in document management systems, the B
14
13
15
14
> NOTE
16
15
>
17
-
> Barcode reading can be performed on the client side as well as the server side. For `Dynamic Web TWAIN` , we only consider client-side reading. If you are interested in reading on the server side, you can contact [Dynamsoft Support]({{site.about}}getsupport.html).
16
+
> Barcode reading can be performed on the client side as well as the server side. For `Dynamic Web TWAIN` , we only consider client-side reading. If you are interested in reading on the server side, you can contact [Dynamsoft Support](/_articles/about/getsupport.md).
18
17
19
18
## Environment
20
19
@@ -24,7 +23,7 @@ With the increasing use of barcode reading in document management systems, the B
24
23
25
24
### Step one - Include the add-on
26
25
27
-
To include this add-on is to reference the necessary JavaScript file which is included in the [resources files]({{site.faq}}what-are-the-resources-files.html).
26
+
To include this add-on is to reference the necessary JavaScript file which is included in the [resources files](/_articles/faq/what-are-the-resources-files.md).
28
27
29
28
> If you are using the [dwt package](https://www.npmjs.com/package/dwt), the barcode reader is already included in the main JavaScript file ( `dynamsoft.webtwain.min.js` or `dynamsoft.webtwain.min.mjs` ) which means you can skip this step.
30
29
@@ -34,7 +33,7 @@ To include this add-on is to reference the necessary JavaScript file which is in
34
33
35
34
### Step two - Start the reading
36
35
37
-
Now that the add-on has been referenced, we can call [`decode()`]({{site.info}}api/Addon_BarcodeReader.html#initruntimesettingswithstring) to start reading barcode(s).
36
+
Now that the add-on has been referenced, we can call [`decode()`](/_articles/info/api/Addon_BarcodeReader.md#initruntimesettingswithstring) to start reading barcode(s).
38
37
39
38
```javascript
40
39
functionreadBarcodes(imageIndex) {
@@ -51,7 +50,7 @@ function readBarcodes(imageIndex) {
51
50
}
52
51
```
53
52
54
-
Note that the barcode reading does take a bit of time, so it'll help to add an indicator as mentioned in [Loading Bar and Backdrop]({{site.indepth}}features/ui.html#loading-bar-and-backdrop)
53
+
Note that the barcode reading does take a bit of time, so it'll help to add an indicator as mentioned in [Loading Bar and Backdrop](/_articles/extended-usage/ui-customization.md#loading-bar-and-backdrop)
55
54
56
55
```javascript
57
56
functionreadBarcodes(imageIndex) {
@@ -76,7 +75,7 @@ function readBarcodes(imageIndex) {
76
75
77
76
### Step three - Check the result
78
77
79
-
Check the structure of the resulting object [here]({{site.info}}api/Addon_BarcodeReader.html#decode). The following code prints out the text contained in the barcode(s)
78
+
Check the structure of the resulting object [here](/_articles/info/api/Addon_BarcodeReader.md#decode). The following code prints out the text contained in the barcode(s)
Most of the time, you simply need to use the default decode method to read most of the barcode images out there. However, you may encounter some barcodes that fail to be read and sometimes you might want to limit which barcode types the reader should pick up, and more.
100
99
101
-
The runtime settings of the add-on gives you access to a wide array of customizable parameters, all of which you can check out with the method [`getRuntimeSettings()`]({{site.info}}api/Addon_BarcodeReader.html#getruntimesettings) and change with the method [`updateRuntimeSettings()`]({{site.info}}api/Addon_BarcodeReader.html#updateruntimesettings). Now to demonstrate a few typical customization scenarios:
100
+
The runtime settings of the add-on gives you access to a wide array of customizable parameters, all of which you can check out with the method [`getRuntimeSettings()`](/_articles/info/api/Addon_BarcodeReader.md#getruntimesettings) and change with the method [`updateRuntimeSettings()`](/_articles/info/api/Addon_BarcodeReader.md#updateruntimesettings). Now to demonstrate a few typical customization scenarios:
So far, we edited the values of specific runtime settings via accessing each individual setting and adjusting its value. However, the add-on also provides the developer the ability to set everything at once using a JSON string. The method is called [`initRuntimeSettingsWithString()`]({{site.info}}api/Addon_BarcodeReader.html#initruntimesettingswithstring).
162
+
So far, we edited the values of specific runtime settings via accessing each individual setting and adjusting its value. However, the add-on also provides the developer the ability to set everything at once using a JSON string. The method is called [`initRuntimeSettingsWithString()`](/_articles/info/api/Addon_BarcodeReader.md#initruntimesettingswithstring).
164
163
165
164
> Some advanced features, such as dedicated configuration of a binarization mode, are only possible when using the method `initRuntimeSettingsWithString()` .
You can always go back to the default settings with the method [`resetRuntimeSettings()`]({{site.info}}api/Addon_BarcodeReader.html#resetruntimesettings).
283
+
You can always go back to the default settings with the method [`resetRuntimeSettings()`](/_articles/info/api/Addon_BarcodeReader.md#resetruntimesettings).
keywords: Dynamic Web TWAIN, Documentation, Deployment, Dynamic Web TWAIN Service, caching, buffer,
6
6
breadcrumbText: Dynamic Web TWAIN Service
7
7
description: Dynamic Web TWAIN SDK Documentation Dynamic Web TWAIN Service Page
8
-
permalink: /extended-usage/buffer-caching.html
9
8
---
10
9
11
10
# Buffer Caching
@@ -16,9 +15,9 @@ The DWT image buffer is controlled by the Dynamic Web TWAIN Service(formerly kno
16
15
17
16
The DWT image buffer handles data using the `DIB` format, which take up a lot of space in memory. For example, one A4 paper scanned in 300 DPI takes around 24MB in memory, which means 2GB of physical memory can only store no more than 85 of these images. As more images are processed, more memory gets used which may pose a threat to other programs on the machine. Due to this, the disk cache function was added. After enabling disk caching, most images will be temporarily cached on the disk, while keeping some active images in the memory to maintain high performance.
18
17
19
-
The disk caching feature is enabled by default, but can be disabled by setting [`IfAllowLocalCache`]({{site.info}}api/WebTwain_Buffer.html#ifallowlocalcache) to `false` .
18
+
The disk caching feature is enabled by default, but can be disabled by setting [`IfAllowLocalCache`](/_articles/info/api/WebTwain_Buffer.md#ifallowlocalcache) to `false` .
20
19
21
-
You can also set how much memory `Dynamic Web TWAIN` can use before images start to be cached. By default, **800MB** is used. You can change it using the property [`BufferMemoryLimit`]({{site.api}}WebTwain_Buffer.html#buffermemorylimit).
20
+
You can also set how much memory `Dynamic Web TWAIN` can use before images start to be cached. By default, **800MB** is used. You can change it using the property [`BufferMemoryLimit`](/_articles/info/api/WebTwain_Buffer.md#buffermemorylimit).
22
21
23
22
> Note: All cached data is encrypted and can only be accessed by `Dynamic Web TWAIN`. When `Dynamic Web TWAIN` is unloaded (like when the browser tab refreshes or closes), the cached data is destroyed and removed from the disk automatically.
24
23
@@ -38,7 +37,7 @@ Starting from version 18.5, Dynamic Web TWAIN introduces a new feature that faci
38
37
39
38
### Create a storage folder
40
39
41
-
First of all, you need to create a storage item by [`createLocalStorage()`]({{site.info}}api/WebTwain_IO.html#createlocalstorage) which is used to save the encrypted image caches. For example,
40
+
First of all, you need to create a storage item by [`createLocalStorage()`](/_articles/info/api/WebTwain_IO.md#createlocalstorage) which is used to save the encrypted image caches. For example,
42
41
43
42
```javascript
44
43
var folderSettings = {
@@ -56,7 +55,7 @@ The local directory of the created storage folder is under
56
55
57
56
**Save image caches**
58
57
59
-
To save the specified image(s) to the storage folder, [`saveToLocalStorage()`]({{site.info}}api/WebTwain_IO.html#savetolocalstorage) method is required.
58
+
To save the specified image(s) to the storage folder, [`saveToLocalStorage()`](/_articles/info/api/WebTwain_IO.md#savetolocalstorage) method is required.
60
59
61
60
```javascript
62
61
var bExist =awaitDWTObject.localStorageExist(storageItemUid); // Determine whether the folder exists
@@ -76,7 +75,7 @@ else {
76
75
77
76
**Load image(s) from the storage folder**
78
77
79
-
To load the encypted image caches into Dynamic Web TWAIN again, please use the method [`loadFromLocalStorage()`]({{site.info}}api/WebTwain_IO.html#loadfromlocalstorage).
78
+
To load the encypted image caches into Dynamic Web TWAIN again, please use the method [`loadFromLocalStorage()`](/_articles/info/api/WebTwain_IO.md#loadfromlocalstorage).
80
79
81
80
```javascript
82
81
var bExist =awaitDWTObject.localStorageExist(storageItemUid); // Determine whether the folder exists
@@ -95,7 +94,7 @@ else {
95
94
96
95
**Remove the storage folder**
97
96
98
-
If you would like to remove the storage folder by programming, the method [`removeLocalStorage()`]({{site.info}}api/WebTwain_IO.html#removelocalstorage) can help.
97
+
If you would like to remove the storage folder by programming, the method [`removeLocalStorage()`](/_articles/info/api/WebTwain_IO.md#removelocalstorage) can help.
99
98
100
99
```javascript
101
100
var bExist =awaitDWTObject.localStorageExist(storageItemUid); // Determine whether the folder exists
After configuring the origins in the `DSConfiguration.ini` file, please set [`IfCheckCORS`]({{site.info}}api/Dynamsoft_WebTwainEnv.html#ifcheckcors) to `true` in `dynamsoft.webtwain.config.js`.
53
+
After configuring the origins in the `DSConfiguration.ini` file, please set [`IfCheckCORS`](/_articles/info/api/Dynamsoft_WebTwainEnv.md#ifcheckcors) to `true` in `dynamsoft.webtwain.config.js`.
55
54
56
55
When a request comes from a different origin, a CORS error message will be displayed, both in a pop-up and in the console.
57
56
@@ -63,7 +62,7 @@ When a request comes from a different origin, a CORS error message will be displ
63
62
64
63
On a desktop, when a new user accesses a web page using Dynamic Web TWAIN SDK for the first time, he will be prompted to install the Dynamic Web TWAIN Service. This is a built-in behaviour of the library. The prompt will display the download link. Once the installer is downloaded, the installation process will take just a few seconds.
65
64
66
-
The prompt comes up when you try to [create a WebTwain instance]({{site.extended-usage}}advanced-initialization.html#instantiating-webtwain-without-onwebtwainready) in Service mode.
65
+
The prompt comes up when you try to [create a WebTwain instance](/_articles/extended-usage/advanced-initialization.md#instantiating-webtwain-without-onwebtwainready) in Service mode.
@@ -93,7 +92,7 @@ If Dynamic Web TWAIN Service is not installed, users may receive the error 'The
93
92
94
93
## Related Resources:
95
94
96
-
*<ahref="{{site.faq}}what-does-dynamsoft-service-do-on-end-user-machine.html"target="_blank">What does Dynamic Web TWAIN Service do?</a>
97
-
*<ahref="{{site.faq}}service-prompting-to-install-repeatedly.html"target="_blank">I have installed the Dynamic Web TWAIN Service on an end-user machine but still got asked to install it repeatedly. Why?</a>
98
-
*<ahref="{{site.faq}}how-to-uninstall-dynamsoft-service.html"target="_blank">How to uninstall Dynamic Web TWAIN Service?</a>
99
-
*<ahref="{{site.faq}}can-i-install-dynamsoft-service-silently.html"target="_blank">Can I install Dynamic Web TWAIN Service silently?</a>
95
+
*[What does Dynamic Web TWAIN Service do?](/_articles/faq/what-does-dynamsoft-service-do-on-end-user-machine.md){:target="_blank"}
96
+
*[I have installed the Dynamic Web TWAIN Service on an end-user machine but still got asked to install it repeatedly. Why?](/_articles/faq/service-prompting-to-install-repeatedly.md){:target="_blank"}
97
+
*[How to uninstall Dynamic Web TWAIN Service?](/_articles/faq/how-to-uninstall-dynamsoft-service.md){:target="_blank"}
98
+
*[Can I install Dynamic Web TWAIN Service silently?](/_articles/faq/can-i-install-dynamsoft-service-silently.md){:target="_blank"}
0 commit comments