capacitor-plugin-dynamsoft-label-recognizer v2.0.0

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

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>

recognizeBase64String(...)

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

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

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

updateRuntimeSettings(...)

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

resetRuntimeSettings()

resetRuntimeSettings() => Promise<void>

setEngineResourcesPath(...)

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

addListener('onResourcesLoadStarted', ...)

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

Returns: Promise<PluginListenerHandle>

addListener('onResourcesLoaded', ...)

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

Returns: Promise<PluginListenerHandle>

removeAllListeners()

removeAllListeners() => Promise<void>

Interfaces

DLRResult

DLRQuadrilateral

DLRPoint

DLRLineResult

RuntimeSettings

CustomModelConfig

PluginListenerHandle

Type Aliases

onResourcesLoadStartedListener

(resourcePath: string): void

onResourcesLoadedListener

(resourcePath: string): void