Skip to main content

Getting started

Sample Project​

If you prefer sample projects over documentation, check out our Docutain SDK Flutter Sample on Github.

Docutain SDK Dependencies​

The Docutain SDK for Flutter is available on pub.dev.

Add the docutain_sdk plugin to your pubspec.yaml file as dependency:

dependencies:
  docutain_sdk: ^1.3.4

Fetch and install the Docutain SDK plugin. Depending on your IDE you might find a button to do this or run the following command in the Flutter CLI

flutter pub get

Android​

CompileSdk​

The compileSdk of your app needs to be set to 34 or greater. If you are not already using a Flutter SDK version that uses a compileSdk of 34 or greater, we recommend to upgrade your Flutter SDK. If this is not possible for you, you can update the compileSdk manually in the Android build.gradle file. Note that updating the compileSdk (which allows newer APIs to be used) can be done seperately from updating targetSdk and minSdk. So this should have no negative impact on your app.

Android Gradle Plugin​

To run the Docutain SDK on Android, your projects needs to have AGP (Android Gradle Plugin) Version 8.0.2 or higher.

If you are currently using an AGP version lower than 8.0.2, you need to upgrade to at least 8.0.2. We recommend to do this with Android Studio. Open the native Android project of your Flutter project with Android Studio and use the AGP Upgrade Assistant.

More details on upgrading AGP

When upgrading AGP version, you might get an error similar to the following:

AndroidGradle8UpgradeNamespaceError

Starting with AGP version 8, each project needs to define a namespace. The Docutain SDK already supports this, but you might use some other 3rd party dependencies that have not been upgraded to using namespaces yet.

You can upgrade all your packages to the latest version by running flutter pub upgrade and see if this solves the issue.

If not, you need to add the highlighted part to your project's build.gradle:

allprojects {
    repositories {
        google()
        mavenCentral()
    }
    subprojects {
        afterEvaluate { project ->
            if (project.hasProperty('android')) {
                project.android {
                    if (namespace == null) {
                        namespace project.group
                    }
                }
            }
        }
    }
}

Camera Permission​

If you want to use the Document Scanner, declare the following permission in your AndroidManifest.xml

<uses-permission android:name="android.permission.CAMERA"/>
<uses-feature android:name="android.hardware.camera"/>
info

Runtime permission for camera is handled automatically by the Docutain SDK.

Memory settings​

Your application will work with high-resolution images. To avoid OutOfMemoryError exceptions it is highly recommended to set android:largeHeap="true" in the <application> element of your AndroidManifest.xml file.

<application android:largeHeap="true" ...>
    ...
</application>

iOS Manifest​

Camera Permission​

If you want to use the document scanner, you need to specify the reason for requesting access to the camera as part of the NSCameraUsageDescription in the Info.plist. If you don't the app will crash.


NSCameraUsageDescription