CameraActivity (Gini Vision Library for Android)

java.lang.Object
- AppCompatActivity
- - net.gini.android.vision.camera.CameraActivity

All Implemented Interfaces:

CameraFragmentInterface, CameraFragmentListener
```
public class CameraActivity
extends AppCompatActivity
implements CameraFragmentListener, CameraFragmentInterface
```
Screen API

CameraActivity is the main entry point to the Gini Vision Library when using the Screen API.
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.
On tablets in landscape orientation the camera trigger button is shown on the right side of the screen for easier access.
If you enabled document import with GiniVision.Builder#setDocumentImportEnabledFileTypes(DocumentImportEnabledFileTypes) 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 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 Customizing the Camera Screen on how to override the message and button titles for the rationale and on permission denial alerts.
Start the CameraActivity with android.app.Activity#startActivityForResult(Intent, int) to receive the extractions or a GiniVisionError in case there was an error.
These formerly mandatory extras have been deprecated. Still required if GiniVision is not used:
- CameraActivity.EXTRA_IN_REVIEW_ACTIVITY - use the CameraActivity.setReviewActivityExtra(Intent, Context, Class) helper to set it. Must contain an explicit Intent to the ReviewActivity subclass from your application
- CameraActivity.EXTRA_IN_ANALYSIS_ACTIVITY - use the CameraActivity.setAnalysisActivityExtra(Intent, Context, Class) helper to set it. Must contain an explicit Intent to the AnalysisActivity subclass from your application
These optional extras have been deprecated. Should be set only if GiniVision is not used:
- CameraActivity.EXTRA_IN_SHOW_ONBOARDING_AT_FIRST_RUN - the Onboarding Screen is shown by default the first time the Gini Vision Library is started. You may disable it by setting this extra to false - we highly recommend keeping the default behavior
- CameraActivity.EXTRA_IN_SHOW_ONBOARDING - if set to true the Onboarding Screen is shown when the Gini Vision Library is started
- CameraActivity.EXTRA_IN_ONBOARDING_PAGES - custom pages for the Onboarding Screen as an ArrayList containing OnboardingPage objects
- Deprecated CameraActivity.EXTRA_IN_BACK_BUTTON_SHOULD_CLOSE_LIBRARY - if set to true the back button closes the Gini Vision Library from any of its activities with result code CameraActivity#RESULT_CANCELED
- CameraActivity.EXTRA_IN_GINI_VISION_FEATURE_CONFIGURATION - must contain a GiniVisionFeatureConfiguration instance to apply the feature configuration
The following result codes need to be handled:
- CameraActivity#RESULT_OK - image of a document was taken, reviewed and analyzed
- CameraActivity#RESULT_CANCELED - image of document was not taken, user canceled the Gini Vision Library
- CameraActivity.RESULT_ERROR - an error occured
Result extra returned by the CameraActivity:
- CameraActivity.EXTRA_OUT_EXTRACTIONS - set when result is CameraActivity#RESULT_OK, contains a Bundle with the extraction labels as keys and GiniVisionSpecificExtraction as values.
- CameraActivity.EXTRA_OUT_ERROR - set when result is CameraActivity.RESULT_ERROR, contains a GiniVisionError object detailing what went wrong
Note: For returning the extractions from the Gini API you can add your own extras in ReviewActivity.onAddDataToResult(Intent) or AnalysisActivity.onAddDataToResult(Intent).
If the camera could not be opened due to missing permissions, the content of the Camera Screen is replaced with a no-camera icon, a short message and an optional button. The button is shown only on Android 6.0+ and tapping the button leads the user to the Application Details page in the Settings. If these are shown on Android 5.0 and earlier means that the camera permission was not declared in your manifest.
Customizing the Camera Screen

