Class ReticleOverlayView
java.lang.Object
com.microblink.blinkid.fragment.overlay.blinkid.reticleui.ReticleOverlayView
- All Implemented Interfaces:
BlinkIdOverlayView
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.microblink.blinkid.fragment.overlay.blinkid.BlinkIdOverlayView
BlinkIdOverlayView.ProcessingError
-
Field Summary
Modifier and TypeFieldDescriptionprotected ReticleUiState
protected String
protected ReticleOverlayStrings
-
Constructor Summary
ConstructorDescriptionReticleOverlayView
(boolean shouldShowControlButtons, boolean shouldShowFlashlightWarning, boolean shouldShowIntroductionDialog, boolean shouldShowOnboardingInfo, boolean shouldShowMandatoryFieldsMissing, boolean shouldAllowHapticFeedback, ReticleOverlayStrings strings, int style, boolean shouldShowTorchButton, boolean shouldShowCancelButton) -
Method Summary
Modifier and TypeMethodDescriptionvoid
changeState
(ReticleUiState newState, String statusMessage) void
changeStateIfRequired
(ReticleUiState newState, String statusMessage) void
cleanup()
Clean up your resources here.android.view.ViewGroup
createLayout
(android.app.Activity activity, RecognizerRunnerView recognizerRunnerView) Inflate your custom layout here and add it to the parent viewcreateTorchController
(RecognizerRunnerView recognizerRunnerView) Return properly set-up torch controller or null if torch is handled by the activity.protected long
protected android.util.Pair<ReticleUiState,
String> detectionStatusToReticleState
(DetectionStatus detectionStatus) void
onCardDetectionUpdate
(DetectionStatus detectionStatus) Called on any update to card detection process.void
onConfigurationChanged
(int newHostScreenOrientation) Called when host's screen orientation is changed.void
Called when document is successfully classified and recognition starts.void
Called when error dialog is shown.void
Called when scanning of the first side starts.void
onGlare
(boolean hasGlare) Called on glare detection update.void
Called when user should be instructed to move closer to barcode.void
onProcessingError
(BlinkIdOverlayView.ProcessingError processingError) Called when processing error, which should be displayed to the user, occurs.long
Called when both sides are scanned.void
Called when scanning of the second side starts.void
onTorchStateChanged
(boolean torchOn) Called when torch (flashlight) state is updated.protected void
reticleOverlayStringsSetup
(android.app.Activity activity) void
setMandatoryFieldsMissingTooltipText
(int[] stringRes, android.app.Activity activity) void
setRecognizerSupportsClassification
(boolean isClassificationSupported) If true, this means that recognizer supports classification andBlinkIdOverlayView.onDocumentClassified()
will be called when the document is classified.void
setScanRecognitionModeOverlay
(ScanRecognitionMode scanRecognitionMode) Sets recognition mode used for onboarding overlay resources selection.void
setShowBackSideBarcodeInstructions
(boolean shouldShow) Set whether to show additional instructions when scanning back side of the document instructing user to scan the barcode.protected boolean
shouldStayInCurrentState
(ReticleUiState newState)
-
Field Details
-
strings
-
mandatoryFieldsMissingTooltipText
-
currentState
-
-
Constructor Details
-
ReticleOverlayView
public ReticleOverlayView(@Deprecated boolean shouldShowControlButtons, boolean shouldShowFlashlightWarning, boolean shouldShowIntroductionDialog, boolean shouldShowOnboardingInfo, boolean shouldShowMandatoryFieldsMissing, boolean shouldAllowHapticFeedback, @Nullable ReticleOverlayStrings strings, @StyleRes int style, boolean shouldShowTorchButton, boolean shouldShowCancelButton)
-
-
Method Details
-
getOnboardingView
- Specified by:
getOnboardingView
in interfaceBlinkIdOverlayView
-
createLayout
public android.view.ViewGroup createLayout(@NonNull android.app.Activity activity, @NonNull RecognizerRunnerView recognizerRunnerView) Description copied from interface:BlinkIdOverlayView
Inflate your custom layout here and add it to the parent view- Specified by:
createLayout
in interfaceBlinkIdOverlayView
- Parameters:
activity
- current activityrecognizerRunnerView
- root view to be used as inflation parent- Returns:
- root view group of your layout
-
onConfigurationChanged
public void onConfigurationChanged(int newHostScreenOrientation) Description copied from interface:BlinkIdOverlayView
Called when host's screen orientation is changed.- Specified by:
onConfigurationChanged
in interfaceBlinkIdOverlayView
- Parameters:
newHostScreenOrientation
- orientation code, possible values are: ActivityInfo.SCREEN_ORIENTATION_PORTRAIT, ActivityInfo.SCREEN_ORIENTATION_REVERSE_PORTRAIT, ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE and ActivityInfo.SCREEN_ORIENTATION_REVERSE_LANDSCAPE
-
createTorchController
@NonNull public TorchController createTorchController(@NonNull RecognizerRunnerView recognizerRunnerView) Description copied from interface:BlinkIdOverlayView
Return properly set-up torch controller or null if torch is handled by the activity.- Specified by:
createTorchController
in interfaceBlinkIdOverlayView
- Parameters:
recognizerRunnerView
- required for torch controller setup- Returns:
- torch controller
-
onFirstSideScanStarted
@CallSuper public void onFirstSideScanStarted()Description copied from interface:BlinkIdOverlayView
Called when scanning of the first side starts.- Specified by:
onFirstSideScanStarted
in interfaceBlinkIdOverlayView
-
onSecondSideScanStarted
public void onSecondSideScanStarted()Description copied from interface:BlinkIdOverlayView
Called when scanning of the second side starts.- Specified by:
onSecondSideScanStarted
in interfaceBlinkIdOverlayView
-
onMovingCloserToBarcodeRequired
public void onMovingCloserToBarcodeRequired()Description copied from interface:BlinkIdOverlayView
Called when user should be instructed to move closer to barcode.- Specified by:
onMovingCloserToBarcodeRequired
in interfaceBlinkIdOverlayView
-
setRecognizerSupportsClassification
public void setRecognizerSupportsClassification(boolean isClassificationSupported) Description copied from interface:BlinkIdOverlayView
If true, this means that recognizer supports classification andBlinkIdOverlayView.onDocumentClassified()
will be called when the document is classified.- Specified by:
setRecognizerSupportsClassification
in interfaceBlinkIdOverlayView
- Parameters:
isClassificationSupported
- true if classification is supported
-
onScanSuccess
public long onScanSuccess()Description copied from interface:BlinkIdOverlayView
Called when both sides are scanned. If you wish to animate success state, return delay in milliseconds and overlay controller will wait before reporting that scanning is done.- Specified by:
onScanSuccess
in interfaceBlinkIdOverlayView
- Returns:
- delay in milliseconds
-
onCardDetectionUpdate
Description copied from interface:BlinkIdOverlayView
Called on any update to card detection process.- Specified by:
onCardDetectionUpdate
in interfaceBlinkIdOverlayView
-
reticleOverlayStringsSetup
protected void reticleOverlayStringsSetup(android.app.Activity activity) -
detectionStatusToReticleState
protected android.util.Pair<ReticleUiState,String> detectionStatusToReticleState(DetectionStatus detectionStatus) -
onProcessingError
Description copied from interface:BlinkIdOverlayView
Called when processing error, which should be displayed to the user, occurs.- Specified by:
onProcessingError
in interfaceBlinkIdOverlayView
- Parameters:
processingError
- processing error type.
-
onErrorDialogShown
public void onErrorDialogShown()Description copied from interface:BlinkIdOverlayView
Called when error dialog is shown. Make sure to stop animations here.- Specified by:
onErrorDialogShown
in interfaceBlinkIdOverlayView
-
onGlare
public void onGlare(boolean hasGlare) Description copied from interface:BlinkIdOverlayView
Called on glare detection update.- Specified by:
onGlare
in interfaceBlinkIdOverlayView
- Parameters:
hasGlare
- true if glare detected
-
onTorchStateChanged
public void onTorchStateChanged(boolean torchOn) Description copied from interface:BlinkIdOverlayView
Called when torch (flashlight) state is updated.- Specified by:
onTorchStateChanged
in interfaceBlinkIdOverlayView
- Parameters:
torchOn
-true
if torch is turned on,false
otherwise.
-
cleanup
public void cleanup()Description copied from interface:BlinkIdOverlayView
Clean up your resources here.- Specified by:
cleanup
in interfaceBlinkIdOverlayView
-
setScanRecognitionModeOverlay
Description copied from interface:BlinkIdOverlayView
Sets recognition mode used for onboarding overlay resources selection.- Specified by:
setScanRecognitionModeOverlay
in interfaceBlinkIdOverlayView
- Parameters:
scanRecognitionMode
- required for onboarding overlay resources selection
-
getDocumentNotSupportedDialogStrings
- Specified by:
getDocumentNotSupportedDialogStrings
in interfaceBlinkIdOverlayView
- Returns:
- strings to be used for error dialog shown when document is not supported
-
getRecognitionTimeoutDialogStrings
- Specified by:
getRecognitionTimeoutDialogStrings
in interfaceBlinkIdOverlayView
- Returns:
- strings to be used for error dialog shown when second document side can't be recognized
-
getSidesNotMatchingDialogStrings
- Specified by:
getSidesNotMatchingDialogStrings
in interfaceBlinkIdOverlayView
- Returns:
- strings to be used for error dialog shown when data from the second document side doesn't match the data from the first side
-
getDataMismatchStrings
- Specified by:
getDataMismatchStrings
in interfaceBlinkIdOverlayView
- Returns:
- strings to be used for error dialog shown when scanned document has data mismatch
-
setShowBackSideBarcodeInstructions
public void setShowBackSideBarcodeInstructions(boolean shouldShow) Description copied from interface:BlinkIdOverlayView
Set whether to show additional instructions when scanning back side of the document instructing user to scan the barcode.- Specified by:
setShowBackSideBarcodeInstructions
in interfaceBlinkIdOverlayView
- Parameters:
shouldShow
- true if barcode instructions should be shown
-
onDocumentClassified
public void onDocumentClassified()Description copied from interface:BlinkIdOverlayView
Called when document is successfully classified and recognition starts.- Specified by:
onDocumentClassified
in interfaceBlinkIdOverlayView
-
changeStateIfRequired
-
changeState
-
shouldStayInCurrentState
-
setMandatoryFieldsMissingTooltipText
public void setMandatoryFieldsMissingTooltipText(int[] stringRes, android.app.Activity activity) - Specified by:
setMandatoryFieldsMissingTooltipText
in interfaceBlinkIdOverlayView
-
currentStateDuration
protected long currentStateDuration()
-