WorkerScanningSession

@microblink/blinkcard

---

@microblink/blinkcard / WorkerScanningSession

Type Alias: WorkerScanningSession

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

The worker scanning session.

Type declaration

getSessionId()

getSessionId: () => string

Gets the session ID.

Returns

string

The session ID.

getSessionNumber()

getSessionNumber: () => number

Gets the session number.

Returns

number

The session number.

getSettings()

getSettings: () => BlinkCardSessionSettings

Gets the settings.

Returns

BlinkCardSessionSettings

The settings.

ping

ping: BlinkCardWorker["reportPinglet"]

process()

process: (image) => ProcessResultWithBuffer

Parameters

image

ImageData

Returns

ProcessResultWithBuffer

sendPinglets

sendPinglets: BlinkCardWorker["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.