Interface BlinkCardOverlayView
- All Known Implementing Classes:
BlinkCardReticleOverlayView
public interface BlinkCardOverlayView
-
Method Summary
Modifier and TypeMethodDescriptionvoid
cleanup()
Clean up your resources here.android.view.ViewGroup
createLayout
(android.app.Activity activity, RecognizerRunnerView recognizerRunnerView) Inflate your custom layout layout herecreateTorchController
(RecognizerRunnerView recognizerRunnerView) Return properly set-up torch controller or null if torch is handled by the activity.void
Manual entry button should be disabled/hidden from the UI.void
enableManualEntryButton
(android.view.View.OnClickListener onClickListener) Manual entry button should be enabled/shown in the UI.void
onCardDetectionUpdate
(DetectionStatus status) Called on any update to card detection process.void
onConfigurationChanged
(int newHostScreenOrientation) Called when host's screen orientation is changed.void
Called when error dialog is shown.void
Called when scanning of the first side starts.void
Called after each frame has been processedlong
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.
-
Method Details
-
createLayout
@NonNull android.view.ViewGroup createLayout(@NonNull android.app.Activity activity, @NonNull RecognizerRunnerView recognizerRunnerView) Inflate your custom layout layout here- Parameters:
activity
- current activity- Returns:
- root view of your custom layout
-
onConfigurationChanged
void onConfigurationChanged(int newHostScreenOrientation) Called when host's screen orientation is changed.- 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
Return properly set-up torch controller or null if torch is handled by the activity.- Parameters:
recognizerRunnerView
- required for torch controller setup- Returns:
- torch controller
-
onFirstSideScanStarted
void onFirstSideScanStarted()Called when scanning of the first side starts. -
onSecondSideScanStarted
void onSecondSideScanStarted()Called when scanning of the second side starts. -
cleanup
void cleanup()Clean up your resources here. -
onScanSuccess
long onScanSuccess()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.- Returns:
- delay in milliseconds
-
onErrorDialogShown
void onErrorDialogShown()Called when error dialog is shown. Make sure to stop animations here. -
enableManualEntryButton
void enableManualEntryButton(android.view.View.OnClickListener onClickListener) Manual entry button should be enabled/shown in the UI.- Parameters:
onClickListener
- listener to register to manual entry button
-
disableManualEntryButton
void disableManualEntryButton()Manual entry button should be disabled/hidden from the UI. -
onTorchStateChanged
void onTorchStateChanged(boolean torchOn) Called when torch (flashlight) state is updated.- Parameters:
torchOn
-true
if torch is turned on,false
otherwise.
-
onCardDetectionUpdate
Called on any update to card detection process. -
onFrameProcessingStatus
Called after each frame has been processed- Parameters:
status
- latest frame processing status
-
getOnboardingView
-
getRecognitionTimeoutDialogStrings
- Returns:
- strings to be used for error dialog shown when second document side can't be recognized
-