Customizing the look of the Camera Screen is done via overriding of app resources.
The following items are customizable:
- Document corner guides: via the color resource named gv_camera_preview_corners
- Camera trigger button: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_camera_trigger_default.png and gv_camera_trigger_pressed.png
- Document import button: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_document_import_icon.png
- Document import button subtitle text: via the string resource named gv_camera_document_import_subtitle
- Document import button subtitle text style: via overriding the style named GiniVisionTheme.Camera.DocumentImportSubtitle.TextStyle
- Document import button subtitle font: via overriding the style named GiniVisionTheme.Camera.DocumentImportSubtitle.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- Document import hint background: via the color resource named gv_document_import_hint_background
- Document import hint close icon color: via the color resource name gv_hint_close
- Document import hint text: via the string resource named gv_document_import_hint_text
- Document import hint text size: via overriding the style named GiniVisionTheme.Camera.DocumentImportHint.TextStyle and setting an item named android:textSize with the desired sp size
- Document import hint text color: via the color resource name gv_document_import_hint_text
- Document import hint font: via overriding the style named GiniVisionTheme.Camera.DocumentImportHint.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- Images stack badge text style: via overriding the style named GiniVisionTheme.Camera.ImageStackBadge.TextStyle
- Images stack badge font: via overriding the style named GiniVisionTheme.Camera.ImageStackBadge.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- Images stack badge background colors: via the color resources named gv_camera_image_stack_badge_background and gv_camera_image_stack_badge_background_border
- Images stack badge background size: via the dimension resource named gv_camera_image_stack_badge_size
- Images stack subtitle text: via the string resource named gv_camera_image_stack_subtitle
- Images stack subtitle text style: via overriding the style named GiniVisionTheme.Camera.ImageStackSubtitle.TextStyle
- Images stack subtitle font: via overriding the style named GiniVisionTheme.Camera.ImageStackSubtitle.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- Multi-page document page limit exceeded alert message: via the string resource named gv_document_error_too_many_pages
- Multi-page document page limit exceeded alert positive button text: via the string resource named gv_document_error_multi_page_limit_review_pages_button
- Multi-page document page limit exceeded alert cancel button text: via the string resource named gv_document_error_multi_page_limit_cancel_button
- Read storage permission denied button color: via the color resource named gv_accent
- QRCode detected popup background: via the color resource named gv_qrcode_detected_popup_background
- QRCode detected popup texts: via the string resources named gv_qrcode_detected_popup_message_1 and gv_qrcode_detected_popup_message_2
- QRCode detected popup text sizes: via overriding the styles named GiniVisionTheme.Camera.QRCodeDetectedPopup.Message1.TextStyle and GiniVisionTheme.Camera.QRCodeDetectedPopup.Message2.TextStyle and setting an item named android:textSize with the desired sp size
- QRCode detected popup text colors: via the color resource name gv_qrcode_detected_popup_message_1 and gv_qrcode_detected_popup_message_2
- QRCode detected popup fonts: via overriding the styles named GiniVisionTheme.Camera.QRCodeDetectedPopup.Message1.TextStyle and GiniVisionTheme.Camera.QRCodeDetectedPopup.Message2.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- Read storage permission rationale text: via the string resource named gv_storage_permission_rationale
- Read storage permission rationale positive button text: via the string resource named gv_storage_permission_rationale_positive_button
- Read storage permission rationale negative button text: via the string resource named gv_storage_permission_rationale_negative_button
- Read storage permission rationale button color: via the color resource named gv_accent
- Read storage permission denied text: via the string resource named gv_storage_permission_denied
- Read storage permission denied positive button text: via the string resource named gv_storage_permission_denied_positive_button
- Read storage permission denied negative button text: via the string resource named gv_storage_permission_denied_negative_button
- Read storage permission denied button color: via the color resource named gv_accent
- Tap-to-focus indicator: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_camera_focus_indicator.png
- Help menu item icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_help_icon.png
- Onboarding menu item title: via the string resource named gv_show_onboarding
- Background color: via the color resource named gv_background. Note: this color resource is global to all Activities (CameraActivity, OnboardingActivity, ReviewActivity, AnalysisActivity)
- No-camera icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_no_camera.png
- No camera permission text: via the string resource named gv_camera_error_no_permission
- No camera permission text color: via the color resource named gv_camera_error_no_permission
- No camera permission font: via overriding the style named GiniVisionTheme.Camera.Error.NoPermission.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- No camera permission text style: via overriding the style named GiniVisionTheme.Camera.Error.NoPermission.TextStyle and setting an item named android:textStyle to normal, bold or italic
- No camera permission text size: via overriding the style named GiniVisionTheme.Camera.Error.NoPermission.TextStyle and setting an item named android:textSize to the desired sp size
- No camera permission button title: via the string resource named gv_camera_error_no_permission_button_title
- No camera permission button title color: via the color resources named gv_camera_error_no_permission_button_title and gv_camera_error_no_permission_button_title_pressed
- No camera permission button font: via overriding the style named GiniVisionTheme.Camera.Error.NoPermission.Button.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- No camera permission button text style: via overriding the style named GiniVisionTheme.Camera.Error.NoPermission.Button.TextStyle and setting an item named android:textStyle to normal, bold or italic
- No camera permission button text size: via overriding the style named GiniVisionTheme.Camera.Error.NoPermission.Button.TextStyle and setting an item named android:textSize to the desired sp size
Important: All overriden styles must have their respective Root. prefixed style as their parent. Ex.: the parent of GiniVisionTheme.Camera.Error.NoPermission.TextStyle must be Root.GiniVisionTheme.Camera.Error.NoPermission.TextStyle.
Customizing the Action Bar

