net.gini.android.vision.camera

Interface CameraFragmentInterface

All Known Implementing Classes:

CameraActivity, CameraFragmentCompat, CameraFragmentStandard

public interface CameraFragmentInterface

Methods which both Camera Fragments must implement.

Method Summary

Modifier and Type	Method and Description
void	hideActivityIndicatorAndEnableInteraction() Call this method to hide the activity indicator and enable user interaction.
void	hideCameraTriggerButton() Deprecated. Use CameraFragmentInterface.hideInterface() instead.
void	hideDocumentCornerGuides() Deprecated. Use CameraFragmentInterface.hideInterface() instead.
void	hideInterface() Call this method to hide the interface elements.
void	setListener(CameraFragmentListener listener) Set a listener for camera events.
void	showActivityIndicatorAndDisableInteraction() Call this method to show an activity indicator and disable user interaction.
void	showCameraTriggerButton() Deprecated. Use CameraFragmentInterface.showInterface() instead.
void	showDocumentCornerGuides() Deprecated. Use CameraFragmentInterface.showInterface() instead.
void	showError(java.lang.String message, int duration) Call this method to show an error message to the user in the Camera Screen.
void	showInterface() Call this method to show the interface elements.

Method Detail

setListener

void setListener(CameraFragmentListener listener)

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.

Note: the listener is expected to be available until the fragment is attached to an activity. Make sure to set the listener before that.

Parameters:

listener - the CameraFragmentListener instance

showDocumentCornerGuides

@Deprecated
void showDocumentCornerGuides()

Deprecated. Use CameraFragmentInterface.showInterface() instead.

Call this method to show the document corner guides.

Note: the document corner guides are shown by default.

hideDocumentCornerGuides

@Deprecated
void hideDocumentCornerGuides()

Deprecated. Use CameraFragmentInterface.hideInterface() instead.

Call this method to hide the document corner guides.

Note: the document corner guides are shown by default.

showCameraTriggerButton

@Deprecated
void showCameraTriggerButton()

Deprecated. Use CameraFragmentInterface.showInterface() instead.

Call this method to show the camera trigger button.

Note: the camera trigger button is shown by default.

hideCameraTriggerButton

@Deprecated
void hideCameraTriggerButton()

Deprecated. Use CameraFragmentInterface.hideInterface() instead.

Call this method to hide the camera trigger button.

Note: the camera trigger button is shown by default.

showInterface

void showInterface()

Call this method to show the interface elements. The camera preview is always visible.

Note: the interface elements are shown by default.

hideInterface

void hideInterface()

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

Note: the interface elements are shown by default.

showActivityIndicatorAndDisableInteraction

void showActivityIndicatorAndDisableInteraction()

Call this method to show an activity indicator and disable user interaction. The camera preview remains visible.

hideActivityIndicatorAndEnableInteraction

void hideActivityIndicatorAndEnableInteraction()

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

showError

void showError(java.lang.String message,
               int duration)

Call this method to show an error message to the user in the Camera Screen.

Parameters:

message - a short error message

duration - how long should the error message be shown in ms