blinkcard-ux/com.microblink.blinkcard.ux.settings/BlinkCardUxSettings/BlinkCardUxSettings

BlinkCardUxSettings

constructor(stepTimeoutDuration: Duration = 60000.milliseconds, inactivityTimeoutDuration: Duration = DEFAULT_INACTIVITY_TIMEOUT_DURATION_MS.milliseconds, allowHapticFeedback: Boolean = true, allowScanSound: Boolean = true)

Parameters

stepTimeoutDuration

Duration of the scanning session step before a timeout is triggered. Resets on side changes, pauses when onboarding and help screen dialogs appear. If set to Duration.ZERO, the scanning will not time out.

inactivityTimeoutDuration

Duration without any scanning progress before a timeout is triggered. Resets every time the scanning advances, either because the UI state changes (reticle type or message) or because the card is located and being processed. If set to Duration.ZERO, the scanning will not time out.

allowHapticFeedback

Whether haptic feedback is allowed during the scanning process. Defaults to true.

allowScanSound

Whether scan success sounds are allowed during the scanning process. Defaults to true.

@JvmOverloads

constructor(stepTimeoutDurationMs: Int, allowHapticFeedback: Boolean = true, allowScanSound: Boolean = true)

Constructor retaining the original Java API.

@JvmOverloads

constructor(stepTimeoutDurationMs: Int, inactivityTimeoutDurationMs: Int, allowHapticFeedback: Boolean = true, allowScanSound: Boolean = true)

Constructor for easier Java implementation.

This secondary constructor allows Java developers to create a BlinkCardUxSettings instance by providing the stepTimeoutDuration as an Int in milliseconds.

Parameters

stepTimeoutDurationMs

Duration of the scanning session step before a timeout is triggered in milliseconds. Resets on side changes, pauses when onboarding and help screen dialogs appear. If set to 0, the scanning will not time out.

inactivityTimeoutDurationMs

Duration without any scanning progress before a timeout is triggered in milliseconds. Resets every time the scanning advances, either because the UI state changes (reticle type or message) or because the card is located and being processed. If set to 0, the scanning will not time out.

allowHapticFeedback

Whether haptic feedback is allowed during the scanning process. Defaults to true.

allowScanSound

Whether scan success sounds are allowed during the scanning process. Defaults to true.