Customizing the Action Bar is also done via overriding of app resources and each one - except the title string resource - is global to all Activities (CameraActivity, OnboardingActivity, ReviewActivity, MultiPageReviewActivity, AnalysisActivity).
The following items are customizable:
- Background color: via the color resource named gv_action_bar (highly recommended for Android 5+: customize the status bar color via gv_status_bar)
- Title: via the string resource name gv_title_camera
- Title color: via the color resource named gv_action_bar_title
- Back button: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_action_bar_back

Nested Class Summary
- Nested classes/interfaces inherited from interface net.gini.android.vision.camera.CameraFragmentListener
  CameraFragmentListener.DocumentCheckResultCallback

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`EXTRA_IN_ANALYSIS_ACTIVITY` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the extra called `CameraActivity.EXTRA_OUT_EXTRACTIONS` of the `CameraActivity`'s result Intent.
`static java.lang.String`	`EXTRA_IN_BACK_BUTTON_SHOULD_CLOSE_LIBRARY` Deprecated. The option to close the library with the back button from any screen will be removed in a future version.
`static java.lang.String`	`EXTRA_IN_GINI_VISION_FEATURE_CONFIGURATION` Deprecated. Configuration should be applied by creating a `GiniVision` instance using `GiniVision.newInstance()` and the returned `GiniVision.Builder`.
`static java.lang.String`	`EXTRA_IN_ONBOARDING_PAGES` Deprecated. Configuration should be applied by creating a `GiniVision` instance using `GiniVision.newInstance()` and the returned `GiniVision.Builder`.
`static java.lang.String`	`EXTRA_IN_REVIEW_ACTIVITY` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the extra called `CameraActivity.EXTRA_OUT_EXTRACTIONS` of the `CameraActivity`'s result Intent.
`static java.lang.String`	`EXTRA_IN_SHOW_ONBOARDING` Deprecated. Configuration should be applied by creating a `GiniVision` instance using `GiniVision.newInstance()` and the returned `GiniVision.Builder`.
`static java.lang.String`	`EXTRA_IN_SHOW_ONBOARDING_AT_FIRST_RUN` Deprecated. Configuration should be applied by creating a `GiniVision` instance using `GiniVision.newInstance()` and the returned `GiniVision.Builder`.
`static java.lang.String`	`EXTRA_OUT_ERROR` Returned when the result code is `CameraActivity.RESULT_ERROR` and contains a `GiniVisionError` object detailing what went wrong.
`static java.lang.String`	`EXTRA_OUT_EXTRACTIONS` Returned when extractions are available.
`static int`	`RESULT_ERROR` Returned result code in case something went wrong.

Constructor Summary

Constructors
Constructor and Description

CameraActivity()

