blinkid-verify-ux/com.microblink.blinkidverify.ux.capture.settings/VerifyUxSettings/VerifyUxSettings

VerifyUxSettings

constructor(stepTimeoutDuration: Duration = DEFAULT_STEP_TIMEOUT_DURATION_MS.milliseconds, inactivityTimeoutDuration: Duration = DEFAULT_INACTIVITY_TIMEOUT_DURATION_MS.milliseconds, allowHapticFeedback: Boolean = true, allowScanSound: Boolean = true, helpTooltipShowDelay: Duration = needHelpTooltipDefaultTimeToAppearMs.milliseconds, helpTooltipHideDelay: Duration = needHelpTooltipDefaultDurationMs.milliseconds)

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 of the current UI state in a scanning session before a timeout is triggered. Resets every time the UI state changes (reticle type or message). 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.

helpTooltipShowDelay

Duration before the help tooltip is shown. If less than or equal to Duration.ZERO, the help tooltip won't be shown automatically.

helpTooltipHideDelay

Duration before the help tooltip is hidden. If less than or equal to Duration.ZERO, the help tooltip won't be hidden automatically. Defaults to 5 seconds.

@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 VerifyUxSettings instance by providing the timeout durations 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 of the current UI state in a scanning session before a timeout is triggered in milliseconds. Resets every time the UI state changes (reticle type or message). 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.

constructor(stepTimeoutDurationMs: Int, allowHapticFeedback: Boolean, helpTooltipShowDelayMs: Int, helpTooltipHideDelayMs: Int)

Constructor for easier Java implementation with configurable help tooltip delays.