Class BlinkIdUISettings
java.lang.Object
com.microblink.blinkid.uisettings.UISettings<BlinkIdOverlayController>
com.microblink.blinkid.uisettings.BaseBlinkIdUiSettings
com.microblink.blinkid.uisettings.BlinkIdUISettings
- All Implemented Interfaces:
BackSideScanningTimeoutUIOptions
,BeepSoundUIOptions
,CurrentImageListenerUIOptions
,DebugImageListenerUIOptions
,DocumentDataMatchUIOptions
,DocumentNotSupportedDialogUIOptions
,FlashlightWarningUIOptions
,HighResSuccessFrameCaptureUIOptions
,MrzDetectionUIOptions
,OcrResultDisplayUIOptions
,ScanUIEventListenerUIOptions
,SplashScreenUIOptions
,StringsUIOptions<ReticleOverlayStrings>
,StyleUIOptions
public class BlinkIdUISettings
extends BaseBlinkIdUiSettings
implements StringsUIOptions<ReticleOverlayStrings>, StyleUIOptions, FlashlightWarningUIOptions
-
Field Summary
Fields inherited from interface com.microblink.blinkid.uisettings.options.BackSideScanningTimeoutUIOptions
TIMEOUT_INFINITY
-
Constructor Summary
ConstructorDescriptionBlinkIdUISettings
(android.content.Intent intent) BlinkIdUISettings
(RecognizerBundle recognizerBundle) -
Method Summary
Modifier and TypeMethodDescriptionprotected BlinkIdOverlayView
protected boolean
protected ReticleOverlayStrings
protected int
getStyle()
Class<?>
Returns target activity.protected boolean
void
setAllowHapticFeedback
(boolean allowHapticFeedback) Defines whether haptic feedback (vibration) is activated when state of the recognizer during scanning changes.void
setOverlayViewStyle
(int styleResourceID) Provide your own style to replace default icons and colors.void
setShowCancelButton
(boolean showCancelButton) Defines whether exit (cancel) button used for cancelling the scan is shown on the screen during the scanning session.void
setShowFlashlightWarning
(boolean showFlashlightWarning) Defines whether flashlight warning will be displayed in UI, when flashlight is turned ON.void
setShowIntroductionDialog
(boolean showIntroductionDialog) Defines whether introduction dialog containing instruction messages and images is shown at the beginning of the scanning session.void
setShowMandatoryFieldsMissing
(boolean showMandatoryFieldsMissing) Defines whether document specific mandatory fields that are not visible to the recognizer are being written out in the instruction tooltip.void
setShowOnboardingInfo
(boolean showOnboardingInfo) Defines whether onboarding dialog containing recognizer specific instruction messages and images is shown at the press of a help button.void
setShowTorchButton
(boolean showTorchButton) Defines whether torch button used for turning the flashlight on and off is shown on the screen during the scanning session.void
setStrings
(ReticleOverlayStrings strings) Sets strings that will be used in the UI.Methods inherited from class com.microblink.blinkid.uisettings.BaseBlinkIdUiSettings
createOverlayController, enableHighResSuccessFrameCapture, getShowTooltipTimeIntervalMs, saveToIntent, setBackSideScanningTimeoutMs, setBeepSoundResourceID, setCurrentImageListener, setDebugImageListener, setDocumentDataMatchRequired, setOcrResultDisplayMode, setScanUIEventListener, setShowMrzDetection, setShowNotSupportedDialog, setShowTooltipTimeIntervalMs, setSplashScreenLayoutResourceID
Methods inherited from class com.microblink.blinkid.uisettings.UISettings
getActivityTheme, getFilterTouchesWhenObscured, getUsingFlagSecure, setActivityTheme, setCameraSettings, setFilterTouchesWhenObscured, setUsingFlagSecure
-
Constructor Details
-
BlinkIdUISettings
-
BlinkIdUISettings
public BlinkIdUISettings(@NonNull android.content.Intent intent)
-
-
Method Details
-
isLockedToPortrait
protected boolean isLockedToPortrait()- Specified by:
isLockedToPortrait
in classBaseBlinkIdUiSettings
-
setOverlayViewStyle
public void setOverlayViewStyle(@StyleRes int styleResourceID) Provide your own style to replace default icons and colors. Supports attributes from R.styleable.BlinkIdReticleOverlay- Specified by:
setOverlayViewStyle
in interfaceStyleUIOptions
- Parameters:
styleResourceID
- your style
-
getStyle
@StyleRes protected int getStyle() -
setStrings
Description copied from interface:StringsUIOptions
Sets strings that will be used in the UI.- Specified by:
setStrings
in interfaceStringsUIOptions<ReticleOverlayStrings>
-
getStrings
-
setShowFlashlightWarning
public void setShowFlashlightWarning(boolean showFlashlightWarning) Description copied from interface:FlashlightWarningUIOptions
Defines whether flashlight warning will be displayed in UI, when flashlight is turned ON. Default istrue
.- Specified by:
setShowFlashlightWarning
in interfaceFlashlightWarningUIOptions
- Parameters:
showFlashlightWarning
- whether flashlight warning will be displayed in UI.
-
getShowFlashlightWarning
protected boolean getShowFlashlightWarning() -
setShowOnboardingInfo
public void setShowOnboardingInfo(boolean showOnboardingInfo) Defines whether onboarding dialog containing recognizer specific instruction messages and images is shown at the press of a help button. Also defines whether help button is shown or not. Default istrue
.- Parameters:
showOnboardingInfo
- whether onboarding dialog and help button are shown
-
setShowIntroductionDialog
public void setShowIntroductionDialog(boolean showIntroductionDialog) Defines whether introduction dialog containing instruction messages and images is shown at the beginning of the scanning session. Default isfalse
.- Parameters:
showIntroductionDialog
- whether introduction dialog is shown
-
setShowTorchButton
public void setShowTorchButton(boolean showTorchButton) Defines whether torch button used for turning the flashlight on and off is shown on the screen during the scanning session. Default istrue
.- Parameters:
showTorchButton
- whether torch button is shown
-
setShowCancelButton
public void setShowCancelButton(boolean showCancelButton) Defines whether exit (cancel) button used for cancelling the scan is shown on the screen during the scanning session. Default istrue
.- Parameters:
showCancelButton
- whether exit (cancel) button is shown
-
setShowMandatoryFieldsMissing
public void setShowMandatoryFieldsMissing(boolean showMandatoryFieldsMissing) Defines whether document specific mandatory fields that are not visible to the recognizer are being written out in the instruction tooltip. Setting this tofalse
will print out a generic message about document not being fully visible. If more than two mandatory fields are not visible, generic message is shown regardless of this setting. Default isfalse
.- Parameters:
showMandatoryFieldsMissing
- whether real missing mandatory fields are being written
-
setAllowHapticFeedback
public void setAllowHapticFeedback(boolean allowHapticFeedback) Defines whether haptic feedback (vibration) is activated when state of the recognizer during scanning changes. Default istrue
.- Parameters:
allowHapticFeedback
- whether haptic feedback will be active during scanning
-
getTargetActivity
Description copied from class:UISettings
Returns target activity. Concrete settings can be used only with the corresponding activity. This method is public for convenience when you are not able to useActivityRunner
. DO NOT USE THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING. Improper usage will crash your app.- Specified by:
getTargetActivity
in classUISettings<BlinkIdOverlayController>
- Returns:
- target activity.
-
createOverlayView
- Specified by:
createOverlayView
in classBaseBlinkIdUiSettings
-