SDK Features overview | Android Document Scanner
Introduction
The Scanbot SDK offers a number of features, most of which are available both as a Ready-To-Use UI (RTU UI) solution and as a classic component:
- RTU UI is easy to use (sometimes involving little more than adding a few lines of code), but has limited customization options.
- RTU UI v2 is our brand new implementation of the RTU UI components, written from scratch. It features a new visual style and much more customizable UI and behavior. So far, RTU UI v2 is only available for the Barcode Scanner, but converting the rest of the components is on our roadmap and updates will be rolled out over time.
- Classic components are usually somewhat harder to integrate. However, they provide maximum levels of customization. This allows seamlessly blending in with the rest of your application, supporting its design code and UX.
Document Scanner
Includes: document scanning, cropping UI, Page entity (link).
Document Scanner RTU UI components
The Document Scanner RTU UI components are represented by DocumentScannerActivity and CroppingActivity. Detailed documentation about the Document Scanner RTU UI can be found here, while documentation about the Cropping RTU UI can be found here.
Document Scanner classic components
The Document Scanner classic components are represented by the following components:
ScanbotCameraXView(more details here)PolygonView(more details here)ShutterButtonDocumentAutoSnappingController(more details here)ContourDetectorFrameHandler(more details here)ContourDetector(more details here)FinderOverlayView/AdaptiveFinderOverlayView/ZoomFinderOverlayView(more details here)EditPolygonImageView(more details here)MagnifierView(more details here)
Barcode Scanner
Includes: barcode scanning, batch barcode scanning, Swiss QR, GiroCode
Barcode scanner RTU UI components
The Barcode scanner RTU UI component is represented by BarcodeScannerActivity. Detailed documentation can be found here.
Barcode scanner classic components
The Barcode scanner classic components are represented by the following components:
ScanbotCameraXViewBarcodeDetectorFrameHandlerBarcodeAutoSnappingControllerFinderOverlayView
More details can be found here.
Machine Readable Zone (MRZ) scanner
The Scanbot SDK provides the ability to find and extract Machine Readable Zone (MRZ) content from ID cards, passports and travel documents.
See the detailed MRZ scanner usage guide here.
MRZ scanner RTU UI components
The MRZ scanner RTU UI component is represented by MRZScannerActivity. Detailed documentation can be found here.
MRZ scanner classic components
The MRZ scanner classic components are represented by the following components:
ScanbotCameraXViewMRZScannerFrameHandlerMRZScannerContourDetectorFinderOverlayView
More details are here.
European Health Insurance Card (EHIC) scanner
The Scanbot SDK provides the ability to scan and extract content from European Health Insurance Cards (EHIC), a.k.a. elektronische Gesundheitskarten (eGK).
See the detailed EHIC scanner usage guide here.
EHIC scanner RTU UI components
The EHIC scanner RTU UI component is represented by HealthInsuranceCardScannerActivity. Detailed documentation can be found here.
EHIC scanner classic components
The EHIC scanner classic components are represented by the following components:
ScanbotCameraXViewHealthInsuranceCardScannerFrameHandlerHealthInsuranceCardScannerFinderOverlayView
More details are here.
Generic document scanner
The Scanbot SDK provides the ability to detect various types of documents, crop them and recognize data fields via the Generic Document Recognizer.
Currently, the Generic Document Recognizer supports the following types of documents:
- German ID card
- German passport
- German driver's license
More details are here.
Generic Document Scanner RTU UI components
The Generic Document Scanner RTU UI component is represented by GenericDocumentRecognizerActivity. Detailed documentation can be found here.
Generic Document Scanner classic components
The Generic Document Scanner classic components are represented by the following components:
ScanbotCameraXViewGenericDocumentRecognizerFrameHandlerGenericDocumentRecognizer
More details are here.
License Plate Scanner
The Scanbot SDK provides the ability to scan car license plates and parse data fields. Scanning is currently limited to common EU license plates (country code on blue background on the left side).
See the detailed License Plate Scanner usage guide here.
License Plate Scanner RTU UI components
The License Plate Scanner RTU UI component is represented by LicensePlateScannerActivity. Detailed documentation can be found here.
License Plate Scanner classic components
The License Plate Scanner classic components are represented by the following components:
ScanbotCameraXViewLicensePlateScannerFrameHandlerLicensePlateScanner
More details can be found here.
VIN Scanner
The Scanbot SDK provides the ability to scan and verify Vehicle Identification Numbers (VIN).
See the detailed VIN Scanner usage guide here.
VIN Scanner RTU UI components
The VIN Scanner RTU UI component is represented by VinScannerActivity. Detailed documentation for using the RTU UI can be found here.
VIN Scanner classic components
The VIN Scanner classic components are represented by the following components:
ScanbotCameraXViewVinScannerVinScannerFrameHandler
More details on these classic components are available here.
Medical Certificate Recognizer
The Scanbot SDK provides the ability to find and extract content from German Medical Certificates (MC / AU-Bescheinigung).
See the detailed Medical Certificate Recognizer usage guide here.
Medical Certificate Recognizer RTU UI components
The Medical Certificate Recognizer RTU UI component is represented by MedicalCertificateRecognizerActivity. Detailed documentation can be found here.
Medical Certificate Recognizer classic components
The Medical Certificate Recognizer classic components are represented by the following components:
ScanbotCameraXViewMedicalCertificateFrameHandlerMedicalCertificateAutoSnappingControllerMedicalCertificateRecognizer
More details can be found here.
Check Scanner
The Scanbot SDK provides the ability to recognize US checks. After successful detection, the SDK performs a recognition operation to extract the data fields of the detected check.
More details can be found here.
Check Scanner RTU UI components
The Check Scanner RTU UI component is represented by CheckRecognizerActivity. Detailed documentation can be found here.
Check Scanner classic components
The Check Scanner classic components are represented by the following components:
ScanbotCameraXViewCheckScannerFrameHandlerCheckScanner
More details can be found here.
Data Scanner
The Scanbot SDK comes with separate scanners for many specific use cases. Use cases that are not covered by any of these specialized scanners can be tackled with the Data Scanner module.
Data Scanner RTU UI components
The Data Scanner RTU UI component is represented by TextDataScannerActivity. Detailed documentation can be found here.
Data Scanner classic components
The Data Scanner classic components are represented by the following components:
ScanbotCameraXViewGenericTextRecognizerFrameHandlerGenericTextRecognizer
More details can be found here.
Image processing and filters
Digital image processing is a core part of the Scanbot SDK. Basically there are three operations on images:
- Rotation
- Image filtering
- Image warping (perspective correction and cropping) into a 4-sided polygon shape
Image Processing classic components
The Image Processing classic components are represented by the following components:
ImageProcessor
More details can be found here.
PDF creation
The Scanbot SDK for Android provides a simple and convenient API to create PDF document files. The PDF renderer supports multi-page PDFs where each given image will be stored as a PDF page. Furthermore, you can specify the physical output page size (e.g. A4, US Letter, Auto).
PDF creation classic components
The PDF creation classical components are represented by the following components:
PDFRendererPageFileStoragePageProcessorFileIOProcessor
More details can be found here.
TIFF creation classical components
The TIFF creation classical components are represented by the following components:
TIFFWriterPageFileStoragePageProcessorFileIOProcessor
More details can be found here.
Optical character recognition (OCR)
The Scanbot SDK OCR feature is based on the Tesseract OCR engine with some modifications and enhancements. The Scanbot SDK uses an optimized custom library of the Tesseract OCR under the hood and provides a convenient API.
OCR classical components
The OCR classical components are represented by the following components:
OpticalCharacterRecognizerPageFileStoragePageProcessor
More details can be found here.
Document Quality Analyzer
The Document Quality Analyzer component allows you to analyze the document text quality (legibility) on images or frames from the camera.
Document Quality Analyzer classical component
The Document Quality Analyzer classical component is represented by DocumentQualityAnalyzer.
More details are here.
Storage
The Scanbot SDK provides full control over the file storage and supports an encryption functionality for all files (images and documents) generated by the SDK, so your data will be stored securely.
More details can be found here.
Encryption
The Scanbot SDK provides the ability to optionally encrypt all stored images and PDF files in the SDK app folder.
Encryption is not enabled by default.
More details can be found here.
Examples and Java Docs
For more details about the classical components, please refer to our example apps and Java API docs.
For more details about the RTU UI Components, please refer to our example app ready-to-use-ui-demo.
Want to scan longer than one minute?
Generate your free "no-strings-attached" Trial License and properly test the Scanbot SDK.
Get your free Trial LicenseWhat do you think of this documentation?
What can we do to improve it? Please be as detailed as you like.