ginivision/net.gini.android.vision.camera/CameraFragmentCompat

CameraFragmentCompat

Component API

{@code CameraFragmentCompat} is the main entry point to the Gini Vision Library when using the Component API with the Android Support Library.

It shows a camera preview with tap-to-focus functionality, a trigger button and an optional flash on/off button. The camera preview also shows document corner guides to which the user should align the document.

If instantiated with createInstance then a button for importing documents is shown next to the trigger button. A hint popup is displayed the first time the Gini Vision Library is used to inform the user about document importing.

For importing documents {@code READ_EXTERNAL_STORAGE} permission is required and if the permission is not granted the Gini Vision Library will prompt the user to grant the permission. See @ { code Customizing the Camera Screen } on how to override the message and button titles for the rationale and on permission denial alerts.

Note: Your Activity hosting this Fragment must extend the and use an AppCompat Theme.

Include the {@code CameraFragmentCompat} into your layout either directly with {@code } in your Activity's layout or using the androidx.fragment.app.FragmentManager and one of the {@code createInstance()} methods.

A CameraFragmentListener instance must be available until the {@code * CameraFragmentCompat} is attached to an activity. Failing to do so will throw an exception. The listener instance can be provided either implicitly by making the hosting Activity implement the CameraFragmentListener interface or explicitly by setting the listener using .

Your Activity is automatically set as the listener in onAttach .

Customizing the Camera Screen

See the CameraActivity for details.

public class CameraFragmentCompat extends Fragment implements CameraFragmentInterface, FragmentImplCallback

Functions

callStartTransitionListener

androidJvm

void callStartTransitionListener()

createInstance

androidJvm

static CameraFragmentCompat createInstance()

Factory method for creating a new instance of the Fragment with document import enabled for the specified file types.

static CameraFragmentCompat createInstance(GiniVisionFeatureConfiguration giniVisionFeatureConfiguration)

dump

androidJvm

void dump(String prefix, FileDescriptor fd, PrintWriter writer, Array<String> args)

ensureAnimationInfo

androidJvm

Fragment.AnimationInfo ensureAnimationInfo()

equals

androidJvm

final boolean equals(Object o)

findFragmentByWho

androidJvm

Fragment findFragmentByWho(String who)

getActivity

androidJvm

final FragmentActivity getActivity()

@Nullable()

abstract Activity getActivity()

getAllowEnterTransitionOverlap

androidJvm

boolean getAllowEnterTransitionOverlap()

getAllowReturnTransitionOverlap

androidJvm

boolean getAllowReturnTransitionOverlap()

getAnimatingAway

androidJvm

View getAnimatingAway()

getAnimator

androidJvm

Animator getAnimator()

getArguments

androidJvm

final Bundle getArguments()

getChildFragmentManager

androidJvm

final FragmentManager getChildFragmentManager()

getContext

androidJvm

Context getContext()

getDefaultViewModelProviderFactory

androidJvm

ViewModelProvider.Factory getDefaultViewModelProviderFactory()

getEnterTransition

androidJvm

Object getEnterTransition()

getEnterTransitionCallback

androidJvm

SharedElementCallback getEnterTransitionCallback()

getExitTransition

androidJvm

Object getExitTransition()

getExitTransitionCallback

androidJvm

SharedElementCallback getExitTransitionCallback()

getFragmentManager

androidJvm

final FragmentManager getFragmentManager()

getHost

androidJvm

final Object getHost()

getId

androidJvm

final int getId()

getLayoutInflater

androidJvm

final LayoutInflater getLayoutInflater()

getLifecycle

androidJvm

Lifecycle getLifecycle()

getLoaderManager

androidJvm

LoaderManager getLoaderManager()

getNextAnim

androidJvm

int getNextAnim()

getNextTransition

androidJvm

int getNextTransition()

getParentFragment

androidJvm

final Fragment getParentFragment()

getParentFragmentManager

androidJvm

final FragmentManager getParentFragmentManager()

getReenterTransition

androidJvm

Object getReenterTransition()

getResources

androidJvm

final Resources getResources()

getRetainInstance

androidJvm

final boolean getRetainInstance()

getReturnTransition

androidJvm

Object getReturnTransition()

getSavedStateRegistry

androidJvm

final SavedStateRegistry getSavedStateRegistry()

getSharedElementEnterTransition

androidJvm

Object getSharedElementEnterTransition()

getSharedElementReturnTransition

androidJvm

Object getSharedElementReturnTransition()

getStateAfterAnimating

androidJvm

int getStateAfterAnimating()

getString

androidJvm

final String getString(int resId)

getTag

androidJvm

final String getTag()

getTargetFragment

androidJvm

final Fragment getTargetFragment()

