com.yoti.mobile.android.scan

Class CameraPreviewCutoutFragment

java.lang.Object

androidx.fragment.app.Fragment

com.yoti.mobile.android.camera.ui.CameraPreviewFragment

com.yoti.mobile.android.scan.CameraPreviewCutoutFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener, androidx.lifecycle.LifecycleOwner, androidx.lifecycle.ViewModelStoreOwner, androidx.savedstate.SavedStateRegistryOwner, com.yoti.mobile.android.camera.OnCameraOpenListener

Direct Known Subclasses:

ScannerViewFragment

public abstract class CameraPreviewCutoutFragment
extends com.yoti.mobile.android.camera.ui.CameraPreviewFragment

This class is FOR NOW the exact copy of the one you would find in the face module in the package: com.yoti.mobile.android.app.face.ui. It has been duplicated to avoid the dependency towards the face module for the scan module and also becuase the design between the face module and the QR Code will soon be different. so this class will then make perfect sense.

Superclass for fragments which display camera in a portrait circle UI (scan and face).

Subclasses implementing this view need only implement createPresenter() to generate a presenter implementation to handle camera frames. Other important methods subclasses may override are CameraPreviewFragment.onCameraPreviewReady(), if the presenter needs extra setup for camera size and createCameraOverlay(android.view.LayoutInflater, android.view.ViewGroup), if the fragment is displaying extra UI elements, such as a capture button.

Nested Class Summary

Nested classes/interfaces inherited from class androidx.fragment.app.Fragment

androidx.fragment.app.Fragment.InstantiationException, androidx.fragment.app.Fragment.SavedState

Field Summary

Fields

Modifier and Type	Field and Description
static int	TEXT_ID_EMPTY Resource id for empty text

Fields inherited from class com.yoti.mobile.android.camera.ui.CameraPreviewFragment

CAMERA_BUFFERS_REQUIRED, mCamera, mCameraFocusHelper, mCameraPreview

Constructor Summary

Constructors

Constructor and Description
CameraPreviewCutoutFragment(boolean preferFrontCamera)

Method Summary

Modifier and Type	Method and Description
protected void	createCameraOverlay(android.view.LayoutInflater inflater, android.view.ViewGroup rootView) Inflate any UI components which your view should add to the camera.
protected abstract CameraViewPresenter	createPresenter()
protected android.view.ViewGroup	getCameraViewContainer()
void	hideFocusArea()
void	onCameraOpenFailed(java.lang.Throwable throwable)
void	onCreate(android.os.Bundle savedInstanceState)
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)
void	onDestroy()
protected abstract void	onHideScanningInstructionsButtonClick()
void	onPause()
protected void	onPreviewFrame(byte[] data)
void	onResume()
void	restart() Can to restart continuous preview mode and take another picture.
protected void	setScanningInstructionsMessage(int textId)
void	setStatusText(int textId)
void	showFailureFeedback(int feedbackText) Show Fail feedback with message, typically used by Activities to update this fragment.
void	showFocusArea()
protected void	showNoFeedback() Remove feedback previously shown from showFailureFeedback(int)
void	showStaticFrameImage(com.yoti.mobile.android.core.yuvtools.YuvBuffer staticFrame)
protected void	updateOverlayForCameraFailed() Replacement for onCameraOpenFailed(Throwable) which will only be called after overlay has been generated (so don't need to handle uninitialised views).

Methods inherited from class com.yoti.mobile.android.camera.ui.CameraPreviewFragment

disableContinuousAutoFocus, generateHapticFeedback, getNumCameraBuffers, initCamera, isContinuousAutoFocus, onCameraOpen, onCameraPreviewCreated, onCameraPreviewReady, releaseCamera, releaseCameraBuffer, setLowResPreview, shouldDisableAutomaticCameraStartStop, updateFocusArea

Methods inherited from class androidx.fragment.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSavedStateRegistry, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, getViewModelStore, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityCreated, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroyOptionsMenu, onDestroyView, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, onSaveInstanceState, onStart, onStop, onViewCreated, onViewStateRestored, postponeEnterTransition, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireArguments, requireContext, requireFragmentManager, requireHost, requireParentFragment, requireView, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TEXT_ID_EMPTY

@StringRes
public static final int TEXT_ID_EMPTY

Resource id for empty text

See Also:

Constant Field Values

Constructor Detail

CameraPreviewCutoutFragment

public CameraPreviewCutoutFragment(boolean preferFrontCamera)

Method Detail

createPresenter

protected abstract CameraViewPresenter createPresenter()

onHideScanningInstructionsButtonClick

protected abstract void onHideScanningInstructionsButtonClick()

onCreate

public void onCreate(android.os.Bundle savedInstanceState)

Overrides:

onCreate in class androidx.fragment.app.Fragment

onPause

public void onPause()

Overrides:

onPause in class com.yoti.mobile.android.camera.ui.CameraPreviewFragment

onResume

public void onResume()

Overrides:

onResume in class com.yoti.mobile.android.camera.ui.CameraPreviewFragment

onDestroy

public void onDestroy()

Overrides:

onDestroy in class androidx.fragment.app.Fragment

onCreateView

public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                      android.view.ViewGroup container,
                                      android.os.Bundle savedInstanceState)

Overrides:

onCreateView in class androidx.fragment.app.Fragment

showFocusArea

public void showFocusArea()

hideFocusArea

public void hideFocusArea()

onCameraOpenFailed

public final void onCameraOpenFailed(java.lang.Throwable throwable)

Specified by:

onCameraOpenFailed in interface com.yoti.mobile.android.camera.OnCameraOpenListener

Overrides:

onCameraOpenFailed in class com.yoti.mobile.android.camera.ui.CameraPreviewFragment

createCameraOverlay

protected void createCameraOverlay(android.view.LayoutInflater inflater,
                                   android.view.ViewGroup rootView)

Inflate any UI components which your view should add to the camera. Will be called after everything's created, so can also be used to set status e.t.c.

getCameraViewContainer

@NonNull
protected android.view.ViewGroup getCameraViewContainer()

Specified by:

getCameraViewContainer in class com.yoti.mobile.android.camera.ui.CameraPreviewFragment

onPreviewFrame

protected void onPreviewFrame(byte[] data)

Specified by:

onPreviewFrame in class com.yoti.mobile.android.camera.ui.CameraPreviewFragment

showFailureFeedback

public void showFailureFeedback(@StringRes
                                int feedbackText)

Show Fail feedback with message, typically used by Activities to update this fragment.

Parameters:

feedbackText - text to show, or TEXT_ID_EMPTY

showNoFeedback

protected void showNoFeedback()

Remove feedback previously shown from showFailureFeedback(int)

setScanningInstructionsMessage

protected void setScanningInstructionsMessage(@StringRes
                                              int textId)

setStatusText

public void setStatusText(int textId)

showStaticFrameImage

public void showStaticFrameImage(com.yoti.mobile.android.core.yuvtools.YuvBuffer staticFrame)

restart

public void restart()

Can to restart continuous preview mode and take another picture.

updateOverlayForCameraFailed

protected void updateOverlayForCameraFailed()

Replacement for onCameraOpenFailed(Throwable) which will only be called after overlay has been generated (so don't need to handle uninitialised views).