@captureid/capacitor-cidscan

Camera Scanning API

Install

npm install @captureid/capacitorng-cidscan
npx cap sync

API

• activateLicense(...)
• addListener(string, ...)
• arHideWebOverlay()
• arShowWebOverlay(...)
• arShowWebOverlayFromURL(...)
• closeCIDScannerLib()
• enableAllSymbologies(...)
• enableSymbology(...)
• initCIDScannerLib()
• initScanner(...)
• removeAllListeners()
• setAimSize(...)
• setAimStyle(...)
• setConfiguration(...)
• setDecoderToleranceLevel(...)
• setTorch(...)
• showAim(...)
• showSettings(...)
• showUI(...)
• startDecode()
• startPreview()
• startScanner()
• startSplitOverlay(...)
• startSplitScreen(...)
• stopDecode()
• stopPreview()
• Interfaces
• Enums

activateLicense(...)

activateLicense(options: { productkey: string; }) => Promise<{ result: string; }>

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

Returns: Promise<{ result: string; }>

addListener(string, ...)

addListener(eventName: string, listenerFunc: (data: CIDScanEvent) => void) => PluginListenerHandle

| Param | Type | | ------------------ | ------------------------------------------------------------------------ | | eventName | string | | listenerFunc | (data: CIDScanEvent) => void |

Returns: PluginListenerHandle

arHideWebOverlay()

arHideWebOverlay() => void

arShowWebOverlay(...)

arShowWebOverlay(options: { baseUrl: string; content: string; }) => void

| Param | Type | | ------------- | -------------------------------------------------- | | options | { baseUrl: string; content: string; } |

arShowWebOverlayFromURL(...)

arShowWebOverlayFromURL(options: { url: string; }) => void

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

closeCIDScannerLib()

closeCIDScannerLib() => Promise<void>

enableAllSymbologies(...)

enableAllSymbologies(options: { enable: boolean; }) => void

| Param | Type | | ------------- | --------------------------------- | | options | { enable: boolean; } |

enableSymbology(...)

enableSymbology(options: { symbology: Symbology; enable: boolean; }) => void

| Param | Type | | ------------- | -------------------------------------------------------------------------------- | | options | { symbology: Symbology; enable: boolean; } |

initCIDScannerLib()

initCIDScannerLib() => Promise<void>

initScanner(...)

initScanner(options: { config: ScannerConfig; }) => Promise<void>

| Param | Type | | ------------- | -------------------------------------------------------------------- | | options | { config: ScannerConfig; } |

removeAllListeners()

removeAllListeners() => void

setAimSize(...)

setAimSize(options: { width: number; height: number; }) => void

| Param | Type | | ------------- | ----------------------------------------------- | | options | { width: number; height: number; } |

setAimStyle(...)

setAimStyle(options: { style: AimStyle; color: Color; }) => void

| Param | Type | | ------------- | -------------------------------------------------------------------------------------------- | | options | { style: AimStyle; color: Color; } |

setConfiguration(...)

setConfiguration(options: { config: ScannerConfig; }) => Promise<void>

| Param | Type | | ------------- | -------------------------------------------------------------------- | | options | { config: ScannerConfig; } |

setDecoderToleranceLevel(...)

setDecoderToleranceLevel(options: { toleranceLevel: number; }) => void

| Param | Type | | ------------- | ---------------------------------------- | | options | { toleranceLevel: number; } |

setTorch(...)

setTorch(options: { enable: boolean; }) => void

| Param | Type | | ------------- | --------------------------------- | | options | { enable: boolean; } |

showAim(...)

showAim(options: { aim: Aim; }) => void

| Param | Type | | ------------- | --------------------------------------------- | | options | { aim: Aim; } |

showSettings(...)

showSettings(options: { config: ScannerConfig; }) => void

| Param | Type | | ------------- | -------------------------------------------------------------------- | | options | { config: ScannerConfig; } |

showUI(...)

showUI(options: { show: boolean; }) => void

| Param | Type | | ------------- | ------------------------------- | | options | { show: boolean; } |

startDecode()

startDecode() => void

startPreview()

startPreview() => Promise<DecoderStatusType>

Returns: Promise<DecoderStatusType>

startScanner()

startScanner() => Promise<DecoderStatusType>

Returns: Promise<DecoderStatusType>

startSplitOverlay(...)

startSplitOverlay(options: { height: number; paddingTop: number; }) => void

| Param | Type | | ------------- | ---------------------------------------------------- | | options | { height: number; paddingTop: number; } |

startSplitScreen(...)

startSplitScreen(options: { height: number; }) => void

| Param | Type | | ------------- | -------------------------------- | | options | { height: number; } |

stopDecode()

stopDecode() => void

stopPreview()

stopPreview() => void

Interfaces

PluginListenerHandle

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

CIDScanEvent

| Prop | Type | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | type | ScannerEventType | LicenseEventType | DecoderEventType | | status | DecoderStatusType | ScannerStatusType | LicenseStatusType | | message | string | | error | number | | source | string | | decodes | BarcodeData[] | | action | ScannerActionType |

BarcodeData

| Prop | Type | | -------------------- | ------------------- | | barcode | string | | type | string | | corners | any[] | | previewcorners | any[] |

Symbology

| Prop | Type | | -------------- | ------------------------------------------------------------------- | | name | string | | category | SymbologiesCategory | | enabled | boolean |

ScannerConfig

Color

| Prop | Type | | ----------- | ------------------- | | red | number | | green | number | | blue | number | | alpha | number |

Aim

| Prop | Type | | ------------- | --------------------------------------------- | | enabled | boolean | | color | Color | | style | AimStyle |

Enums

ScannerEventType

| Members | Value | | ------------- | -------------- | | SUCCESS | 0 | | NOTIFY | 1 | | FAILED | 2 |

LicenseEventType

| Members | Value | | ---------------- | -------------- | | NONE | 0 | | ACTIVATION | 1 | | STATUS | 2 |

DecoderEventType

| Members | Value | | ------------ | -------------- | | NONE | 0 | | STATUS | 1 | | DATA | 2 |

ScannerStatusType

| Members | Value | | ------------- | -------------- | | OK | 0 | | UNKNOWN | 1 |

LicenseStatusType

| Members | Value | | ------------- | -------------- | | VALID | 0 | | INVALID | 1 | | FAILED | 2 |

DecoderStatusType

| Members | Value | | ------------------------ | --------------- | | OK | 0 | | OK_READY_TO_DECODE | 1 | | OK_STILL_DECODING | 2 | | NOT_CONNECTED | 4 | | TRYING_TO_CONNECT | 5 | | CONNECTED | 6 | | BATTERY_NOT_OK | 9 | | ERROR | 11 |

ScannerActionType

| Members | Value | | ------------------------- | -------------- | | NONE | 0 | | LICENSE_ACTIVATION | 1 | | DECODED | 2 | | DECODED_MULTIPLE | 3 | | DECODED_COORDINATES | 4 | | SCANNER_INITIALIZED | 5 | | SCANNER_STARTED | 6 | | SETTINGS_CHANGED | 7 | | SCAN_BUTTON_CLICKED | 8 |

SymbologiesCategory

| Members | Value | | --------------------- | -------------- | | CATEGORY_1D | 1 | | CATEGORY_2D | 2 | | CATEGORY_POSTAL | 3 |

AimStyle

| Members | Value | | --------------- | -------------- | | NONE | 0 | | DOT | 1 | | CROSS | 2 | | EXTCROSS | 3 | | CORNERS | 4 | | RECTANGLE | 5 | | SQUARE | 6 | | BAR | 7 |