Constructors
Constructor and Description
`CameraActivity()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`hideActivityIndicatorAndEnableInteraction()` Call this method to hide the activity indicator and enable user interaction.
`void`	`hideCameraTriggerButton()` Call this method to hide the camera trigger button.
`void`	`hideDocumentCornerGuides()` Call this method to hide the document corner guides.
`void`	`hideInterface()` Call this method to hide the interface elements.
`void`	`onBackPressed()`
`void`	`onCheckImportedDocument(Document document, CameraFragmentListener.DocumentCheckResultCallback callback)` This method is invoked for imported documents to allow custom validations.
`void`	`onDocumentAvailable(Document document)` Called when the user has taken an image with the camera or has imported a document that passed the Gini Vision Library's validation and any custom checks that were implemented.
`void`	`onError(GiniVisionError error)` Called when an error occurred.
`void`	`onExtractionsAvailable(java.util.Map extractions)` Called after a QRCode was successfully analyzed.
`void`	`onProceedToMultiPageReviewScreen(GiniVisionMultiPageDocument multiPageDocument)`
`void`	`onQRCodeAvailable(QRCodeDocument qrCodeDocument)` Called when the user clicked the QR Code detected popup.
`static void`	`setAnalysisActivityExtra(Intent target, Context context, java.lang.Class analysisActivityClass)` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the extra called `CameraActivity.EXTRA_OUT_EXTRACTIONS` of the `CameraActivity`'s result Intent.
`void`	`setListener(CameraFragmentListener listener)` Set a listener for camera events.
`static void`	`setReviewActivityExtra(Intent target, Context context, java.lang.Class reviewActivityClass)` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the extra called `CameraActivity.EXTRA_OUT_EXTRACTIONS` of the `CameraActivity`'s result Intent.
`void`	`showActivityIndicatorAndDisableInteraction()` Call this method to show an activity indicator and disable user interaction.
`void`	`showCameraTriggerButton()` Call this method to show the camera trigger button.
`void`	`showDocumentCornerGuides()` Call this method to show the document corner guides.
`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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXTRA_IN_REVIEW_ACTIVITY
```
public static final java.lang.String EXTRA_IN_REVIEW_ACTIVITY
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the extra called CameraActivity.EXTRA_OUT_EXTRACTIONS of the CameraActivity's result Intent.
    
    Mandatory extra which must contain an explicit Intent to the ReviewActivity subclass from your application.
    
    Use the CameraActivity.setReviewActivityExtra(Intent, Context, Class) helper to set it.
    
    See Also:
    
    Constant Field Values
  - EXTRA_IN_ANALYSIS_ACTIVITY
```
public static final java.lang.String EXTRA_IN_ANALYSIS_ACTIVITY
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the extra called CameraActivity.EXTRA_OUT_EXTRACTIONS of the CameraActivity's result Intent.
    
    Mandatory extra which must contain an explicit Intent to the AnalysisActivity subclass from your application.
    
    Use the CameraActivity.setAnalysisActivityExtra(Intent, Context, Class) helper to set it.
    
    See Also:
    
    Constant Field Values
  - EXTRA_IN_ONBOARDING_PAGES
```
public static final java.lang.String EXTRA_IN_ONBOARDING_PAGES
```
    Deprecated. Configuration should be applied by creating a GiniVision instance using GiniVision.newInstance() and the returned GiniVision.Builder.
    
    Optional extra which must contain an ArrayList with OnboardingPage objects.
    
    See Also:
    
    Constant Field Values
  - EXTRA_IN_SHOW_ONBOARDING_AT_FIRST_RUN
```
public static final java.lang.String EXTRA_IN_SHOW_ONBOARDING_AT_FIRST_RUN
```
    Deprecated. Configuration should be applied by creating a GiniVision instance using GiniVision.newInstance() and the returned GiniVision.Builder.
    
    Optional extra which must contain a boolean and indicates whether the Onboarding Screen should be shown when the Gini Vision Library is started for the first time.
    
    Default value is true.
    
    See Also:
    
    Constant Field Values
  - EXTRA_IN_SHOW_ONBOARDING
```
public static final java.lang.String EXTRA_IN_SHOW_ONBOARDING
```
    Deprecated. Configuration should be applied by creating a GiniVision instance using GiniVision.newInstance() and the returned GiniVision.Builder.
    
    Optional extra which must contain a boolean and indicates whether the Onboarding Screen should be shown when the Gini Vision Library is started.
    
    Default value is false.
    
    See Also:
    
    Constant Field Values
  - EXTRA_IN_BACK_BUTTON_SHOULD_CLOSE_LIBRARY
```
public static final java.lang.String EXTRA_IN_BACK_BUTTON_SHOULD_CLOSE_LIBRARY
```
    Deprecated. The option to close the library with the back button from any screen will be removed in a future version.
    
    Optional extra wich must contain a boolean and indicates whether the back button should close the Gini Vision Library.
    
    Default value is false.
    
    See Also:
    
    Constant Field Values
  - EXTRA_IN_GINI_VISION_FEATURE_CONFIGURATION
```
public static final java.lang.String EXTRA_IN_GINI_VISION_FEATURE_CONFIGURATION
```
    Deprecated. Configuration should be applied by creating a GiniVision instance using GiniVision.newInstance() and the returned GiniVision.Builder.
    
    Optional extra which must contain a GiniVisionFeatureConfiguration instance.
    
    See Also:
    
    Constant Field Values
  - EXTRA_OUT_ERROR
```
public static final java.lang.String EXTRA_OUT_ERROR
```
    Returned when the result code is CameraActivity.RESULT_ERROR and contains a GiniVisionError object detailing what went wrong.
    
    See Also:
    
    Constant Field Values
  - EXTRA_OUT_EXTRACTIONS
