A capacitor plugin for Dynamsoft Barcode Reader.
Note
This repo is not actively maintained and the performance and camera control differences between the mobile native and the JavaScript platforms are now small. You can directly use the JavaScript SDK: https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/2f0a723e88e3271170672e61c214a3d1d7a31328/frameworks/capacitor
npm install capacitor-plugin-dynamsoft-barcode-reader
npx cap sync- Android
- iOS
- Web
For Capacitor 7, use 3.x.
For Capacitor 6, use 2.x.
For Capacitor <= 5, use 1.x.
| Product | Android | iOS | Web |
|---|---|---|---|
| Dynamsoft Barcode Reader | 10.4.20 | 10.4.20 | 10.4.20 |
- Code 11
- Code 39
- Code 93
- Code 128
- Codabar
- EAN-2
- EAN-5
- EAN-8
- EAN-13
- UPC-A
- UPC-E
- UPC-2
- UPC-5
- Interleaved 2 of 5 (ITF)
- Industrial 2 of 5 (Code 2 of 5 Industry, Standard 2 of 5, Code 2 of 5)
- ITF-14
- QRCode
- DataMatrix
- PDF417
- GS1 DataBar
- Maxicode
- Micro PDF417
- Micro QR
- PatchCode
- GS1 Composite
- Postal Code
- Dot Code
- Pharmacode
initLicense(...)initialize()initRuntimeSettingsFromString(...)decode(...)decodeBitmap(...)setEngineResourcePaths(...)- Interfaces
initLicense(options: { license: string; }) => Promise<{ success?: boolean; message?: string; }>| Param | Type |
|---|---|
options |
{ license: string; } |
Returns: Promise<{ success?: boolean; message?: string; }>
initialize() => Promise<{ success?: boolean; message?: string; }>Returns: Promise<{ success?: boolean; message?: string; }>
initRuntimeSettingsFromString(options: { template: string; }) => Promise<void>| Param | Type |
|---|---|
options |
{ template: string; } |
decode(options: { source: string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement; template?: string; }) => Promise<{ results: TextResult[]; }>source: Android and iOS only support base64 string. path: for Android and iOS. template: pass a template name to specify the template
| Param | Type |
|---|---|
options |
{ source: any; template?: string; } |
Returns: Promise<{ results: TextResult[]; }>
decodeBitmap(options: { className?: string; methodName?: string; template?: string; }) => Promise<{ results: TextResult[]; }>Android and iOS only method which directly read camera frames from capacitor-plugin-camera
| Param | Type |
|---|---|
options |
{ className?: string; methodName?: string; template?: string; } |
Returns: Promise<{ results: TextResult[]; }>
setEngineResourcePaths(options: { paths: any; }) => Promise<void>Web only method to set the engine resource path
| Param | Type |
|---|---|
options |
{ paths: any; } |
| Prop | Type |
|---|---|
barcodeText |
string |
barcodeFormat |
string |
barcodeBytesBase64 |
string |
x1 |
number |
y1 |
number |
x2 |
number |
y2 |
number |
x3 |
number |
y3 |
number |
x4 |
number |
y4 |
number |