getTargetRequestCode

androidJvm

final int getTargetRequestCode()

getText

androidJvm

final CharSequence getText(int resId)

getUserVisibleHint

androidJvm

boolean getUserVisibleHint()

getView

androidJvm

View getView()

@Nullable()

abstract View getView()

getViewLifecycleOwner

androidJvm

LifecycleOwner getViewLifecycleOwner()

getViewLifecycleOwnerLiveData

androidJvm

LiveData<LifecycleOwner> getViewLifecycleOwnerLiveData()

getViewModelStore

androidJvm

ViewModelStore getViewModelStore()

hashCode

androidJvm

final int hashCode()

hasOptionsMenu

androidJvm

final boolean hasOptionsMenu()

hideActivityIndicatorAndEnableInteraction

androidJvm

Call this method to hide the activity indicator and enable user interaction.

void hideActivityIndicatorAndEnableInteraction()

hideCameraTriggerButton

androidJvm

Call this method to hide the camera trigger button.

Note: the camera trigger button is shown by default.

@Deprecated()

void hideCameraTriggerButton()

hideDocumentCornerGuides

androidJvm

Call this method to hide the document corner guides.

Note: the document corner guides are shown by default.

@Deprecated()

void hideDocumentCornerGuides()

hideInterface

androidJvm

Call this method to hide the interface elements. The camera preview remains visible.

Note: the interface elements are shown by default.

void hideInterface()

initLifecycle

androidJvm

void initLifecycle()

initState

androidJvm

void initState()

instantiate

androidJvm

static Fragment instantiate(Context context, String fname)

isAdded

androidJvm

final boolean isAdded()

isDetached

androidJvm

final boolean isDetached()

isHidden

androidJvm

final boolean isHidden()

isHideReplaced

androidJvm

boolean isHideReplaced()

isInBackStack

androidJvm

final boolean isInBackStack()

isInLayout

androidJvm

final boolean isInLayout()

isMenuVisible

androidJvm

final boolean isMenuVisible()

isPostponed

androidJvm

boolean isPostponed()

isRemoving

androidJvm

final boolean isRemoving()

isRemovingParent

androidJvm

final boolean isRemovingParent()

isResumed

androidJvm

final boolean isResumed()

isStateSaved

androidJvm

final boolean isStateSaved()

isVisible

androidJvm

final boolean isVisible()

noteStateNotSaved

androidJvm

void noteStateNotSaved()

onActivityCreated

androidJvm

void onActivityCreated(Bundle savedInstanceState)

onActivityResult

androidJvm

void onActivityResult(int requestCode, int resultCode, Intent data)

onAttach

androidJvm

void onAttach(Context context)

onAttachFragment

androidJvm

void onAttachFragment(Fragment childFragment)

onConfigurationChanged

androidJvm

void onConfigurationChanged(Configuration newConfig)

onContextItemSelected

androidJvm

boolean onContextItemSelected(MenuItem item)

onCreate

androidJvm

void onCreate(Bundle savedInstanceState)

Internal use only.

void onCreate(Bundle savedInstanceState)

onCreateAnimation

androidJvm

Animation onCreateAnimation(int transit, boolean enter, int nextAnim)

onCreateAnimator

androidJvm

Animator onCreateAnimator(int transit, boolean enter, int nextAnim)

onCreateContextMenu

androidJvm

void onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)

onCreateOptionsMenu

androidJvm

void onCreateOptionsMenu(Menu menu, MenuInflater inflater)

onCreateView

androidJvm

View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

Internal use only.

@Nullable()

View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

onDestroy

androidJvm

void onDestroy()

Internal use only.

void onDestroy()

onDestroyOptionsMenu

androidJvm

void onDestroyOptionsMenu()

onDestroyView

androidJvm

void onDestroyView()

onDetach

androidJvm

void onDetach()

onGetLayoutInflater

androidJvm

LayoutInflater onGetLayoutInflater(Bundle savedInstanceState)

onHiddenChanged

androidJvm

void onHiddenChanged(boolean hidden)

onInflate

androidJvm

void onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState)

onLowMemory

androidJvm

void onLowMemory()

onMultiWindowModeChanged

androidJvm

void onMultiWindowModeChanged(boolean isInMultiWindowMode)

onOptionsItemSelected

androidJvm

boolean onOptionsItemSelected(MenuItem item)

onOptionsMenuClosed

androidJvm

void onOptionsMenuClosed(Menu menu)

onPause

androidJvm

void onPause()

onPictureInPictureModeChanged

androidJvm

void onPictureInPictureModeChanged(boolean isInPictureInPictureMode)

onPrepareOptionsMenu

androidJvm

void onPrepareOptionsMenu(Menu menu)

onPrimaryNavigationFragmentChanged