```
public static final java.lang.String EXTRA_OUT_EXTRACTIONS
```
    Returned when extractions are available. Contains a Bundle with the extraction labels as keys and GiniVisionSpecificExtraction as values.
    
    See Also:
    
    Constant Field Values
  - RESULT_ERROR
```
public static final int RESULT_ERROR
```
    Returned result code in case something went wrong. You should retrieve the CameraActivity.EXTRA_OUT_ERROR extra to find out what went wrong.
- Constructor Detail
  - CameraActivity
```
public CameraActivity()
```
- Method Detail
  - setReviewActivityExtra
```
@Deprecated
public static void setReviewActivityExtra(Intent target,
                                                      Context context,
                                                      java.lang.Class reviewActivityClass)
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the extra called CameraActivity.EXTRA_OUT_EXTRACTIONS of the CameraActivity's result Intent.
    
    Helper for setting the CameraActivity.EXTRA_IN_REVIEW_ACTIVITY.
    
    Parameters:
    
    target - your explicit Intent used to start the CameraActivity
    
    context - Context used to create the explicit Intent for your ReviewActivity subclass
    
    reviewActivityClass - class of your ReviewActivity subclass
  - setAnalysisActivityExtra
```
@Deprecated
public static void setAnalysisActivityExtra(Intent target,
                                                        Context context,
                                                        java.lang.Class analysisActivityClass)
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the extra called CameraActivity.EXTRA_OUT_EXTRACTIONS of the CameraActivity's result Intent.
    
    Helper for setting the CameraActivity.EXTRA_IN_ANALYSIS_ACTIVITY.
    
    Parameters:
    
    target - your explicit Intent used to start the CameraActivity
    
    context - Context used to create the explicit Intent for your AnalysisActivity subclass
    
    analysisActivityClass - class of your AnalysisActivity subclass
  - onBackPressed
```
public void onBackPressed()
```
  - onDocumentAvailable
```
public void onDocumentAvailable(Document document)
```
    Description copied from interface: CameraFragmentListener
    
    Called when the user has taken an image with the camera or has imported a document that passed the Gini Vision Library's validation and any custom checks that were implemented.
    
    Specified by:
    
    onDocumentAvailable in interface CameraFragmentListener
    
    Parameters:
    
    document - the image taken by the camera or the validated imported document
  - onProceedToMultiPageReviewScreen
```
public void onProceedToMultiPageReviewScreen(GiniVisionMultiPageDocument multiPageDocument)
```
    Specified by:
    
    onProceedToMultiPageReviewScreen in interface CameraFragmentListener
  - onQRCodeAvailable
```
public void onQRCodeAvailable(QRCodeDocument qrCodeDocument)
```
    Description copied from interface: CameraFragmentListener
    
    Called when the user clicked the QR Code detected popup. You should upload the QRCodeDocument's data to the Gini API to get the extractions, close the Gini Vision Library and continue to your app's transfer form.
    
    See QRCodeDocument for supported formats.
    
    Specified by:
    
    onQRCodeAvailable in interface CameraFragmentListener
    
    Parameters:
    
    qrCodeDocument - contains payment data from a QR Code
  - onCheckImportedDocument
```
public void onCheckImportedDocument(Document document,
                                    CameraFragmentListener.DocumentCheckResultCallback callback)
```
    Description copied from interface: CameraFragmentListener
    
    This method is invoked for imported documents to allow custom validations.
    
    Invoke one of the CameraFragmentListener.DocumentCheckResultCallback methods on the main thread to inform the Gini Vision Library about the result.
    
    Note: The Gini Vision Library will wait until one of the CameraFragmentListener.DocumentCheckResultCallback methods are invoked.
    
    Specified by:
    
    onCheckImportedDocument in interface CameraFragmentListener
    
    Parameters:
    
    document - a Document created from the file the user picked
    
    callback - use this callback to inform the Gini Vision Library about the result of the custom checks
  - onError
```
public void onError(GiniVisionError error)
```
    Description copied from interface: CameraFragmentListener
    
    Called when an error occurred.
    
    Specified by:
    
    onError in interface CameraFragmentListener
    
    Parameters:
    
    error - details about what went wrong
  - onExtractionsAvailable
```
public void onExtractionsAvailable(java.util.Map extractions)
```
    Description copied from interface: CameraFragmentListener
    
    Called after a QRCode was successfully analyzed.
    
    Specified by:
    
    onExtractionsAvailable in interface CameraFragmentListener
    
    Parameters:
    
    extractions - a map of the extractions with the extraction labels as keys
  - setListener
