Migration Notes Pixelnetica™ Document Scanning SDK for Android
Whatever version you are coming from, this page tells you what an update means for your code. Sections run newest first: find the version you are updating from and read every section above it. Most updates need no code changes — and each section says so when that is the case. (For the full list of what changed in each release, see the version history.)
Updating to 3.2.0
Version 3.2.0 keeps the 3.x API — existing code compiles and runs unchanged. Three things are worth knowing when you update:
- Every SDK object backed by native memory now implements
AutoCloseable. Closing is optional (the garbage-collector fallback remains), but loops over many pages stay flat on memory when each page is closed as it finishes — see the native memory guide. - The Smart Camera’s frame colours changed meaning: yellow now shows while a document is being framed and green when automatic capture is imminent — previously the two were inverted. If your user guides or help screens describe the colours, update them; the states are listed in the Smart Camera article.
ScanningSdkLibrary.versionInfois new: it reports the SDK version, build number, and source revision at runtime, for About screens and support requests.
Migrating from Version 2.x
Version 3 replaced the version 2.x API: the com.pixelnetica.imagesdk package (the Document Imaging SDK) is gone, and its classes have direct successors in com.pixelnetica.scanning. The table below maps each 2.x name to its replacement in the current API — after the switch, the guides and the sections above apply to you like to any 3.x integrator.
For reference, see how it is implemented in the DSSDK Sample application.
| DSSDK Version 2.x | DSSDK Version 3 |
|---|---|
MetaImage | ScanPicture |
ImageProcessing.detectDocumentCorners | ScanPicture.detectCutout |
Corners | ScanCutout |
DocumentCutout | ScanCutout |
ImageProcessing.correctDocument | ScanPicture.refine() with a list of RefineFeature.* |
ImageProcessing.imageWithoutRotation | ScanPicture.refine() with a list of RefineFeature.* |
ImageProcessing.imageBWBinarization | ScanPicture.refine() with RefineFeature.Profile.Type.Bitonal |
ImageProcessing.imageGrayBinarization | ScanPicture.refine() with RefineFeature.Profile.Type.Monochrome |
ImageProcessing.imageColorBinarization | ScanPicture.refine() with RefineFeature.Profile.Type.Colored |
ImageWriter(type) | ImageWriterPdf, ImageWriterTiff, or ImageWriterPng |