capacitor-plugin-dynamsoft-label-recognizer

Capacitor plugin of Dynamsoft Label Recognizer which brings text recognition ability to your apps.

Versions

For Capacitor v6, use v2.x.

For Capacitor v5, use v1.x.

For Capacitor v4, use v0.x.

SDK Versions Used for Different Platforms

| Product | Android | iOS | Web | | ----------- | ----------- | ----------- | ----------- | | Dynamsoft Label Recognizer | 2.x | 2.x | 2.x |

Install

npm install capacitor-plugin-dynamsoft-label-recognizer
npx cap sync

Demo

Vanilla JS example

API

• initialize()
• initLicense(...)
• recognizeBase64String(...)
• recognizeBitmap(...)
• updateRuntimeSettings(...)
• resetRuntimeSettings()
• setEngineResourcesPath(...)
• addListener('onResourcesLoadStarted', ...)
• addListener('onResourcesLoaded', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

initialize()

initialize() => Promise<void>

initLicense(...)

initLicense(options: { license: string; }) => Promise<void>

| Param | Type | | ------------- | --------------------------------- | | options | { license: string; } |

recognizeBase64String(...)

recognizeBase64String(options: { base64: string; }) => Promise<{ results: DLRResult[]; }>

| Param | Type | | ------------- | -------------------------------- | | options | { base64: string; } |

Returns: Promise<{ results: DLRResult[]; }>

recognizeBitmap(...)

recognizeBitmap(options: { className?: string; methodName?: string; }) => Promise<{ results: DLRResult[]; }>

Android and iOS only method which directly read camera frames from capacitor-plugin-camera

| Param | Type | | ------------- | --------------------------------------------------------- | | options | { className?: string; methodName?: string; } |

Returns: Promise<{ results: DLRResult[]; }>

updateRuntimeSettings(...)

updateRuntimeSettings(options: { settings: RuntimeSettings; }) => Promise<void>

| Param | Type | | ------------- | -------------------------------------------------------------------------- | | options | { settings: RuntimeSettings; } |

resetRuntimeSettings()

resetRuntimeSettings() => Promise<void>

setEngineResourcesPath(...)

setEngineResourcesPath(options: { path: string; }) => Promise<void>

| Param | Type | | ------------- | ------------------------------ | | options | { path: string; } |

addListener('onResourcesLoadStarted', ...)

addListener(eventName: 'onResourcesLoadStarted', listenerFunc: onResourcesLoadStartedListener) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | ----------------------------------------------------------------------------------------- | | eventName | 'onResourcesLoadStarted' | | listenerFunc | onResourcesLoadStartedListener |

Returns: Promise<PluginListenerHandle>

addListener('onResourcesLoaded', ...)

addListener(eventName: 'onResourcesLoaded', listenerFunc: onResourcesLoadedListener) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | ------------------------------------------------------------------------------- | | eventName | 'onResourcesLoaded' | | listenerFunc | onResourcesLoadedListener |

Returns: Promise<PluginListenerHandle>

removeAllListeners()

removeAllListeners() => Promise<void>

Interfaces

DLRResult

| Prop | Type | | ----------------- | ------------------------------------------------------------- | | location | DLRQuadrilateral | | confidence | number | | lineResults | DLRLineResult[] |

DLRQuadrilateral

| Prop | Type | | ------------ | ----------------------- | | points | DLRPoint[] |

DLRPoint

| Prop | Type | | ------- | ------------------- | | x | number | | y | number |

DLRLineResult

| Prop | Type | | ------------------------- | ------------------------------------------------------------- | | text | string | | location | DLRQuadrilateral | | confidence | number | | isCheckDigitMatched | boolean |

RuntimeSettings

| Prop | Type | | ----------------------- | --------------------------------------------------------------- | | template | string | | customModelConfig | CustomModelConfig |

CustomModelConfig

| Prop | Type | | -------------------------- | --------------------- | | customModelFolder | string | | customModelFileNames | string[] |

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

Type Aliases

onResourcesLoadStartedListener

(resourcePath: string): void

onResourcesLoadedListener

(resourcePath: string): void