```
public void setListener(CameraFragmentListener listener)
```
    Description copied from interface: CameraFragmentInterface
    
    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.
    
    Specified by:
    
    setListener in interface CameraFragmentInterface
    
    Parameters:
    
    listener - the CameraFragmentListener instance
  - showDocumentCornerGuides
```
public void showDocumentCornerGuides()
```
    Description copied from interface: CameraFragmentInterface
    
    Call this method to show the document corner guides.
    
    Note: the document corner guides are shown by default.
    
    Specified by:
    
    showDocumentCornerGuides in interface CameraFragmentInterface
  - hideDocumentCornerGuides
```
public void hideDocumentCornerGuides()
```
    Description copied from interface: CameraFragmentInterface
    
    Call this method to hide the document corner guides.
    
    Note: the document corner guides are shown by default.
    
    Specified by:
    
    hideDocumentCornerGuides in interface CameraFragmentInterface
  - showCameraTriggerButton
```
public void showCameraTriggerButton()
```
    Description copied from interface: CameraFragmentInterface
    
    Call this method to show the camera trigger button.
    
    Note: the camera trigger button is shown by default.
    
    Specified by:
    
    showCameraTriggerButton in interface CameraFragmentInterface
  - hideCameraTriggerButton
```
public void hideCameraTriggerButton()
```
    Description copied from interface: CameraFragmentInterface
    
    Call this method to hide the camera trigger button.
    
    Note: the camera trigger button is shown by default.
    
    Specified by:
    
    hideCameraTriggerButton in interface CameraFragmentInterface
  - showInterface
```
public void showInterface()
```
    Description copied from interface: CameraFragmentInterface
    
    Call this method to show the interface elements. The camera preview is always visible.
    
    Note: the interface elements are shown by default.
    
    Specified by:
    
    showInterface in interface CameraFragmentInterface
  - hideInterface
```
public void hideInterface()
```
    Description copied from interface: CameraFragmentInterface
    
    Call this method to hide the interface elements. The camera preview remains visible.
    
    Note: the interface elements are shown by default.
    
    Specified by:
    
    hideInterface in interface CameraFragmentInterface
  - showActivityIndicatorAndDisableInteraction
```
public void showActivityIndicatorAndDisableInteraction()
```
    Description copied from interface: CameraFragmentInterface
    
    Call this method to show an activity indicator and disable user interaction. The camera preview remains visible.
    
    Specified by:
    
    showActivityIndicatorAndDisableInteraction in interface CameraFragmentInterface
  - hideActivityIndicatorAndEnableInteraction
```
public void hideActivityIndicatorAndEnableInteraction()
```
    Description copied from interface: CameraFragmentInterface
    
    Call this method to hide the activity indicator and enable user interaction.
    
    Specified by:
    
    hideActivityIndicatorAndEnableInteraction in interface CameraFragmentInterface
  - showError
```
public void showError(java.lang.String message,
                      int duration)
```
    Description copied from interface: CameraFragmentInterface
    
    Call this method to show an error message to the user in the Camera Screen.
    
    Specified by:
    
    showError in interface CameraFragmentInterface
    
    Parameters:
    
    message - a short error message
    
    duration - how long should the error message be shown in ms

Class CameraActivity

Screen API

Customizing the Camera Screen

Customizing the Action Bar

Nested Class Summary

Nested classes/interfaces inherited from interface net.gini.android.vision.camera.CameraFragmentListener

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXTRA_IN_REVIEW_ACTIVITY

EXTRA_IN_ANALYSIS_ACTIVITY

EXTRA_IN_ONBOARDING_PAGES

EXTRA_IN_SHOW_ONBOARDING_AT_FIRST_RUN

EXTRA_IN_SHOW_ONBOARDING

EXTRA_IN_BACK_BUTTON_SHOULD_CLOSE_LIBRARY

EXTRA_IN_GINI_VISION_FEATURE_CONFIGURATION

EXTRA_OUT_ERROR

EXTRA_OUT_EXTRACTIONS

RESULT_ERROR

Constructor Detail

CameraActivity

Method Detail

setReviewActivityExtra

setAnalysisActivityExtra

onBackPressed

onDocumentAvailable

onProceedToMultiPageReviewScreen

onQRCodeAvailable

onCheckImportedDocument

onError

onExtractionsAvailable

setListener

showDocumentCornerGuides

hideDocumentCornerGuides

showCameraTriggerButton

hideCameraTriggerButton

showInterface

hideInterface

showActivityIndicatorAndDisableInteraction

hideActivityIndicatorAndEnableInteraction

showError