Atalasoft MobileImage API Reference
Atalasoft MobileImage API Reference Documentation

Welcome

The Atalasoft MobileImage API Reference Guide for Android provides a detailed description of each class included in the Mobile SDK library. This guide assumes you have a detailed understanding of the development environments used to implement the APIs described here. This reference guide is designed to be used along with the Atalasoft MobileImage Developer's Guide as the primary reference documents for your development.

Mobile SDK Android Library

To include Atalasoft technologies in your app, you will include the Atalasoft MobileImage Android libraries (.jar files) in the libs folder of your Android application project. All of the Atalasoft MobileImage libraries along with various dependent Java libraries can be found in the AtalasoftMobileSDK_libs folder. Each package within Mobile SDK library includes a version singleton class to find the version of each part of the SDK. You can use these classes to get the Engines software version (KenVersion), the UIControls version (KuiVersion) and the top level SDK version (SdkVersion). Each version string is composed of six dot-separated digits, the first two digits being the major and minor number, the middle digits for interim releases as needed, and the last digit is the build number.

The Atalasoft SDK packages that are described in this API guide are summarized below:
The Utilities package includes the license API (Licensing), classes to find the individual Utilities library version (KutVersion) and Mobile SDK version (SdkVersion). The error information class (ErrorInfo), AppContextProvider (AppContextProvider) class, and two types of Mobile SDK exception wrapper classes (KmcException, KmcRuntimeException) are also included. All errors returned by the SDK framework are documented in the Developer's Guide. You can also use three methods of the ErrorInfo enum class to get an error description for the error code, a recommended corrective action for that error, and (in some instances) a detailed error cause.
The Engines package includes the image processor (ImageProcessor), the image classifier (ImageClassifier), image related classes and the Engine Data classes. The Engine Data classes provide the data storage for images (Image), image processing profiles (like BasicSettingsProfile and ImagePerfectionProfile for specifying image processing options for how to process an image), the results of operations performed (like bar code data found (BarcodeResult), image classification results (ImageClassificationResult) or image quick analysis results (QuickAnalysisFeedback). Engine data classes also include the bounding rectangle and tetragon data classes used by several areas of the SDK (BoundingRect and BoundingTetragon).
The UIControls package contains all the classes and API associated with UI controls that you can add to your mobile application. The Barcode UI capture control (BarCodeCaptureView) captures single barcode data when you hover over one with the live camera view. The Image UI capture control (ImageCaptureView) captures images of documents that you want to include in the business process you design in your application. The Image UI capture control provides visual cues to make sure your application captures images when the camera is held steady and level with the work surface, according to how you program your app. You can also control the size, aspect ratio and design of a frame that represents a visual cue to the user that shows the size and orientation of the target page. Your user would then orient the camera or the document to line up with the frame so that the picture taken has the document correctly oriented. This frame is defined by the frame class (ImageCaptureFrame). The capture control uses the frame object to draw a reference frame rectangle to represent the desired size of the target document while a picture is being taken with the control.
The UIControls package also includes an image review and edit control (ImgReviewEditCntrl) to view images of documents used as part of your business flow. This control includes a rectangle that you can control to allow your user to manually indicate the page boundary for a subsequent edit process using the image processor.

Events

The SDK API not only includes classes to provide the API to properties and methods, but also several events for notifying you of progress or completion of asynchronous operations. Asynchronous operations include image processing, image classification, server communications through the logistics services (if your SDK package includes Logistics), and image and barcode capture. Some of the top level API classes are instantiated as regular instance objects by using a public constructor, but are restricted to having only one object instance active at any given time. These "one active at a time" objects include the image processor, the image classifier (which is included in the Engines library), and the Front Office Server / TotalAgility Server objects (both contained in the Logistics library).
The events below are provided by the Atalasoft MobileImage. Listener callbacks can be registered in each of the designated classes to receive these events.

ImageCaptureView class
AutoFocusResultEvent: signifies whether the camera succeeded in focusing or not.
StabilityDelayEvent: fires in response to accelerometer changes and indicates a change in stability levels.
LevelnessEvent: fires when the pitch and roll of the device changes.
ImageCapturedEvent: fires when an image is successfully captured, and returns an Image object.
BarCodeCaptureView class
StabilityDelayEvent: fires in response to accelerometer changes and indicates a change in stability levels.
BarCodeFoundEvent: fires with decoded barcode data and the unprocessed image that was used to read the barcode.
ImageProcessor class
ImageOutEvent: fires in response to a processed Image being available following a call to processImage.
ProcessProgressEvent: fires in response to image processing progress information being available following a call to processImage.
AnalysisCompleteEvent: fires in response to image quick analysis results being available following a call to doQuickAnalysis.
ImageClassifier class
ImageClassificationCompleteEvent: fires upon completion of an image classification process. The event includes status information, and the Image object that was classified.

Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.