Integrate the ML Kit document scanner API into Android app to effortlessly add a document scanning feature. This guide provides details on implementation, usage, and customization options for the document scanner.
SDK Name: play-services-mlkit-document-scanner Implementation: Models, scanning logic, and UI flow are dynamically downloaded by Google Play services. App Size Impact: Approximately 300KB download size increase. Initialization Time: Users may experience a brief delay as models, logic, and UI flow are downloaded before first use.
Before You Begin Ensure that your Android app meets the following requirements:
- Minimum SDK Version: Android API level 21 or above.
- In your project-level build.gradle file, include Google's Maven repository in both buildscript and allprojects sections.
Add the dependency for the ML Kit document scanner library to your module's app-level build.gradle file:
dependencies {
// ...
implementation 'com.google.android.gms:play-services-mlkit-document-scanner:16.0.0-beta1'
}
Customize the document scanner user flow according to your app's requirements. The provided viewfinder and preview screen support various controls such as:
- Importing from the photo gallery
- Setting a limit to the number of pages scanned
- Scanner mode (to control feature sets in the flow)
- Instantiate GmsDocumentScannerOptions to configure the scanner options:
val options = GmsDocumentScannerOptions.Builder()
.setGalleryImportAllowed(false)
.setPageLimit(2)
.setResultFormats(RESULT_FORMAT_JPEG, RESULT_FORMAT_PDF)
.setScannerMode(SCANNER_MODE_FULL)
.build()
After configuring your GmsDocumentScannerOptions, obtain an instance of GmsDocumentScanner. You can then start the scanner activity following AndroidX Activity Result APIs.
val scanner = GmsDocumentScanning.getClient(options)
val scannerLauncher = registerForActivityResult(StartIntentSenderForResult()) { result ->
if (result.resultCode == RESULT_OK) {
val result = GmsDocumentScanningResult.fromActivityResultIntent(result.data)
result.getPages()?.let { pages ->
for (page in pages) {
val imageUri = pages.get(0).getImageUri()
}
}
result.getPdf()?.let { pdf ->
val pdfUri = pdf.getUri()
val pageCount = pdf.getPageCount()
}
}
}
scanner.getStartScanIntent(activity)
.addOnSuccessListener { intentSender ->
scannerLauncher.launch(IntentSenderRequest.Builder(intentSender).build())
}
.addOnFailureListener { exception ->
// Handle failure
}
- Each layer follows unidirectional event/data flow; the UI layer emits user events to the data layer, and the data layer exposes data as a stream to other layers.
- The data layer is designed to work independently from other layers and must be pure, which means it doesn't have any dependencies on the other layers.
With this loosely coupled architecture, you can increase the reusability of components and scalability of your app.
png)
The UI layer consists of UI elements to configure screens that could interact with users and ViewModel that holds app states and restores data when configuration changes.
- UI elements observe the data flow via DataBinding, which is the most essential part of the MVVM architecture.
- With Bindables, which is an Android DataBinding kit for notifying data changes, you can implement two-way binding, and data observation in XML very clean.
The data Layer consists of repositories, which include business logic, such as querying data from the local database and requesting remote data from the network. It is implemented as an offline-first source of business logic and follows the single source of truth principle.
Integrating the ML Kit document scanner API enhances your app's functionality by providing users with a seamless document scanning experience. Experiment with the provided features and customize the scanner to meet your app's specific needs.
This README content is based on the provided documentation for integrating the ML Kit document scanner API on Android. Adjustments can be made based on specific project requirements and preferences.
Support it by joining ([(https://github.com/shubhanshu24510/CameraX]) for this repository. ⭐
Also, [follow me]([https://github.com/shubhanshu24510])__ on GitHub for my next creations! 🤩