Install the SDK on Android

In this guide, you will learn how to get started with the Genius Scan SDK for Android.

Overview

The Genius Scan SDK for Android consists of a single Android library that provides:

• Low-level image processing as well as basic UI components for a custom document scanning integration
• PDF and TIFF generation helpers
• An OCR module to extract text (and layout) from images
• A high-level scanner module that simplifies the integration of the SDK in your app

Sample code

We provide two demo projects in the SDK Demo apps repository:

• demo-simple: Shows how to start a simple scan flow using gssdk-scanflow. The different screens are customizable via a ScanConfiguration.
• demo-custom: This demo showcases how to build custom scan screens using the gssdk-core module. It also demonstrates how to run OCR before generating a PDF file.

To run the provided demos, open the root folder in Android Studio.

Demo app

You can test the scan flow of the Simple integration, including all config options and data extraction features, by installing our demo app from Google Play.

Size of the SDK

The Android SDK includes support for the following CPU architectures: x86, x86_64, armeabi-v7a, arm64-v8a. When integrated into your app, the SDK will increase the size of your APK by the sizes in the following table:

If you want to optimize the size of your app, you can either:

• Generate one APK file per architecture
• Use the Android App Bundle upload format so Google Play can serve optimized APKs for each user’s device configuration

Native debug symbols are included as part of the SDK. These symbols are generally stripped in the release builds of your app. This is not the case for debug builds, where you may see a larger size increase than mentioned above.

Setup

Add the SDK modules to your app

Add the following code to your app’s build.gradle:

Gradle DSL

  repositories {
     // ...
     maven { url 'https://s3.amazonaws.com/tgl.maven' }
  }

  dependencies {
    // ...
    implementation 'com.geniusscansdk:gssdk:5.14.1'
  }

What’s Next?

Next, configure a license key.