com.microblink.blinkinput.fragment.overlay.documentcapture

Class DocumentCaptureOverlayController

java.lang.Object

com.microblink.blinkinput.fragment.overlay.BaseOverlayController

com.microblink.blinkinput.fragment.overlay.documentcapture.DocumentCaptureOverlayController

All Implemented Interfaces:

DocumentCaptureContract.OverlayController, ScanningOverlay, ScanResultListener

public class DocumentCaptureOverlayController
extends BaseOverlayController
implements DocumentCaptureContract.OverlayController

Field Summary

Fields inherited from class com.microblink.blinkinput.fragment.overlay.BaseOverlayController

errorDialog, handler, overlayState, recognizerRunnerFragment, recognizerRunnerView, scanResultListener, scanSoundPlayer, torchController

Constructor Summary

Constructors

Constructor and Description
DocumentCaptureOverlayController(DocumentCaptureOverlaySettings overlaySettings, ScanResultListener scanResultListener, DocumentCaptureContract.OverlayView overlayView) Pass in your own implementation of DocumentCaptureContract.OverlayView to customise UI, or use our overlay view DetectionOverlayView.

Method Summary

Modifier and Type	Method and Description
protected int	getBeepSoundResourceId()
protected int	getSplashScreenLayoutId()
void	onBackButtonClicked() Called when back button is clicked in the view.
protected void	onCameraAutofocusFailed()
void	onCaptureButtonClicked() Called when image capture button is clicked in the view.
protected void	onFragmentConfigurationChanged(android.content.res.Configuration newConfig)
protected void	onFragmentDestroyed()
protected void	onFragmentResumed()
protected void	onFragmentSaveInstanceState(android.os.Bundle outState)
void	onRecognizerRunnerViewCreated(RecognizerRunnerFragment recognizerRunnerFragment) Called when RecognizerRunnerView has been created within given RecognizerRunnerFragment.
void	onScanningDone(RecognitionSuccessType recognitionSuccessType) This method is called when recognition is done.
void	onTorchButtonClicked() Called when torch button is clicked in the view.
void	resumeScanningAfterScanningDone()
void	setTorchStateListener(OverlayTorchStateListener torchStateListener) Sets the torch state listener that will be notified when torch state is changed.
protected boolean	shouldResetStateOnRecognizerResume()

Methods inherited from class com.microblink.blinkinput.fragment.overlay.BaseOverlayController

getContext, onFragmentCreated, onFragmentPaused, onFragmentStarted, onFragmentStopped, onFrameRecognitionDone, onRecognizerRunnerFragmentAttached, onUnrecoverableError, pauseScanning, resumeScanning, setMeteringAreas

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentCaptureOverlayController

public DocumentCaptureOverlayController(@NonNull
                                        DocumentCaptureOverlaySettings overlaySettings,
                                        @NonNull
                                        ScanResultListener scanResultListener,
                                        @NonNull
                                        DocumentCaptureContract.OverlayView overlayView)

Pass in your own implementation of DocumentCaptureContract.OverlayView to customise UI, or use our overlay view DetectionOverlayView.

Parameters:

overlaySettings - overlay settings

scanResultListener - listener to be notified when scanning is done

overlayView - custom UI implementation

Method Detail

onRecognizerRunnerViewCreated

public void onRecognizerRunnerViewCreated(@NonNull
                                          RecognizerRunnerFragment recognizerRunnerFragment)

Description copied from interface: ScanningOverlay

Called when RecognizerRunnerView has been created within given RecognizerRunnerFragment. You can use RecognizerRunnerFragment.getRecognizerRunnerView() to get the created RecognizerRunnerView and configure it. The most important thing you should do in this method is to set RecognizerBundle to created RecognizerRunnerView using RecognizerRunnerView.setRecognizerBundle(RecognizerBundle). You can also register various callbacks to RecognizerRunnerView, except CameraEventsListener (using BaseCameraView.setCameraEventsListener(CameraEventsListener)) and ScanResultListener (using RecognizerRunnerView.setScanResultListener(ScanResultListener) - those two listeners will be set to RecognizerRunnerView within RecognizerRunnerFragment after calling this method - if you need to observe camera events within RecognizerRunnerFragment, you can set your own BaseCameraEventsListener to it with RecognizerRunnerFragment.setCameraEventsListener(BaseCameraEventsListener). In this method, you can also access RecognizerRunnerFragment's content layout with method RecognizerRunnerFragment.getContentLayout() and add your views to it.

Specified by:

onRecognizerRunnerViewCreated in interface ScanningOverlay

Overrides:

onRecognizerRunnerViewCreated in class BaseOverlayController

Parameters:

recognizerRunnerFragment - RecognizerRunnerFragment within which RecognizerRunnerView has been created.

shouldResetStateOnRecognizerResume

protected boolean shouldResetStateOnRecognizerResume()

Specified by:

shouldResetStateOnRecognizerResume in class BaseOverlayController

getBeepSoundResourceId

protected int getBeepSoundResourceId()

Specified by:

getBeepSoundResourceId in class BaseOverlayController

getSplashScreenLayoutId

protected int getSplashScreenLayoutId()

Specified by:

getSplashScreenLayoutId in class BaseOverlayController

onScanningDone

public void onScanningDone(@NonNull
                           RecognitionSuccessType recognitionSuccessType)

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.

Specified by:

onScanningDone in interface ScanResultListener

Parameters:

recognitionSuccessType - indicates the success type of recognition

onFragmentResumed

protected void onFragmentResumed()

Overrides:

onFragmentResumed in class BaseOverlayController

onFragmentDestroyed

protected void onFragmentDestroyed()

Overrides:

onFragmentDestroyed in class BaseOverlayController

onFragmentConfigurationChanged

protected void onFragmentConfigurationChanged(@NonNull
                                              android.content.res.Configuration newConfig)

Overrides:

onFragmentConfigurationChanged in class BaseOverlayController

onFragmentSaveInstanceState

protected void onFragmentSaveInstanceState(@Nullable
                                           android.os.Bundle outState)

Overrides:

onFragmentSaveInstanceState in class BaseOverlayController

onCameraAutofocusFailed

protected void onCameraAutofocusFailed()

Overrides:

onCameraAutofocusFailed in class BaseOverlayController

setTorchStateListener

public void setTorchStateListener(OverlayTorchStateListener torchStateListener)

Sets the torch state listener that will be notified when torch state is changed.

Parameters:

torchStateListener - torch state listener that will be notified when torch state is changed.

onCaptureButtonClicked

public void onCaptureButtonClicked()

Description copied from interface: DocumentCaptureContract.OverlayController

Called when image capture button is clicked in the view.

Specified by:

onCaptureButtonClicked in interface DocumentCaptureContract.OverlayController

resumeScanningAfterScanningDone

public void resumeScanningAfterScanningDone()

onBackButtonClicked

public void onBackButtonClicked()

Description copied from interface: DocumentCaptureContract.OverlayController

Called when back button is clicked in the view.

Specified by:

onBackButtonClicked in interface DocumentCaptureContract.OverlayController

onTorchButtonClicked

public void onTorchButtonClicked()

Description copied from interface: DocumentCaptureContract.OverlayController

Called when torch button is clicked in the view.

Specified by:

onTorchButtonClicked in interface DocumentCaptureContract.OverlayController