androidJvm

void onPrimaryNavigationFragmentChanged(boolean isPrimaryNavigationFragment)

onRequestPermissionsResult

androidJvm

void onRequestPermissionsResult(int requestCode, Array<String> permissions, Array<int> grantResults)

onResume

androidJvm

void onResume()

Internal use only.

void onResume()

onSaveInstanceState

androidJvm

void onSaveInstanceState(Bundle outState)

Internal use only.

void onSaveInstanceState(Bundle outState)

onStart

androidJvm

void onStart()

Internal use only.

void onStart()

onStop

androidJvm

void onStop()

Internal use only.

void onStop()

onViewCreated

androidJvm

void onViewCreated(View view, Bundle savedInstanceState)

onViewStateRestored

androidJvm

void onViewStateRestored(Bundle savedInstanceState)

performActivityCreated

androidJvm

void performActivityCreated(Bundle savedInstanceState)

performAttach

androidJvm

void performAttach()

performConfigurationChanged

androidJvm

void performConfigurationChanged(Configuration newConfig)

performContextItemSelected

androidJvm

boolean performContextItemSelected(MenuItem item)

performCreate

androidJvm

void performCreate(Bundle savedInstanceState)

performCreateOptionsMenu

androidJvm

boolean performCreateOptionsMenu(Menu menu, MenuInflater inflater)

performCreateView

androidJvm

void performCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

performDestroy

androidJvm

void performDestroy()

performDestroyView

androidJvm

void performDestroyView()

performDetach

androidJvm

void performDetach()

performGetLayoutInflater

androidJvm

LayoutInflater performGetLayoutInflater(Bundle savedInstanceState)

performLowMemory

androidJvm

void performLowMemory()

performMultiWindowModeChanged

androidJvm

void performMultiWindowModeChanged(boolean isInMultiWindowMode)

performOptionsItemSelected

androidJvm

boolean performOptionsItemSelected(MenuItem item)

performOptionsMenuClosed

androidJvm

void performOptionsMenuClosed(Menu menu)

performPause

androidJvm

void performPause()

performPictureInPictureModeChanged

androidJvm

void performPictureInPictureModeChanged(boolean isInPictureInPictureMode)

performPrepareOptionsMenu

androidJvm

boolean performPrepareOptionsMenu(Menu menu)

performPrimaryNavigationFragmentChanged

androidJvm

void performPrimaryNavigationFragmentChanged()

performResume

androidJvm

void performResume()

performSaveInstanceState

androidJvm

void performSaveInstanceState(Bundle outState)

performStart

androidJvm

void performStart()

performStop

androidJvm

void performStop()

postponeEnterTransition

androidJvm

void postponeEnterTransition()

registerForContextMenu

androidJvm

void registerForContextMenu(View view)

requestPermissions

androidJvm

final void requestPermissions(Array<String> permissions, int requestCode)

requireActivity

androidJvm

final FragmentActivity requireActivity()

requireArguments

androidJvm

final Bundle requireArguments()

requireContext

androidJvm

final Context requireContext()

requireFragmentManager

androidJvm

final FragmentManager requireFragmentManager()

requireHost

androidJvm

final Object requireHost()

requireParentFragment

androidJvm

final Fragment requireParentFragment()

requireView

androidJvm

final View requireView()

restoreChildFragmentState

androidJvm

void restoreChildFragmentState(Bundle savedInstanceState)

restoreViewState

androidJvm

final void restoreViewState(Bundle savedInstanceState)

setAllowEnterTransitionOverlap

androidJvm

void setAllowEnterTransitionOverlap(boolean allow)

setAllowReturnTransitionOverlap

androidJvm

void setAllowReturnTransitionOverlap(boolean allow)

setAnimatingAway

androidJvm

void setAnimatingAway(View view)

setAnimator

androidJvm

void setAnimator(Animator animator)

setArguments

androidJvm

void setArguments(Bundle args)

setEnterSharedElementCallback

androidJvm

void setEnterSharedElementCallback(SharedElementCallback callback)

setEnterTransition

androidJvm

void setEnterTransition(Object transition)

setExitSharedElementCallback

androidJvm

void setExitSharedElementCallback(SharedElementCallback callback)

setExitTransition

androidJvm

void setExitTransition(Object transition)

setHasOptionsMenu

androidJvm

void setHasOptionsMenu(boolean hasMenu)

setHideReplaced

androidJvm

void setHideReplaced(boolean replaced)

setInitialSavedState

androidJvm

void setInitialSavedState(Fragment.SavedState state)

setListener

androidJvm

Set a listener for camera events.

By default the hosting Activity is expected to implement the CameraFragmentListener . In case that is not feasible you may set the listener using this method.