Document Scan
The Docutain Document Scanner SDK for Android comes with integrated, ready to use UI components for the document scan process. Colors and icons can be changed to match your branding.
It is also possible to use the Document Scanner on imported images.
Initialization
Make sure you have defined the following package dependencies in your app's build.gradle
file:
def docutainSdkVersion = '1.6.3.1'
//For Document Scanner components
implementation("de.docutain:Docutain-SDK-UI:$docutainSdkVersion")
Initialize the Docutain Android Scanner SDK as described here.
Scan with Camera
Camera Permission
Declare permissions to use the camera in your AndroidManifest.xml
:
<uses-permission android:name="android.permission.CAMERA"/>
<uses-feature android:name="android.hardware.camera"/>
Runtime permission for camera is handled automatically by the Docutain SDK.
Start Camera Scan
To start the scan process you only have to launch an ActivityResultLauncher
with our predefined ScanResult
contract and wait for it to return.
An instance of DocumentScannerConfiguration
is required to launch the document scanner. It provides the possibility to change some behaviours to adopt it to your needs.
See Change default scan behaviour for possible custom settings.
- Kotlin
- Java
import de.docutain.sdk.ui.ScanResult
val documentScanResult = registerForActivityResult(ScanResult()) { result ->
if(result){
//user finished scan process, continue with your workflow
//generate PDF by using Document.writePDF()
//get detected Text by using DocumentDataReader.getText()
//get data by using DocumentDataReader.analyze()
} else{
//user canceled scan process
}
}
myButton.setOnClickListener {
val scanConfig = DocumentScannerConfiguration()
documentScanResult.launch(scanConfig)
}
import de.docutain.sdk.ui.ScanResult
private ActivityResultLauncher documentScanResult = registerForActivityResult(new ScanResult(),
new ActivityResultCallback<Boolean>() {
@Override
public void onActivityResult(Boolean result) {
if(result){
//user finished scan process, continue with your workflow
//generate PDF by using Document.writePDF()
//get detected Text by using DocumentDataReader.getText()
//get data by using DocumentDataReader.analyze()
} else{
//user canceled scan process
}
}
});
myButton.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
DocumentScannerConfiguration scanConfig = new DocumentScannerConfiguration();
documentScanResult.launch(scanConfig);
}
});
Scan from imported images
It is also possible to use the Document Scanner on already taken images, for example images selected from the users photo gallery. The process of starting the scanner on imported images is the same as when scanning with the camera.
The only difference is defining a different source
in the DocumentScannerConfiguration
. Possible values are:
CAMERA
: This is the default value. Starts the Document Scanner using the devices camera.IMAGE
: Starts the Document Scanner on images provided by you via code. PasssourceImages
to theDocumentScannerConfiguration
containing the paths to the images to be scanned.GALLERY
: Opens the user's photo gallery in single select mode. The Document Scanner is run on the selected image.GALLERY_MULTIPLE
: Opens the user's photo gallery in multi select mode. The Document Scanner is run on the selected images.
The following sample shows how to open the photo gallery in multi select mode and run the Document Scanner on the selected images:
- Kotlin
- Java
import de.docutain.sdk.ui.ScanResult
val documentScanResult = registerForActivityResult(ScanResult()) { result ->
if(result){
//user finished scan process, continue with your workflow
//generate PDF by using Document.writePDF()
//get detected Text by using DocumentDataReader.getText()
//get data by using DocumentDataReader.analyze()
} else{
//user canceled scan process
}
}
myButton.setOnClickListener {
val scanConfig = DocumentScannerConfiguration()
scanConfig.source = Source.GALLERY_MULTIPLE
documentScanResult.launch(scanConfig)
}
import de.docutain.sdk.ui.ScanResult
private ActivityResultLauncher documentScanResult = registerForActivityResult(new ScanResult(),
new ActivityResultCallback<Boolean>() {
@Override
public void onActivityResult(Boolean result) {
if(result){
//user finished scan process, continue with your workflow
//generate PDF by using Document.writePDF()
//get detected Text by using DocumentDataReader.getText()
//get data by using DocumentDataReader.analyze()
} else{
//user canceled scan process
}
}
});
myButton.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
DocumentScannerConfiguration scanConfig = new DocumentScannerConfiguration();
scanConfig.setSource(Source.GALLERY_MULTIPLE);
documentScanResult.launch(scanConfig);
}
});
Change default scan behaviour
DocumentScannerConfiguration
You can use the DocumentScannerConfiguration
to alter the default scan behaviour to your needs. Currently the following values can be set:
allowCaptureModeSetting
: Defaults to false. If true, the document scanner toolbar will display an item that allows the user to switch between automatic and manual camera triggering.autoCapture
: Defaults to true. If true, the camera will capture the image automatically at the right moment.defaultScanFilter
: Defaults toILLUSTRATION
. The default scan filter that will be used after scan.onboardingImageSource
: Your custom image for the onboarding dialog that appears when scan is opened for the first timepageEditConfig
: Configuration class used to alter the default page editing behaviour. See PageEditConfiguration for more details.source
: The source of the Document Scanner. Defaults toCAMERA
. If you need to run the scanner on imported images please see Scan from imported images for more details.sourceImages
: Please see Scan from imported images for more details.autoCrop
: Defaults to true. If true, image gets automatically cropped if document was detected. This applies only when importing images.multiPage
: Defaults to true. If true, scanning multi page documents is possible. Set this to false if you need to scan single page documents.preCaptureFocus
: Defaults to true. If true, the camera will run a focus action right before taking the image. This improves the quality of the scanned images, but depending on the device, image capture might take a little bit longer.
All parameters in DocumentScannerConfiguration
are optional.
PageEditConfiguration
You can use the PageEditConfiguration
to alter the default page editing behaviour to your needs. Currently the following values can be set:
allowPageFilter
: Defaults to true. If false, the bottom toolbar will hide the filter page item.allowPageRotation
: Defaults to true. If false, the bottom toolbar will hide the rotate page item.allowPageArrangement
: Defaults to true. If false, the bottom toolbar will hide the arrange page item.allowPageCropping
: Defaults to true. If false, the bottom toolbar will hide the page cropping item.pageArrangementShowDeleteButton
: Defaults to false. If true, each item of the page arrangement functionality will show a delete button.pageArrangementShowPageNumber
: Defaults to true. If true, each item of the page arrangement functionality will show it's page number.
All parameters in PageEditConfiguration
are optional.
Result handling
After the scan process is successfully finished, you can do a bunch of things with the scanned pages: