ginivision

Gini Vision Library for Android

The Gini Vision Library for Android provides Activities and Fragments for capturing, reviewing and analyzing photos, images and pdfs of invoices and remittance slips.

By integrating this library in your application you can allow your users to easily take a picture of a document, review it and - by implementing the necessary callbacks - upload the document to the Gini API for analysis.

Communication with the Gini API is not part of the Gini Vision Library to allow clients the freedom of using a networking implementation of chossing. The quickest way to add networking is to use the Gini Vision Network Library. You may also use the Gini API SDK for Android or implement communication with the Gini API yourself.

The Gini Vision Library for Android can be integrated in two ways, either by using the Screen API or the Component API. The Screen API provides Activities for easy integration that can be customized in a limited way. The screen and configuration design is based on our long-lasting experience with integration in customer apps. In the Component API we provide Fragments for advanced integration with more freedom for customization. We strongly recommend keeping in mind our UI/UX guidelines, however.

Customization of the Views is provided mostly via overriding of app resources: dimensions, strings, colors, texts, etc. Onboarding can also be customized to show your own pages, each consisting of an image and a short text.

Due to in-memory image handling applications using the Gini Vision Library must enable large heap.

Tablet Support

The Gini Vision Library can be used on tablets too. We have adapted some UI elements to offer a better experience to tablet users and removed the camera flash requirement for tablets since flash is not present on all tablets. For more information please consult our guide Supporting Tablets.

Requirements

  • Screen API: Android 4.4+ (API Level 19+)

  • Component API: Android 4.4+ (API Level 19+)

Phone Hardware

  • Back-facing camera with auto-focus and flash

  • Minimum 8MP camera resolution.

  • Minimum 512MB RAM.

Tablet Hardware

  • Back-facing camera with auto-focus.

  • Minimum 8MP camera resolution.

  • Minimum 512MB RAM.

Screen API

GVL 2.5.0 and older

The Screen API provides a main Activity with which to start the Gini Vision Library and two abstract Activities which you need to override to react to events coming from the Gini Vision Library.

In order to support the widest variety of Android versions while keeping the look and feel consistent, we use the Android Support Library and provide only Activities subclassing the AppCompatActivity.

GVL 3.0.0 and newer

The Screen API provides a configuration singleton and a main Activity with which to start the Gini Vision Library.

In order to support the widest variety of Android versions while keeping the look and feel consistent, we use the Android Support Library and provide only Activities subclassing the AppCompatActivity.

Component API

The Component API provides Fragments which you can include in your own layouts. This allows you more freedom to customize the Gini Vision Library, without being restricted to AppCompatActivities and the Gini Vision Library Theme.

To allow usage even if you aren't using the Android Support Library, we provide a Standard and a Compat version of each Fragment.

Packages

com.ortiz.touch
Link copied to clipboard
net.gini.android.vision
Link copied to clipboard
The Gini Vision Library for Android provides Activities and Fragments for capturing, reviewing and analyzing photos, images and pdfs of invoices and remittance slips.
net.gini.android.vision.analysis
Link copied to clipboard
Contains the Activity and Fragments used for the Analysis Screen.
net.gini.android.vision.camera
Link copied to clipboard
Contains the Activity and Fragments used for the Camera Screen.
net.gini.android.vision.document
Link copied to clipboard
Contains net.gini.android.vision.Document implementations for the supported document types.
net.gini.android.vision.help
Link copied to clipboard
Contains Activities used to display information to the user on how to best use the Gini Vision Library.
net.gini.android.vision.internal.cache
Link copied to clipboard
net.gini.android.vision.internal.pdf
Link copied to clipboard
net.gini.android.vision.internal.qrcode
Link copied to clipboard
net.gini.android.vision.internal.ui
Link copied to clipboard
net.gini.android.vision.internal.util
Link copied to clipboard
net.gini.android.vision.network
Link copied to clipboard
Contains interfaces and classes for adding networking calls to the Gini Vision Library in order to communicate with the Gini API.
net.gini.android.vision.network.model
Link copied to clipboard
Contains value classes for extractions from the Gini API.
net.gini.android.vision.noresults
Link copied to clipboard
Contains the Activity and Fragments used for the No Results Screen.
net.gini.android.vision.onboarding
Link copied to clipboard
Contains the Activity and Fragments used for the Onboarding Screen.
net.gini.android.vision.requirements
Link copied to clipboard
Contains classes to check if the device meets all the requirements for using the Gini Vision Library.
net.gini.android.vision.review
Link copied to clipboard
Contains the Activity and Fragments used for the Review Screen.
Contains the Activity and Fragment used for the Multi-Page Review Screen.
net.gini.android.vision.tracking
Link copied to clipboard
Contains the interface, enums and classes used for tracking various events which occur during the usage of the Gini Vision Library.
net.gini.android.vision.util
Link copied to clipboard