barkoder-wasm-ocr 1.3.7 → 1.3.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +93 -73
- package/barkoder-umd.d.ts +285 -0
- package/barkoder-umd.js +88 -33
- package/barkoder.wasm +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ The [barKoder Barcode Scanner SDK](https://barkoder.com/barcode-scanner-sdk) wil
|
|
|
5
5
|
|
|
6
6
|
Even though the barKoder barcode scanner SDK is a relatively new product, it is already more advanced than other competitor API's. Its robust barcode reading engine can be used to read the content of the most widely used barcodes with lightning fast speed and unprecedented recognition rate:
|
|
7
7
|
|
|
8
|
-
1D - [Codabar](https://barkoder.com/barcode-types/codabar), [Code 11](https://barkoder.com/barcode-types/code-11), [Code 25](https://barkoder.com/barcode-types/code-25), [Code 39](https://barkoder.com/barcode-types/code-39), [Code 93](https://barkoder.com/barcode-types/code-93), [Code 128](https://barkoder.com/barcode-types/code-128), [
|
|
8
|
+
1D - [Codabar](https://barkoder.com/barcode-types/codabar), [Code 11](https://barkoder.com/barcode-types/code-11), [Code 25](https://barkoder.com/barcode-types/code-25), [Code 39](https://barkoder.com/barcode-types/code-39), [Code 93](https://barkoder.com/barcode-types/code-93), [Code 128](https://barkoder.com/barcode-types/code-128), [EAN-8](https://barkoder.com/barcode-types/ean-upc-code), [EAN-13](https://barkoder.com/barcode-types/ean-upc-code), [Interleaved 2 of 5](https://barkoder.com/barcode-types/code-25), [ITF-14](https://barkoder.com/barcode-types/code-25), [MSI Plessey](https://barkoder.com/barcode-types/msi-plessey), [Pharmacode](https://barkoder.com/barcode-types/code-32), [Telepen](https://barkoder.com/barcode-types/telepen), [UPC-A](https://barkoder.com/barcode-types/ean-upc-code) & [UPC-E](https://barkoder.com/barcode-types/ean-upc-code)
|
|
9
9
|
2D - [Aztec Code](https://barkoder.com/barcode-types/aztec), [Aztec Compact](https://barkoder.com/barcode-types/aztec), [Data Matrix](https://barkoder.com/barcode-types/data-matrix), [DotCode](https://barkoder.com/barcode-types/dotcode), [PDF417](https://barkoder.com/barcode-types/pdf417), [Micro PDF417](https://barkoder.com/barcode-types/pdf417), [QR Code](https://barkoder.com/barcode-types/qr-code) & [Micro QR Code](https://barkoder.com/barcode-types/qr-code)
|
|
10
10
|
|
|
11
11
|
The [barKoder SDK](https://barkoder.com/) features multiple algorithms that handle a wide variety of barcode scanning scenarios with unprecedented performance in terms of speed and success rate:
|
|
@@ -120,80 +120,100 @@ Note that the container element needs to have a defined size, otherwise the SDK
|
|
|
120
120
|
|
|
121
121
|
## API
|
|
122
122
|
|
|
123
|
-
* [`initialize(key: string): Promise<object>`](https://
|
|
123
|
+
* [`initialize(key: string): Promise<object>`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference)
|
|
124
124
|
|
|
125
125
|
The initialize method must be called first. After it completes, it returns an object with the following members:
|
|
126
126
|
|
|
127
|
-
* [`constants: object`](https://
|
|
128
|
-
* [`startScanner(resultCallback?: function): number`](https://
|
|
129
|
-
* [`stopScanner()`](https://
|
|
130
|
-
* [`scanImage(imageUri: string, resultCallback?: function)`](https://
|
|
131
|
-
* [`scanFromLocalFileSystem(input: string, resultCallback: function): void`](https://
|
|
132
|
-
* [`setPauseDecoding(pause: boolean)`](https://
|
|
133
|
-
* [`setRegionOfInterest(left: number, top: number, width: number, height: number)`](https://
|
|
134
|
-
* [`setCameraResolution(cameraResolution: number)`](https://
|
|
135
|
-
* [`getCameras(): Promise<object>`](https://
|
|
136
|
-
* [`setCameraId(cameraId: string)`](https://
|
|
137
|
-
* [`setFlashEnabled(flashEnabled: boolean): number`](https://
|
|
138
|
-
* [`setZoomEnabled(zoomEnabled: boolean): number`](https://
|
|
139
|
-
* [`setCloseEnabled(closeEnabled: boolean): number`](https://
|
|
140
|
-
* [`setCameraPickerEnabled(cameraPickerEnabled: boolean): number`](https://
|
|
141
|
-
* [`changeFlashState()`](https://
|
|
142
|
-
* [`changeZoomState()`](https://
|
|
143
|
-
* [`setContinuous(continuous: boolean): number`](https://
|
|
144
|
-
* [`
|
|
145
|
-
* [`
|
|
146
|
-
* [`
|
|
147
|
-
* [`
|
|
148
|
-
* [`
|
|
149
|
-
* [`
|
|
150
|
-
* [`
|
|
151
|
-
* [`
|
|
152
|
-
* [`
|
|
153
|
-
* [`
|
|
154
|
-
* [`
|
|
155
|
-
* [`
|
|
156
|
-
* [`
|
|
157
|
-
* [`
|
|
158
|
-
* [`
|
|
159
|
-
* [`
|
|
160
|
-
* [`
|
|
161
|
-
* [`
|
|
162
|
-
* [`
|
|
163
|
-
* [`
|
|
164
|
-
* [`
|
|
165
|
-
* [`
|
|
166
|
-
* [`
|
|
167
|
-
* [`
|
|
168
|
-
* [`
|
|
169
|
-
* [`
|
|
170
|
-
* [`
|
|
171
|
-
* [`
|
|
172
|
-
* [`
|
|
173
|
-
* [`
|
|
174
|
-
* [`
|
|
175
|
-
* [`
|
|
176
|
-
* [`
|
|
177
|
-
* [`
|
|
178
|
-
* [`
|
|
179
|
-
* [`
|
|
180
|
-
* [`
|
|
181
|
-
* [`
|
|
182
|
-
* [`
|
|
183
|
-
* [`
|
|
184
|
-
* [`
|
|
185
|
-
* [`
|
|
186
|
-
* [`
|
|
187
|
-
* [`
|
|
188
|
-
* [`
|
|
189
|
-
* [`
|
|
190
|
-
|
|
191
|
-
* [`
|
|
192
|
-
* [`
|
|
193
|
-
* [`
|
|
194
|
-
* [`
|
|
195
|
-
* [`
|
|
196
|
-
* [`
|
|
197
|
-
* [`
|
|
127
|
+
* [`constants: object`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#barkoder-constants)
|
|
128
|
+
* [`startScanner(resultCallback?: function): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#startscanner-resultcallback-function-number)
|
|
129
|
+
* [`stopScanner()`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#stopscanner)
|
|
130
|
+
* [`scanImage(imageUri: string, resultCallback?: function)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#scanimage-imageuri-string-resultcallback-function)
|
|
131
|
+
* [`scanFromLocalFileSystem(input: string, resultCallback: function): void`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#scanfromlocalfilesystem)
|
|
132
|
+
* [`setPauseDecoding(pause: boolean)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setpausedecoding-pause-boolean)
|
|
133
|
+
* [`setRegionOfInterest(left: number, top: number, width: number, height: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setregionofinterest-left-number-top-number-width-number-height-number)
|
|
134
|
+
* [`setCameraResolution(cameraResolution: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setcameraresolution-cameraresolution-number)
|
|
135
|
+
* [`getCameras(): Promise<object>`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getcameras)
|
|
136
|
+
* [`setCameraId(cameraId: string)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setcameraid-cameraid-string)
|
|
137
|
+
* [`setFlashEnabled(flashEnabled: boolean): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setflashenabled-flashenabled-boolean-number)
|
|
138
|
+
* [`setZoomEnabled(zoomEnabled: boolean): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setzoomenabled-zoomenabled-boolean-number)
|
|
139
|
+
* [`setCloseEnabled(closeEnabled: boolean): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setcloseenabled-closeenabled-boolean-number)
|
|
140
|
+
* [`setCameraPickerEnabled(cameraPickerEnabled: boolean): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setcamerapickerenabled-camerapickerenabled-boolean-number)
|
|
141
|
+
* [`changeFlashState()`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#changeflashstate)
|
|
142
|
+
* [`changeZoomState()`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#changezoomstate)
|
|
143
|
+
* [`setContinuous(continuous: boolean): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setcontinuous-continuous-boolean-number)
|
|
144
|
+
* [`setScannerTimeout(timeout: number): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setscannertimeout-timeout-number)
|
|
145
|
+
* [`setDpsLimit(setDpsLimit: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setdpslimit)
|
|
146
|
+
* [`applyTemplate(templateFile: string, templateMode: string)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#applytemplate-templatefile-string-templatemode-string)
|
|
147
|
+
* [`setLengthRange(decoder: number, minimumLength: number, maximumLength: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setlengthrange-decoder-number-minimumlength-number-maximumlength-number)
|
|
148
|
+
* [`setCode11ChecksumType(code11ChecksumType: number): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setcode11checksumtype-code11checksumtype-number-number)
|
|
149
|
+
* [`setCode39ChecksumType(code39ChecksumType: number): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setcode39checksumtype-code39checksumtype-number-number)
|
|
150
|
+
* [`setMsiChecksumType(msiChecksumType: number): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setmsichecksumtype-msichecksumtype-number-number)
|
|
151
|
+
* [`setDatamatrixDpmModeEnabled(dpmModeEnabled: boolean): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setdatamatrixdpmmodeenabled-dpmmodeenabled-boolean-number)
|
|
152
|
+
* [`setEncodingCharacterSet(encodingCharacterSet: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setencodingcharacterset-encodingcharacterset-number)
|
|
153
|
+
* [`setDecodingSpeed(decodingSpeed: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setdecodingspeed)
|
|
154
|
+
* [`setEnabledDecoders(...args: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setenableddecoders-args-number)
|
|
155
|
+
* [`setFormatting(formatting: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setformatting)
|
|
156
|
+
* [`setMulticodeCachingEnabled(multicodeCachingEnabled: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setmulticodecachingenabled-multicodecachingenabled-number)
|
|
157
|
+
* [`setMulticodeCachingDuration(multicodeCachingDuration: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setmulticodecachingduration-multicodecachingduration-number)
|
|
158
|
+
* [`setMaximumResultsCount(maximumResultsCount: number): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setmaximumresultscount)
|
|
159
|
+
* [`setDuplicatesDelayMs(duplicatesDelayMs: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setduplicatesdelayms-duplicatesdelayms-number)
|
|
160
|
+
* [`setUpcEanDeblur(deblur: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setupceandeblur-deblur-number)
|
|
161
|
+
* [`setEnableMisshaped1D(enableMisshaped1D: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setenablemisshaped1d-enablemisshaped1d-number)
|
|
162
|
+
* [`setEnableVINRestrictions(enableVINRestrictions: number)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setenablevinrestrictions-enablevinrestrictions-number)
|
|
163
|
+
* [`getVersion(): { barkoderWebVersion: string, barkoderVersion: string, barkoderFullVersion: string }`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getversion-barkoderwebversion-string-barkoderversion-string-barkoderfullversion-string)
|
|
164
|
+
* [`getRegionOfInterest(): { x:number, y:number, width: number, height: number }`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getregionofinterest-x-number-y-number-width-number-height-number)
|
|
165
|
+
* [`getDecodingSpeed(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getdecodingspeed)
|
|
166
|
+
* [`getFormatting(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getformatting)
|
|
167
|
+
* [`getMaximumResultsCount(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getmaximumresultscount)
|
|
168
|
+
* [`getDuplicatesDelayMs(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getduplicatesdelayms)
|
|
169
|
+
* [`getUpcEanDeblur(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getupceandeblur-number)
|
|
170
|
+
* [`getEnableMisshaped1D(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getenablemisshaped1d-number)
|
|
171
|
+
* [`getEnableVINRestrictions(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getenablevinrestrictions-number)
|
|
172
|
+
* [`getLocationLineColor(): string`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getlocationlinecolor-string)
|
|
173
|
+
* [`getLocationLineWidth(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getlocationlinewidth-number)
|
|
174
|
+
* [`getRoiLineColor(): string`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getroilinecolor-string)
|
|
175
|
+
* [`getRoiLineWidth(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getroilinewidth-number)
|
|
176
|
+
* [`isRegionOfInterestVisible(): boolean`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#isregionofinterestvisible-boolean)
|
|
177
|
+
* [`isImageResultEnabled(): boolean`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#isimageresultenabled-boolean)
|
|
178
|
+
* [`isLocationInPreviewEnabled(): boolean`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#islocationinpreviewenabled-boolean)
|
|
179
|
+
* [`setRoiLineColor(lineColor: string): void`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setroilinecolor)
|
|
180
|
+
* [`setRoiLineWidth(lineWidth: number): void`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setroilinewidth)
|
|
181
|
+
* [`setImageResultEnabled(enabled: boolean): void`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setimageresultenabled)
|
|
182
|
+
* [`setLocationInPreviewEnabled(enabled: boolean): void`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setlocationinpreviewenabled)
|
|
183
|
+
* [`setRegionOfInterestVisible(visible: boolean): void`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setregionofinterestvisible)
|
|
184
|
+
* [`configureBarkoder(barkoderConfig: BarkoderConfig)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#configurebarkoder)
|
|
185
|
+
* [`isBarcodeTypeEnabled(barcodeType: number): boolean`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#isbarcodetypeenabled)
|
|
186
|
+
* [`setBarcodeTypeEnabled(barcodeType: number, enabled: boolean): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setbarcodetypeenabled)
|
|
187
|
+
* [`getBarcodeTypeLengthRange(barcodeType: number): [mix: number, max: number]`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getbarcodetypelengthrange)
|
|
188
|
+
* [`getMulticodeCachingEnabled(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getmulticodecachingenabled)
|
|
189
|
+
* [`getMulticodeCachingDuration(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getmulticodecachingduration)
|
|
190
|
+
|
|
191
|
+
* [`setBeepOnSuccessEnabled(enabled: boolean)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setbeeponsuccessenabled)
|
|
192
|
+
* [`getActiveCamera(): string`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getactivecamera)
|
|
193
|
+
* [`setQRDpmModeEnabled(enabled: boolean)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setqrdpmmodeenabled)
|
|
194
|
+
* [`setQRMicroDpmModeEnabled(enabled: boolean)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setqrmicrodpmmodeenabled)
|
|
195
|
+
* [`getDatamatrixDpmModeEnabled(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getdatamatrixdpmmodeenabled)
|
|
196
|
+
* [`setBarcodeThumbnailOnResultEnabled(enabled: boolean)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setbarcodethumbnailonresultenabled)
|
|
197
|
+
* [`isBarcodeThumbnailOnResultEnabled(): boolean`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#isbarcodethumbnailonresultenabled)
|
|
198
|
+
* [`getMaxZoomFactor(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getmaxzoomfactor)
|
|
199
|
+
* [`isFlashAvailable(): boolean`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#isflashavailable)
|
|
200
|
+
* [`setEnableComposite(enableComposite: boolean)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setenablecomposite)
|
|
201
|
+
* [`getEnableComposite(): boolean`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getenablecomposite)
|
|
202
|
+
* [`getEnabledDecoders(): number[]`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getenableddecoders)
|
|
203
|
+
* [`setRoiOverlayBackgroundColor(color: string)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setroioverlaybackgroundcolor)
|
|
204
|
+
* [`setLocationInImageResultEnabled(enabled: boolean)`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setlocationinimageresultenabled)
|
|
205
|
+
* [`getRoiOverlayBackgroundColor(): string`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getroioverlaybackgroundcolor)
|
|
206
|
+
* [`isLocationInImageResultEnabled(): boolean`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#islocationinimageresultenabled)
|
|
207
|
+
* [`setLocationLineColor(color: string): void`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setlocationlinecolor)
|
|
208
|
+
* [`getCameraResolution(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getcameraresolution)
|
|
209
|
+
* [`getEncodingCharacterSet(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getencodingcharacterset)
|
|
210
|
+
* [`getMsiChecksumType(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getmsichecksumtype)
|
|
211
|
+
* [`getCode11ChecksumType(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getcode11checksumtype)
|
|
212
|
+
* [`getCode39ChecksumType(): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getcode39checksumtype)
|
|
213
|
+
* [`getContinuous(): boolean`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#getcontinuous)
|
|
214
|
+
* [`isBeepOnSuccessEnabled(): boolean`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#isbeeponsuccessenabled)
|
|
215
|
+
* [`setStopOnCameraInitEnabled(stopOnCameraInitEnabled: boolean): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setstoponcamerainitenabled)
|
|
216
|
+
* [`setContainerOptions(containerOptions: { width: number, height: number, overrideSize: boolean, useFallbackSize: boolean }): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setcontaineroptions)
|
|
217
|
+
* [`setCustomOption(customOption: string, value: number): number`](https://barkoder.com/docs/v1/barkoder-web-sdk/web-sdk-for-barkoder-api-reference#setcustomoption)
|
|
198
218
|
|
|
199
219
|
<br>
|
|
@@ -0,0 +1,285 @@
|
|
|
1
|
+
export declare interface BKResult {
|
|
2
|
+
|
|
3
|
+
error?: {
|
|
4
|
+
name: string,
|
|
5
|
+
message: string
|
|
6
|
+
};
|
|
7
|
+
|
|
8
|
+
resultsCount: number;
|
|
9
|
+
barcodeTypeName?: string;
|
|
10
|
+
textualData?: string;
|
|
11
|
+
binaryData?: number[];
|
|
12
|
+
gs1?: number;
|
|
13
|
+
location?: {
|
|
14
|
+
p1: { x:number, y:number },
|
|
15
|
+
p2: { x:number, y:number },
|
|
16
|
+
p3: { x:number, y:number },
|
|
17
|
+
p4: { x:number, y:number }
|
|
18
|
+
};
|
|
19
|
+
capturedFrame?: ImageData,
|
|
20
|
+
capturedBarcode?: ImageData,
|
|
21
|
+
formattedJSON?: string;
|
|
22
|
+
formattedText?: string;
|
|
23
|
+
|
|
24
|
+
results?: {
|
|
25
|
+
barcodeTypeName: string,
|
|
26
|
+
textualData: string,
|
|
27
|
+
binaryData: number[],
|
|
28
|
+
gs1: number,
|
|
29
|
+
location: {
|
|
30
|
+
p1: { x:number, y:number },
|
|
31
|
+
p2: { x:number, y:number },
|
|
32
|
+
p3: { x:number, y:number },
|
|
33
|
+
p4: { x:number, y:number }
|
|
34
|
+
},
|
|
35
|
+
capturedFrame?: ImageData,
|
|
36
|
+
capturedBarcode?: ImageData,
|
|
37
|
+
formattedJSON?: string;
|
|
38
|
+
formattedText?: string;
|
|
39
|
+
}[];
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export declare enum DecodingSpeed {
|
|
43
|
+
Fast = 0,
|
|
44
|
+
Normal = 1,
|
|
45
|
+
Slow = 2,
|
|
46
|
+
Rigorous = 3
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export declare enum Decoders {
|
|
50
|
+
Aztec = 0,
|
|
51
|
+
AztecCompact = 1,
|
|
52
|
+
QR = 2,
|
|
53
|
+
QRMicro = 3,
|
|
54
|
+
Code128 = 4,
|
|
55
|
+
Code93 = 5,
|
|
56
|
+
Code39 = 6,
|
|
57
|
+
Codabar = 7,
|
|
58
|
+
Code11 = 8,
|
|
59
|
+
Msi = 9,
|
|
60
|
+
UpcA = 10,
|
|
61
|
+
UpcE = 11,
|
|
62
|
+
UpcE1 = 12,
|
|
63
|
+
Ean13 = 13,
|
|
64
|
+
Ean8 = 14,
|
|
65
|
+
PDF417 = 15,
|
|
66
|
+
PDF417Micro = 16,
|
|
67
|
+
Datamatrix = 17,
|
|
68
|
+
Code25 = 18,
|
|
69
|
+
Interleaved25 = 19,
|
|
70
|
+
ITF14 = 20,
|
|
71
|
+
IATA25 = 21,
|
|
72
|
+
Matrix25 = 22,
|
|
73
|
+
Datalogic25 = 23,
|
|
74
|
+
COOP25 = 24,
|
|
75
|
+
Code32 = 25,
|
|
76
|
+
Telepen = 26,
|
|
77
|
+
Dotcode = 27,
|
|
78
|
+
IDDocument = 28,
|
|
79
|
+
Databar14 = 29,
|
|
80
|
+
DatabarLimited = 30,
|
|
81
|
+
DatabarExpanded = 31,
|
|
82
|
+
PostalIMB = 32,
|
|
83
|
+
Postnet = 33,
|
|
84
|
+
Planet = 34,
|
|
85
|
+
AustralianPost = 35,
|
|
86
|
+
RoyalMail = 36,
|
|
87
|
+
KIX = 37,
|
|
88
|
+
JapanesePost = 38
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export declare enum Code11ChecksumType {
|
|
92
|
+
disabled = 0,
|
|
93
|
+
single = 1,
|
|
94
|
+
double = 2
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export declare enum Code39ChecksumType {
|
|
98
|
+
disabled = 0,
|
|
99
|
+
enabled = 1
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
export declare enum MsiChecksumType {
|
|
103
|
+
disabled = 0,
|
|
104
|
+
mod10 = 1,
|
|
105
|
+
mod11 = 2,
|
|
106
|
+
mod1010 = 3,
|
|
107
|
+
mod1110 = 4,
|
|
108
|
+
mod11IBM = 5,
|
|
109
|
+
mod1110IBM = 6
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
export declare enum UpcEanDeblur {
|
|
113
|
+
Disable = 0,
|
|
114
|
+
Enable = 1
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
export declare enum MulticodeCachingEnabled {
|
|
118
|
+
Disable = 0,
|
|
119
|
+
Enable = 1
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
export declare enum EnableMisshaped1D {
|
|
123
|
+
Disable = 0,
|
|
124
|
+
Enable = 1
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
export declare enum EnableVINRestrictions {
|
|
128
|
+
Disable = 0,
|
|
129
|
+
Enable = 1
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
export declare enum EnableComposite {
|
|
133
|
+
Disable = 0,
|
|
134
|
+
Enable = 1
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
export declare enum Formatting {
|
|
138
|
+
Disabled = 0,
|
|
139
|
+
Automatic = 1,
|
|
140
|
+
GS1 = 2,
|
|
141
|
+
AAMVA = 3,
|
|
142
|
+
SADL = 4
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
export declare enum EncodingCharacterSet {
|
|
146
|
+
None = 0,
|
|
147
|
+
ISO_8859_2 = 1, // iso-8859-2 / latin2
|
|
148
|
+
ISO_8859_5 = 2, // iso-8859-5 / cyrillic
|
|
149
|
+
Shift_JIS = 3, // shift-jis
|
|
150
|
+
US_ASCII = 4, // us-ascii
|
|
151
|
+
UTF_8 = 5, // utf-8 (default)
|
|
152
|
+
UTF_16 = 6, // utf-16 (little endian)
|
|
153
|
+
windows_1251 = 7, // windows-1251
|
|
154
|
+
windows_1256 = 8, // windows-1256
|
|
155
|
+
BINARY = 9 // BINARY
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
export declare enum CameraResolution {
|
|
159
|
+
HD = 0,
|
|
160
|
+
FHD = 1
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
export declare interface Barkoder extends EventTarget {
|
|
164
|
+
constants: {
|
|
165
|
+
|
|
166
|
+
DecodingSpeed: typeof DecodingSpeed,
|
|
167
|
+
|
|
168
|
+
Decoders: typeof Decoders,
|
|
169
|
+
|
|
170
|
+
Code11ChecksumType: typeof Code11ChecksumType,
|
|
171
|
+
|
|
172
|
+
Code39ChecksumType: typeof Code39ChecksumType,
|
|
173
|
+
|
|
174
|
+
MsiChecksumType: typeof MsiChecksumType,
|
|
175
|
+
|
|
176
|
+
UpcEanDeblur: typeof UpcEanDeblur,
|
|
177
|
+
|
|
178
|
+
MulticodeCachingEnabled: typeof MulticodeCachingEnabled,
|
|
179
|
+
|
|
180
|
+
EnableMisshaped1D: typeof EnableMisshaped1D,
|
|
181
|
+
|
|
182
|
+
EnableVINRestrictions: typeof EnableVINRestrictions,
|
|
183
|
+
|
|
184
|
+
EnableComposite: typeof EnableComposite,
|
|
185
|
+
|
|
186
|
+
Formatting: typeof Formatting,
|
|
187
|
+
|
|
188
|
+
EncodingCharacterSet: typeof EncodingCharacterSet,
|
|
189
|
+
|
|
190
|
+
CameraResolution: typeof CameraResolution
|
|
191
|
+
};
|
|
192
|
+
|
|
193
|
+
configureBarkoder: (barkoderConfig: object) => boolean;
|
|
194
|
+
scanImage: (imageUri: string, resultCallback?: (result: BKResult) => void) => void | Promise<BKResult>;
|
|
195
|
+
setDecodingSpeed: (decodingSpeed: DecodingSpeed) => number;
|
|
196
|
+
setEnabledDecoders: (...decoders: Decoders[]) => void;
|
|
197
|
+
getEnabledDecoders: () => number[];
|
|
198
|
+
setUpcEanDeblur: (upcEanDeblur: UpcEanDeblur) => number;
|
|
199
|
+
getRegionOfInterest: () => { x: number, y: number, width: number, height: number };
|
|
200
|
+
setRegionOfInterest: (left: number, top: number, width: number, height: number) => void;
|
|
201
|
+
setLengthRange: (decoder: Decoders, minLength: number, maxLength: number) => number;
|
|
202
|
+
setCustomOption: (customOption: string, value: number) => number;
|
|
203
|
+
setFormatting: (formatting: Formatting) => number;
|
|
204
|
+
setDuplicatesDelayMs: (duplicatesDelayMs: number) => number;
|
|
205
|
+
setEncodingCharacterSet: (encodingCharacterSet: EncodingCharacterSet) => number;
|
|
206
|
+
setMulticodeCachingEnabled: (multicodeCachingEnabled: MulticodeCachingEnabled) => number;
|
|
207
|
+
setMulticodeCachingDuration: (multicodeCachingDuration: number) => number;
|
|
208
|
+
setMaximumResultsCount: (maximumResultsCount: number) => number;
|
|
209
|
+
setEnableMisshaped1D: (enableMisshaped1D: EnableMisshaped1D) => number;
|
|
210
|
+
setEnableVINRestrictions: (enableVINRestrictions: EnableVINRestrictions) => number;
|
|
211
|
+
setEnableComposite: (enableComposite: EnableComposite) => number;
|
|
212
|
+
getDecodingSpeed: () => number;
|
|
213
|
+
getUpcEanDeblur: () => number;
|
|
214
|
+
getFormatting: () => number;
|
|
215
|
+
getDuplicatesDelayMs: () => number;
|
|
216
|
+
getMaximumResultsCount: () => number;
|
|
217
|
+
getEnableMisshaped1D: () => number;
|
|
218
|
+
getEnableVINRestrictions: () => number;
|
|
219
|
+
getEnableComposite: () => number;
|
|
220
|
+
getEncodingCharacterSet: () => number;
|
|
221
|
+
getMsiChecksumType: () => number;
|
|
222
|
+
getCode39ChecksumType: () => number;
|
|
223
|
+
getCode11ChecksumType: () => number;
|
|
224
|
+
getDatamatrixDpmModeEnabled: () => boolean;
|
|
225
|
+
isBarcodeTypeEnabled: (decoder: number) => boolean | -1;
|
|
226
|
+
setBarcodeTypeEnabled: (decoder: number, enable: boolean) => number;
|
|
227
|
+
getBarcodeTypeLengthRange: (decoder: number) => [number, number] | -1;
|
|
228
|
+
getMulticodeCachingEnabled: () => number;
|
|
229
|
+
getMulticodeCachingDuration: () => number;
|
|
230
|
+
setCode11ChecksumType: (code11ChecksumType: Code11ChecksumType) => number;
|
|
231
|
+
setCode39ChecksumType: (code39ChecksumType: Code39ChecksumType) => number;
|
|
232
|
+
setMsiChecksumType: (msiChecksumType: MsiChecksumType) => number;
|
|
233
|
+
setDatamatrixDpmModeEnabled: (dpmModeEnabled: boolean) => number;
|
|
234
|
+
setQRDpmModeEnabled: (dpmModeEnabled: boolean) => number;
|
|
235
|
+
setQRMicroDpmModeEnabled: (dpmModeEnabled: boolean) => number;
|
|
236
|
+
setFlashEnabled: (flashEnabled: boolean) => number;
|
|
237
|
+
setZoomEnabled: (zoomEnabled: boolean) => number;
|
|
238
|
+
setCloseEnabled: (closeEnabled: boolean) => number;
|
|
239
|
+
setCameraPickerEnabled: (cameraPickerEnabled: boolean) => number;
|
|
240
|
+
changeFlashState: () => void;
|
|
241
|
+
changeZoomState: () => void;
|
|
242
|
+
getMaxZoomFactor: () => number;
|
|
243
|
+
isFlashAvailable: () => boolean;
|
|
244
|
+
setCameraResolution: (camRes: CameraResolution) => number;
|
|
245
|
+
setDpsLimit: (dpsLimit: number) => number;
|
|
246
|
+
setScannerTimeout: (timeout_ms: number) => number;
|
|
247
|
+
setContinuous: (continuous: boolean) => number;
|
|
248
|
+
setBeepOnSuccessEnabled: (beepEnabled: boolean) => number;
|
|
249
|
+
setStopOnCameraInitEnabled: (stopOnCameraInitEnabled: boolean) => number;
|
|
250
|
+
setContainerOptions: (containerOptions: { width: number, height: number, overrideSize: boolean, useFallbackSize: boolean }) => number;
|
|
251
|
+
getCameraResolution: () => number;
|
|
252
|
+
getContinuous: () => boolean;
|
|
253
|
+
isBeepOnSuccessEnabled: () => boolean;
|
|
254
|
+
applyTemplate: (templateFile: string, templateMode: string) => Promise<{ returnValue: number, error?: { name: string, message: string } }>;
|
|
255
|
+
startScanner: (resultCallback?: (result: BKResult) => void) => void;
|
|
256
|
+
stopScanner: () => void;
|
|
257
|
+
setCameraId: (id: string) => void;
|
|
258
|
+
getActiveCamera: () => string | null;
|
|
259
|
+
getCameras: () => Promise<{ id: string, label: string }[]>;
|
|
260
|
+
setPauseDecoding: (pause: boolean) => void;
|
|
261
|
+
setLocationLineColor: (color: string) => void;
|
|
262
|
+
setLocationLineWidth: (width: number) => void;
|
|
263
|
+
setRoiLineColor: (color: string) => void;
|
|
264
|
+
setRoiOverlayBackgroundColor: (color: string) => void;
|
|
265
|
+
setRoiLineWidth: (width: number) => void;
|
|
266
|
+
setRegionOfInterestVisible: (visible: boolean) => void;
|
|
267
|
+
setImageResultEnabled: (enabled: boolean) => void;
|
|
268
|
+
setLocationInImageResultEnabled: (enabled: boolean) => void;
|
|
269
|
+
setBarcodeThumbnailOnResultEnabled: (enabled: boolean) => void;
|
|
270
|
+
setLocationInPreviewEnabled: (enabled: boolean) => void;
|
|
271
|
+
getLocationLineColor: () => string;
|
|
272
|
+
getLocationLineWidth: () => number;
|
|
273
|
+
getRoiLineColor: () => string;
|
|
274
|
+
getRoiOverlayBackgroundColor: () => string;
|
|
275
|
+
getRoiLineWidth: () => number;
|
|
276
|
+
isRegionOfInterestVisible: () => boolean;
|
|
277
|
+
isImageResultEnabled: () => boolean;
|
|
278
|
+
isLocationInImageResultEnabled: () => boolean;
|
|
279
|
+
isBarcodeThumbnailOnResultEnabled: () => boolean;
|
|
280
|
+
isLocationInPreviewEnabled: () => boolean;
|
|
281
|
+
scanFromLocalFileSystem: (input: FileList, result_callback: (result: BKResult) => void) => void;
|
|
282
|
+
getVersion: () => { barkoderWebVersion: string, barkoderVersion: string, barkoderFullVersion: string, barkoderOcrVersion: boolean };
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
export declare function initialize(key: string): Promise<Barkoder>;
|