Class BaseBlinkIdOverlayController
- java.lang.Object
-
- com.microblink.fragment.overlay.BaseOverlayController
-
- com.microblink.fragment.overlay.blinkid.BaseBlinkIdOverlayController
-
- All Implemented Interfaces:
ScanningOverlay
,ScanResultListener
- Direct Known Subclasses:
BlinkIdOverlayController
public abstract class BaseBlinkIdOverlayController extends BaseOverlayController
-
-
Field Summary
Fields Modifier and Type Field Description protected DocumentRecognizerManager
documentRecognizerManager
protected ImageUploadManager
imageUploadManager
-
Fields inherited from class com.microblink.fragment.overlay.BaseOverlayController
errorDialog, handler, overlayState, recognizerRunnerFragment, recognizerRunnerView, scanResultListener, scanSoundPlayer, torchController
-
-
Constructor Summary
Constructors Constructor Description BaseBlinkIdOverlayController(BlinkIdOverlaySettings overlaySettings, ScanResultListener scanResultListener, BlinkIdOverlayView overlayView)
Pass in your own implementation ofBlinkIdOverlayView
to customise the UI, or use one of our overlay views,ReticleOverlayView
,DocumentOverlayView
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract ImageUploadManager
createImageUploadManager()
protected int
getBeepSoundResourceId()
HighResImagesBundle
getHighResImagesBundle()
RecognizerBundle
getRecognizerBundle()
protected int
getSplashScreenLayoutId()
protected void
onCameraAutofocusFailed()
protected void
onDocumentSideChanged(long firstSideDelay)
protected void
onFirstSideScanStarted()
protected void
onFragmentConfigurationChanged(android.content.res.Configuration newConfig)
protected void
onFragmentDestroyed()
protected void
onFragmentPaused()
protected void
onFragmentResumed()
protected void
onFragmentSaveInstanceState(android.os.Bundle outState)
void
onFrameRecognitionDone(RecognitionSuccessType recognitionSuccessType)
Called for each camera frame, after the recognition has been completed.void
onRecognizerRunnerViewCreated(RecognizerRunnerFragment recognizerRunnerFragment)
Called whenRecognizerRunnerView
has been created within givenRecognizerRunnerFragment
.void
onScanningDone(RecognitionSuccessType successType)
This method is called when recognition is done.void
pauseScanning()
If theRecognizerRunnerView
has been created, pauses the scanning loop by callingRecognizerRunnerView.pauseScanning()
.void
resumeScanning()
If theRecognizerRunnerView
has been created, resumes the scanning loop (that has been paused) by callingRecognizerRunnerView.resumeScanning(boolean)
}.protected boolean
shouldResetStateOnRecognizerResume()
-
Methods inherited from class com.microblink.fragment.overlay.BaseOverlayController
getContext, onFragmentCreated, onFragmentStarted, onFragmentStopped, onRecognizerRunnerFragmentAttached, onUnrecoverableError, setMeteringAreas
-
-
-
-
Field Detail
-
documentRecognizerManager
@NonNull protected final DocumentRecognizerManager documentRecognizerManager
-
imageUploadManager
@NonNull protected ImageUploadManager imageUploadManager
-
-
Constructor Detail
-
BaseBlinkIdOverlayController
public BaseBlinkIdOverlayController(@NonNull BlinkIdOverlaySettings overlaySettings, @NonNull ScanResultListener scanResultListener, @NonNull BlinkIdOverlayView overlayView)
Pass in your own implementation ofBlinkIdOverlayView
to customise the UI, or use one of our overlay views,ReticleOverlayView
,DocumentOverlayView
- Parameters:
overlaySettings
- configuration settingsscanResultListener
- listener to be notified when scanning is doneoverlayView
- custom UI implementation
-
-
Method Detail
-
getHighResImagesBundle
@AnyThread @NonNull public HighResImagesBundle getHighResImagesBundle()
-
getRecognizerBundle
@AnyThread @NonNull public RecognizerBundle getRecognizerBundle()
-
onScanningDone
public void onScanningDone(@NonNull RecognitionSuccessType successType)
Description copied from interface:ScanResultListener
This method is called when recognition is done. This method might be called on background thread or main thread, depending on the type of scan.- Parameters:
successType
- indicates the success type of recognition
-
onFrameRecognitionDone
public void onFrameRecognitionDone(RecognitionSuccessType recognitionSuccessType)
Description copied from interface:ScanningOverlay
Called for each camera frame, after the recognition has been completed.- Specified by:
onFrameRecognitionDone
in interfaceScanningOverlay
- Overrides:
onFrameRecognitionDone
in classBaseOverlayController
- Parameters:
recognitionSuccessType
- frame recognition status.
-
onRecognizerRunnerViewCreated
public void onRecognizerRunnerViewCreated(@NonNull RecognizerRunnerFragment recognizerRunnerFragment)
Description copied from interface:ScanningOverlay
Called whenRecognizerRunnerView
has been created within givenRecognizerRunnerFragment
. You can useRecognizerRunnerFragment.getRecognizerRunnerView()
to get the createdRecognizerRunnerView
and configure it. The most important thing you should do in this method is to setRecognizerBundle
to createdRecognizerRunnerView
usingRecognizerRunnerView.setRecognizerBundle(RecognizerBundle)
. You can also register various callbacks toRecognizerRunnerView
, exceptCameraEventsListener
(usingBaseCameraView.setCameraEventsListener(CameraEventsListener)
) andScanResultListener
(usingRecognizerRunnerView.setScanResultListener(ScanResultListener)
- those two listeners will be set toRecognizerRunnerView
withinRecognizerRunnerFragment
after calling this method - if you need to observe camera events withinRecognizerRunnerFragment
, you can set your ownBaseCameraEventsListener
to it withRecognizerRunnerFragment.setCameraEventsListener(BaseCameraEventsListener)
. In this method, you can also accessRecognizerRunnerFragment
's content layout with methodRecognizerRunnerFragment.getContentLayout()
and add your views to it.- Specified by:
onRecognizerRunnerViewCreated
in interfaceScanningOverlay
- Overrides:
onRecognizerRunnerViewCreated
in classBaseOverlayController
- Parameters:
recognizerRunnerFragment
-RecognizerRunnerFragment
within whichRecognizerRunnerView
has been created.
-
pauseScanning
public void pauseScanning()
Description copied from interface:ScanningOverlay
If theRecognizerRunnerView
has been created, pauses the scanning loop by callingRecognizerRunnerView.pauseScanning()
. But keeps camera active. If theRecognizerRunnerView
has not been created yet, does nothing.You can resume scanning by calling
ScanningOverlay.resumeScanning()
.- Specified by:
pauseScanning
in interfaceScanningOverlay
- Overrides:
pauseScanning
in classBaseOverlayController
- See Also:
RecognizerRunnerView.pauseScanning()
-
resumeScanning
public void resumeScanning()
Description copied from interface:ScanningOverlay
If theRecognizerRunnerView
has been created, resumes the scanning loop (that has been paused) by callingRecognizerRunnerView.resumeScanning(boolean)
}.If the
RecognizerRunnerView
has not been created yet, does nothing.- Specified by:
resumeScanning
in interfaceScanningOverlay
- Overrides:
resumeScanning
in classBaseOverlayController
- See Also:
RecognizerRunnerView.resumeScanning(boolean)
-
shouldResetStateOnRecognizerResume
protected boolean shouldResetStateOnRecognizerResume()
- Specified by:
shouldResetStateOnRecognizerResume
in classBaseOverlayController
-
getBeepSoundResourceId
protected int getBeepSoundResourceId()
- Specified by:
getBeepSoundResourceId
in classBaseOverlayController
-
getSplashScreenLayoutId
protected int getSplashScreenLayoutId()
- Specified by:
getSplashScreenLayoutId
in classBaseOverlayController
-
createImageUploadManager
protected abstract ImageUploadManager createImageUploadManager()
-
onCameraAutofocusFailed
protected void onCameraAutofocusFailed()
- Overrides:
onCameraAutofocusFailed
in classBaseOverlayController
-
onDocumentSideChanged
@CallSuper protected void onDocumentSideChanged(long firstSideDelay)
-
onFirstSideScanStarted
@CallSuper protected void onFirstSideScanStarted()
-
onFragmentResumed
protected void onFragmentResumed()
- Overrides:
onFragmentResumed
in classBaseOverlayController
-
onFragmentPaused
protected void onFragmentPaused()
- Overrides:
onFragmentPaused
in classBaseOverlayController
-
onFragmentDestroyed
protected void onFragmentDestroyed()
- Overrides:
onFragmentDestroyed
in classBaseOverlayController
-
onFragmentConfigurationChanged
protected void onFragmentConfigurationChanged(@NonNull android.content.res.Configuration newConfig)
- Overrides:
onFragmentConfigurationChanged
in classBaseOverlayController
-
onFragmentSaveInstanceState
protected void onFragmentSaveInstanceState(@Nullable android.os.Bundle outState)
- Overrides:
onFragmentSaveInstanceState
in classBaseOverlayController
-
-