com.yoti.mobile.android.scan

Class ScannerViewNoUIFragment

java.lang.Object

androidx.fragment.app.Fragment

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

com.yoti.mobile.android.scan.ScannerViewNoUIFragment

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, ScannerValidator.ScannerCoreListener

public class ScannerViewNoUIFragment
extends com.yoti.mobile.android.camera.ui.CameraPreviewFragment
implements ScannerValidator.ScannerCoreListener

Self-contained fragment for scanning for QR codes from the camera. This fragment must be created using the #init method with appropriate parameters. Once created, it can be attached and used as any other fragment.

Activities hosting this fragment must implement the OnQrCodeFoundListener interface. This provides a single callback when a QR code is found and read. When called, the camera will be paused on the captured code and to restart the capture using #restart.

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 inherited from class com.yoti.mobile.android.camera.ui.CameraPreviewFragment

CAMERA_BUFFERS_REQUIRED, mCamera, mCameraFocusHelper, mCameraPreview

Constructor Summary

Constructors

Constructor and Description
ScannerViewNoUIFragment()

Method Summary

Modifier and Type	Method and Description
protected android.view.ViewGroup	getCameraViewContainer()
protected int	getNumCameraBuffers()
static ScannerViewNoUIFragment	init(boolean disableAutomaticCameraStartStop)
void	onAttach(android.app.Activity activity)
protected void	onCameraPreviewReady()
void	onCodeDetected(java.lang.String data) Called after #processFrameAr when exactly one QR code is detected in the current image.
void	onCodeDetectionFailed(int errorStatus) Called after #processFrameAr or in response to sensor changes when one or more error conditions are met.
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)
void	onDestroy()
void	onDetach()
void	onPause()
protected void	onPreviewFrame(byte[] data)
void	onResume()
void	onShowScanningInstructions()
void	onViewCreated(android.view.View view, android.os.Bundle savedInstanceState)
void	recycleBuffer(byte[] buffer) Called when a frame previously supplied by #processFrameAr is no longer referenced, so can be released.
void	restart()
void	setQrCodeFoundListener(OnQrCodeFoundListener qrCodeFoundListener)
protected boolean	shouldDisableAutomaticCameraStartStop() It will be called in CameraPreviewFragment.onResume() and CameraPreviewFragment.onPause() to determine whether the creation of camera should be handled automatically.
void	startCamera() Starts the camera and the the cancel continuous focus timer.
void	stopCamera() Stops the camera and the the cancel continuous focus timer.

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

disableContinuousAutoFocus, generateHapticFeedback, initCamera, isContinuousAutoFocus, onCameraOpen, onCameraOpenFailed, onCameraPreviewCreated, releaseCamera, releaseCameraBuffer, setLowResPreview, 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, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreate, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroyOptionsMenu, onDestroyView, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, onSaveInstanceState, onStart, onStop, 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

Constructor Detail

ScannerViewNoUIFragment

public ScannerViewNoUIFragment()

Method Detail

init

public static ScannerViewNoUIFragment init(boolean disableAutomaticCameraStartStop)

setQrCodeFoundListener

public void setQrCodeFoundListener(OnQrCodeFoundListener qrCodeFoundListener)

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

onViewCreated

public void onViewCreated(@NonNull
                          android.view.View view,
                          @Nullable
                          android.os.Bundle savedInstanceState)

Overrides:

onViewCreated in class androidx.fragment.app.Fragment

startCamera

public void startCamera()
                 throws java.lang.IllegalStateException

Starts the camera and the the cancel continuous focus timer. This can only be called if the fragment was initialised with ScannerViewFragment.disableAutomaticCameraStartStop has been set to true. If it has not then an IllegalStateException will be thrown.

Throws:

java.lang.IllegalStateException - When this method is called when the fragment has not been called with ScannerViewFragment.disableAutomaticCameraStartStop set to true

stopCamera

public void stopCamera()

Stops the camera and the the cancel continuous focus timer. This can only be called if the fragment was initialised with ScannerViewFragment.disableAutomaticCameraStartStop has been set to true. If it has not then an IllegalStateException will be thrown.

Throws:

java.lang.IllegalStateException - When this method is called when the fragment has not been called with ScannerViewFragment.disableAutomaticCameraStartStop set to true

onAttach

public void onAttach(android.app.Activity activity)

Overrides:

onAttach in class androidx.fragment.app.Fragment

onDetach

public void onDetach()

Overrides:

onDetach in class androidx.fragment.app.Fragment

onResume

public void onResume()

Overrides:

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

getNumCameraBuffers

protected int getNumCameraBuffers()

Specified by:

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

onPause

public void onPause()

Overrides:

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

getCameraViewContainer

@NonNull
protected android.view.ViewGroup getCameraViewContainer()

Specified by:

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

onPreviewFrame

protected void onPreviewFrame(@NonNull
                              byte[] data)

Specified by:

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

onCameraPreviewReady

protected void onCameraPreviewReady()

Overrides:

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

onCodeDetected

public void onCodeDetected(java.lang.String data)

Description copied from interface: ScannerValidator.ScannerCoreListener

Called after #processFrameAr when exactly one QR code is detected in the current image. The content will be passed as argument.

Specified by:

onCodeDetected in interface ScannerValidator.ScannerCoreListener

onDestroy

public void onDestroy()

Overrides:

onDestroy in class androidx.fragment.app.Fragment

restart

public void restart()

onCodeDetectionFailed

public void onCodeDetectionFailed(int errorStatus)

Description copied from interface: ScannerValidator.ScannerCoreListener

Called after #processFrameAr or in response to sensor changes when one or more error conditions are met.

Specified by:

onCodeDetectionFailed in interface ScannerValidator.ScannerCoreListener

Parameters:

errorStatus - bitmask of sensor or picture errors.

recycleBuffer

public void recycleBuffer(byte[] buffer)

Description copied from interface: ScannerValidator.ScannerCoreListener

Called when a frame previously supplied by #processFrameAr is no longer referenced, so can be released. This is probably only interesting for clients using camera callback buffers. In this case, at least three buffers should be allocated to ensure smooth preview.

Specified by:

recycleBuffer in interface ScannerValidator.ScannerCoreListener

onShowScanningInstructions

public void onShowScanningInstructions()

Specified by:

onShowScanningInstructions in interface ScannerValidator.ScannerCoreListener

shouldDisableAutomaticCameraStartStop

protected boolean shouldDisableAutomaticCameraStartStop()

It will be called in CameraPreviewFragment.onResume() and CameraPreviewFragment.onPause() to determine whether the creation of camera should be handled automatically.

Overrides:

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

See Also:

CameraPreviewFragment.initCamera(), CameraPreviewFragment.releaseCamera()