EMC Captiva Mobile SDK

Transcription

1 EMC Captiva Mobile SDK Version 1.1 Development Guide EMC Corporation Corporate Headquarters Hopkinton, MA

2 Legal Notice Copyright 2014 EMC Corporation. All Rights Reserved. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDF Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks used herein are the property of their respective owners. Documentation Feedback Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we can make our documentation better or easier to use, please send us your feedback directly at [email protected]

3 Table of Contents Revision History... 5 Chapter 1 Overview... 7 Introduction... 7 SDK Contents... 7 Chapter 2 Developing Applications... 9 Features... 9 Best Practices Licensing Required SDK Files Sample Applications Running on Android Running on ios

4 Table of Contents List of Tables Table 1. Contents of the SDK... 7 Table 2. Required SDK Files: Android and ios

5 Revision History Revision Date July 2014 April 2014 Description Added description of the new torch mode feature introduced in 1.1 P01 (Patch 1). For more information, see Features, page 9. Initial Publication. 5

6 Preface 6

7 Chapter 1 Overview Introduction, page 7 SDK Contents, page 7 Introduction The Captiva Mobile SDK consists of functionality that enables custom mobile applications (hereafter mobile or mobile device refers to both phones and tablets) to take pictures of many kinds of documents and enhance them for processing (including but not limited to OCR processing). Your custom application can then send those pictures to any of your back-end business processes, including a Captiva server that uses Captiva REST APIs to create batches in an InputAccel Server. SDK Contents Note: For specific system requirements, see the EMC Captiva Mobile SDK Release Notes. <install-dir> is the root installation directory into which you decompressed the installation zip file. Table 1. Contents of the SDK Components Contents Location (Default) Mobile SDK for both Android and ios Release Notes Development Guide <install-dir>\docs 7

8 Overview Components Contents Location (Default) Mobile SDK for Android Libraries <install-dir>\android Samples Mobile SDK for ios Reference Documentation Libraries Samples Reference Documentation <install-dir>\ios 8

9 Chapter 2 Developing Applications Features, page 9 Best Practices, page 10 Licensing, page 11 Sample Applications, page 12 Features In addition to providing an integration with mobile device cameras, the Mobile SDK provides functionality that helps your end users take good quality pictures of documents and even further improve their quality for OCR after taking the pictures. For example, the SDK can take advantage of a mobile device s sensors, such as a motion sensor to detect too much shaking. The SDK also provides the ability to correct images (that is, pictures) after they were taken; for example, de-skewing to make the edges of the document parallel to the borders of the image. Additional examples of these kinds of functionality include: Picture-taking assistance: Display picture guidelines, including instructional text Supply picture cancellation reasons (such as pressing a cancel button or optimal picture-taking conditions were not satisfied) Specify the minimum and maximum amounts of time to wait for optimal picture-taking conditions Specify whether the conditions of the following sensors are displayed and evaluated for optimal picture-taking conditions: Focus Motion Light 9

10 Developing Applications Note: The Mobile SDK for ios does not support the light sensor. Enable torch mode (that is, turn the LED flash into a camera light) Image enhancements: Cropping Resizing De-skewing Rotation by 90, 180, 270 degrees Conversion to binary Conversion to grayscale File format: Saving to JPG, PNG and TIFF Various utility features, such as licensing and returning image file properties Note: For the specific API syntax, see the Mobile SDK reference documentation for Android and ios. Best Practices Because of the manual nature of taking pictures with a mobile device, it is important to take steps to ensure a good quality picture. When taking a picture, follow these best practices: Ensure that the document has reasonably good and uniform lighting Hold the camera parallel to the document surface to reduce distortion Make sure that the document occupies most of the space within the visual guidelines After image enhancements (filters) have been applied, make sure to verify the quality of the image before sending it to your business process. Note: As long as conditions (such as lighting and distortion) are within reasonable bounds, Captiva filters can enhance images for better processing. Even if conditions are sub-standard (such as poor lighting), the filters could still improve image quality or leave the image unmodified. However, they might over-correct therefore worsening image quality in which case, depending on your image quality requirements, you can either use the original image or correct the conditions and retake the picture. 10

11 Developing Applications Licensing In order to use the SDK for production purposes, each of your mobile applications must provide a valid, EMC-generated license key and matching application ID; that is, a watermark is applied to every image that an application processes when the application: Does not attempt to provide a valid license, or Provides an invalid license. Note: For testing purposes, you can have an unobscured view of all parts of the same document by taking multiple pictures of it because every time a different picture is processed, the watermark is placed in a different location. To implement functionality that validates a license key, you call the addlicensekey method. The addlicensekey takes a license key and matching application ID strings. When you purchase a license key, you provide an application ID to EMC who will generate your license key. Each application must have an application ID and matching license key that are both unique between all of your applications. Required SDK Files To use the SDK in your application, include the following SDK files in your project. Note: On Android, the following files are device-dependent: libcaptivaimagesdk.so Graphics files in the res directory The following paths are relative to <install-dir>. Table 2. Required SDK Files: Android and ios Operating System Android Files Android/Sdk/libs/captivamobilesdk.jar Android/Sdk/libs/* /libcaptivaimagesdk.so ios Android/res/*/*.* ios/sdk/libs/libcaptivamobilesdk.a ios/sdk/include/cmscaptureimage.h ios/sdk/include/cmsconstants.h ios/sdk/include/cmsimagedelegate.h ios/sdk/res/*.* 11

12 Developing Applications Sample Applications The sample applications demonstrate the following functionality: Picture-taking assistance including optimization and other visual feedback Image enhancement filters License key API usage For example, to optimize picture-taking, guidelines and light-sensor readings are enabled to provide user feedback as shown in the following figure. Note: This figure shows the Android sample application. A red lightbulb is displayed when minimal lighting conditions have not been met. Red guidelines are also displayed when one or more minimal conditions have not been met. Running on Android 1. In your integrated development environment (IDE), import the Mobile SDK and sample application. Tip: In Eclipse, you can import the sample application as an existing Android project. Make sure to reference captivamobilesdk.jar in the Java build path. 2. Connect your device to your computer and install the device s USB driver. 3. Run the sample application with your device. In the Eclipse IDE, you are prompted to select a device. Tip: Because of better performance with an actual device, EMC recommends that you run the sample application with a connected device rather than an Android device emulator. 4. On your device, tap the Captiva SDK Sample application. 12

13 Developing Applications Running on ios 1. Open the SDKSampleApp/SDK Sample App.xcodeproj project file. 2. Connect your device to your computer. 3. Select the scheme that matches your device. 4. Run the sample application with your device. Tip: Because the xcode device simulator does not support a virtual camera, EMC recommends that you run the sample application with a connected device rather than the device simulator. 5. On your device, tap the Captiva Demo application. 13

14 Developing Applications 14

15 Index A addlicensekey, 11 Android location, files, 8 sample, 12 sample, running, 12 SDK files, required, 11 Application overview, 9 Application ID, 11 B Best practices, 10 D Documentation location, 7 F Files location, Android, 8 location, ios, 8 SDK, required, 11 I ios location, files, 8 L sample, 12 sample, running, 13 SDK files, required, 11 License key, 11 Licensing, 11 Location documentation, 7 files, Android, 8 files, ios, 8 O Overview application, 9 Captiva Mobile SDK, 7 S Samples Android, overview, 12 Android, running, 12 ios, overview, 12 ios, running, 13 W Watermark, 11 15