Package com.microblink.documentverification.fragment.overlay.documentverification.settings.options

Interface DocumentVerificationOverlaySettingsOptions<T>

All Known Implementing Classes:

DocumentVerificationOverlaySettings.Builder

public interface DocumentVerificationOverlaySettingsOptions<T>

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_SHOW_TOOLTIP_TIME_INTERVAL_MS
static long	DEFAULT_TILT_START_TIME_INTERVAL_MS
static long	DEFAULT_TILT_STEP_TIMEOUT_INTERVAL_MS
static long	TIME_INFINITY

Method Summary

Modifier and Type	Method	Description
T	setDocumentTypeUi(DocumentTypeUi documentTypeUi)
T	setKeepScreenOn(boolean keepScreenOn)
T	setShowTooltipTimeIntervalMs(long showTooltipTimeIntervalMs)	Sets time interval between the start of the tilt step and displaying the help tooltip.
T	setTiltStartTimeIntervalMs(long tiltStartTimeInterval)	Sets time interval between neutral tilt step and first tilt step (left, right, top or down).
T	setTiltStepTimeoutIntervalMs(long tiltStepTimeoutInterval)	Sets timeout interval for each tilt step.

Field Detail

DEFAULT_TILT_START_TIME_INTERVAL_MS

static final long DEFAULT_TILT_START_TIME_INTERVAL_MS

See Also:

Constant Field Values

DEFAULT_TILT_STEP_TIMEOUT_INTERVAL_MS

static final long DEFAULT_TILT_STEP_TIMEOUT_INTERVAL_MS

See Also:

Constant Field Values

DEFAULT_SHOW_TOOLTIP_TIME_INTERVAL_MS

static final long DEFAULT_SHOW_TOOLTIP_TIME_INTERVAL_MS

See Also:

Constant Field Values

TIME_INFINITY

static final long TIME_INFINITY

See Also:

Constant Field Values

Method Detail

setTiltStartTimeIntervalMs

@NonNull
T setTiltStartTimeIntervalMs(long tiltStartTimeInterval)

Sets time interval between neutral tilt step and first tilt step (left, right, top or down). By default, this is set to DEFAULT_TILT_START_TIME_INTERVAL_MS.

Parameters:

tiltStartTimeInterval - time interval between neutral tilt step and first tilt step.

Returns:

this options object.

setTiltStepTimeoutIntervalMs

@NonNull
T setTiltStepTimeoutIntervalMs(long tiltStepTimeoutInterval)

Sets timeout interval for each tilt step. To disable the timeout, set it to TIME_INFINITY. By default, this is set to DEFAULT_TILT_STEP_TIMEOUT_INTERVAL_MS.

Parameters:

tiltStepTimeoutInterval - timeout interval for each tilt step.

Returns:

this options object.

setShowTooltipTimeIntervalMs

@NonNull
T setShowTooltipTimeIntervalMs(long showTooltipTimeIntervalMs)

Sets time interval between the start of the tilt step and displaying the help tooltip. Help tooltip is displayed only once. By default, this is set to DEFAULT_SHOW_TOOLTIP_TIME_INTERVAL_MS.

Parameters:

showTooltipTimeIntervalMs - time interval between the start of the tilt step and displaying the help tooltip.

Returns:

this options object.

setKeepScreenOn

@NonNull
T setKeepScreenOn(boolean keepScreenOn)

setDocumentTypeUi

@NonNull
T setDocumentTypeUi(DocumentTypeUi documentTypeUi)