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

BlinkCardUxSettings

data class BlinkCardUxSettings(val stepTimeoutDuration: Duration = 60000.milliseconds, val inactivityTimeoutDuration: Duration = DEFAULT_INACTIVITY_TIMEOUT_DURATION_MS.milliseconds, val allowHapticFeedback: Boolean = true, val allowScanSound: Boolean = true) : Parcelable

Configuration settings for the scanning UX.

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.

Constructors

BlinkCardUxSettings

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

@JvmOverloads