Skip to main content
Version: v7.7.x

WorkerScanningSession

@microblink/blinkid


@microblink/blinkid / WorkerScanningSession

Type Alias: WorkerScanningSession

WorkerScanningSession = Omit<BlinkIdScanningSession, "process" | "deleteLater" | "isAliasOf"> & object

The worker scanning session.

Type declaration

getSettings()

getSettings: () => BlinkIdSessionSettings

Gets the settings.

Returns

BlinkIdSessionSettings

The settings.

ping

ping: BlinkIdWorker["reportPinglet"]

process()

process: (image) => ProcessResultWithBuffer | BlinkIdSessionErrorWithBuffer

Parameters

image

ImageData

Returns

ProcessResultWithBuffer | BlinkIdSessionErrorWithBuffer

sendPinglets

sendPinglets: BlinkIdWorker["sendPinglets"]

showDemoOverlay()

showDemoOverlay: () => boolean

Shows the demo overlay.

Returns

boolean

Whether the demo overlay is shown.

showProductionOverlay()

showProductionOverlay: () => boolean

Shows the production overlay.

Returns

boolean

Whether the production overlay is shown.