Package com.microblink.photopay.fragment.overlay.basic

Class BasicOverlayController

java.lang.Object

com.microblink.photopay.fragment.overlay.BaseOverlayController

com.microblink.photopay.fragment.overlay.basic.BasicOverlayController

All Implemented Interfaces:

ScanningOverlay, ScanResultListener

public final class BasicOverlayController
extends BaseOverlayController

Overlay controller to be used for simplest scanning scenarios. How it looks and works can be configured using BasicOverlaySettings.

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
BasicOverlayController(BasicOverlaySettings overlaySettings, ScanResultListener scanResultListener)

Method Summary

Modifier and Type	Method	Description
protected int	getBeepSoundResourceId()
HighResImagesBundle	getHighResImagesBundle()
protected int	getSplashScreenLayoutId()
void	onCameraAutofocusFailed()
protected void	onFragmentConfigurationChanged(android.content.res.Configuration newConfig)
protected void	onFragmentResumed()
protected void	onFragmentSaveInstanceState(android.os.Bundle outState)
void	onRecognizerRunnerViewCreated(RecognizerRunnerFragment recognizerRunnerFragment)	Called when RecognizerRunnerView has been created within given RecognizerRunnerFragment.
final void	onScanningDone(RecognitionSuccessType recognitionSuccessType)	This method is called when recognition is done.
protected boolean	shouldResetStateOnRecognizerResume()

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

getContext, onFragmentCreated, onFragmentDestroyed, 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 Details

BasicOverlayController

public BasicOverlayController(@NonNull
 BasicOverlaySettings overlaySettings,
 @NonNull
 ScanResultListener scanResultListener)

Method Details

getHighResImagesBundle

@AnyThread
@NonNull
public HighResImagesBundle getHighResImagesBundle()

getSplashScreenLayoutId

protected int getSplashScreenLayoutId()

Specified by:

getSplashScreenLayoutId in class BaseOverlayController

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

onScanningDone

public final 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.

Parameters:

recognitionSuccessType - indicates the success type of recognition

onFragmentResumed

protected void onFragmentResumed()

Overrides:

onFragmentResumed 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

public void onCameraAutofocusFailed()

Overrides:

onCameraAutofocusFailed in class BaseOverlayController