getUiStateKey

@microblink/blinkid

---

@microblink/blinkid / getUiStateKey

Function: getUiStateKey()

getUiStateKey(frameProcessResult, settings?): undefined | BlinkIdUiMappableKey

Determines the appropriate UI state key based on the current frame processing result and scanning settings.

This function acts as a state machine, translating the low-level analysis and completeness results into a high-level UI state that drives the user interface.

Parameters

frameProcessResult

PartialProcessResult

The current (possibly partial) result of frame processing, including image analysis and completeness.

settings?

Partial<ScanningSettings>

Optional scanning settings that may influence state selection.

Returns

undefined | BlinkIdUiMappableKey

The UI state key representing what should be shown to the user.