scanbot_sdk 7.0.0
scanbot_sdk: ^7.0.0 copied to clipboard
Flutter plugin of the Scanbot Scanner SDK for Android and iOS. Provides functionality like Document Scanning, QR and Barcode Scanning, PDF Creation, TIFF, OCR, etc.
Version 7.0.0 (30 June 2025) #
- 🎉 New:
- Document Scanner:
- Added the ability to auto-rotate the document based on the text orientation detected by the Document Quality Analyzer in Document Scanner RTU-UI v2.
- Added the ability to show custom images in the Intro Screen for Document Scanner RTU-UI v2.
- Added a new document detection status
OK_BUT_TOO_DARK
. - RTU-UI v2: changed
acceptedSizeScore
andacceptedAngleScore
range of values from0..1
to0..100
. - RTU-UI v2: Configurable title for the acknowledge screen.
- RTU-UI v2: Option to suppress auto-cropping on manual snaps (
autoCropOnManualSnap
in camera config). - RTU-UI v2 Cropping Screen: Support for magnetic line color (
croppingPolygonMagneticLineColor
).
- Image Processing:
- Images are now represented as references using the
ImageRef
feature.
- Added
ScanbotSdk.makeSnapshot()
API to take a snapshot of theImageRef
pool.
- Images are now represented as references using the
- PDF & TIFF Generation:
- Introduced advanced generation settings for PDFs and TIFFs.
- Added
extractImagesFromPdf
method.
- Document Quality Analyzer:
- Introduced new API for an advanced on-image scanning configuration:
analyzeDocumentQuality(String imageFileUri, DocumentQualityAnalyzerConfiguration config)
. - Can now return the orientation of the document, enabled by
DocumentQualityAnalyzerConfiguration.detectOrientation
. - Optionally possible to
returnQualityHeatmap
.
- Introduced new API for an advanced on-image scanning configuration:
- MRZ Scanner:
- New RTU-UI v2 is now available for MRZ Scanner. See
startMRZScanner
. - Advanced on-image scanning configuration.
- Added support for non-ICAO conformant machine-readable zones on US border crossing cards.
- New RTU-UI v2 is now available for MRZ Scanner. See
- Text Pattern Scanner:
- New RTU-UI v2 is now available for Text Pattern Scanner. See
startTextPatternScanner
. - Introduced
PatternContentValidator
andDefaultContentValidator
for content validation.
- New RTU-UI v2 is now available for Text Pattern Scanner. See
- VIN Scanner:
- Added a new property
extractVINFromBarcode
inVinScannerConfiguration
that allows VIN data extraction from barcodes.
- Added a new property
- Document Data Extractor:
- Advanced on-image scanning configuration.
- Now supports fallback to extraction of only the MRZ on unsupported documents.
- Generic document fields now support
parsedData
attributes for standardized data (ISO 8601 dates, ISO 3166-1 countries, "Male"/"Female" gender). - Added support for German driver qualification card.
- Document field validation now supports two additional statuses:
INFERRED
andIGNORED
. - Added possibility of returning cropped document.
Field
class enhanced withpolygonInRoot
,confidenceWeight
, andimage
property.- Added
PLACE_OF_ISSUE
toCommonFieldType
. - Added
CARD_ACCESS_NUMBER
toCommonFieldType
.
- Health Insurance Card Scanner:
- Advanced on-image scanning configuration.
- Check Scanner:
- Advanced on-image scanning configuration.
- Added possibility of returning cropped document.
- Credit Card Scanner:
- Added new Credit Card Scanner feature with Ready-to-Use UI (RTU-UI v2). See
startCreditCardScanner
. It can also be used with Scan from Image approach. SeerecognizeCreditCardOnImage
.
- Added new Credit Card Scanner feature with Ready-to-Use UI (RTU-UI v2). See
- Medical Certificate Scanner:
- Advanced on-image scanning configuration.
- Barcode Scanner:
- Added support for barcode types Pharma Code, Pharma Code Two Track and PZN (Pharmazentralnummer).
- Added support for the HIBC barcode document format.
- Added support for an advanced on-image scanning configuration for
detectBarcodesOnImage
call. - Added ability to configure common barcode properties via
BarcodeFormatCommonConfiguration
. - Added
minimumSizeScore
to barcode configurations; barcodes withsizeScore < minimumSizeScore
are ignored. - Barcode scanning results have been enhanced with more detailed information, including
sizeScore
. SeeBarcodeItem
. - Introduced
strictMode
for certain barcode configurators (QR_CODE
,MICRO_QR_CODE
,RMQR_CODE
,PDF_417
,MICRO_PDF417
, andGS1_COMPOSITE
) to balance detection rate and false positives. - Added the ability to return the barcode image in the resulting object via
BarcodeScannerConfiguration.returnBarcodeImage
. - Added new engine modes:
NEXT_GEN_FAR_DISTANCE
(optimized for scanning from far distances),NEXT_GEN_LOW_POWER_FAR_DISTANCE
(optimized for scanning from far on low-power devices). - Added new predefined subsets of barcode formats (1D, 2D, Postal, Pharma, etc.). Old sets removed.
- Added a flag
addAdditionalQuietZone
toBarcodeFormatConfigurationBase
for Scan from Image. - Classic UI: Added new customization properties to
SelectionOverlayScannerConfiguration
:highlightedPolygonColor
,highlightedStrokeColor
,highlightedTextColor
,highlightedTextContainerColor
, andstrokeColor
for improved barcode overlay appearance.
- Cropped images returned as part of the scanner results are now represented as image references (
ImageRef
) that can be converted toUint8List
buffer or saved to a path. initScanbotSdk
now returns aSdkLicenseStatus
.- Added
removePagesByID
method toScanbotDocument
. - Introduced
ScanbotImageRecognitionOperations
class (consolidatingScanbotSdkRecognizeOperations
). - Introduced
accessibilityDescription
properties for buttons inTopBarConfiguration
andActionBarConfiguration
. - Android: Added a new property
keepScreenOn
in all RTU-UI v2 scanner screen configurations to keep the device screen awake while scanning.
- Document Scanner:
- 🚀 Improvements:
- Document Scanner:
- Added
OK_BUT_ORIENTATION_MISMATCH
status, returned when screen and document orientations don't match. Can be ignored via configuration. - Improved
DocumentScannerUserGuidance
by providingorientationMismatch
as a part ofUserGuidanceStates
. - Improved the Document Scanner RTU-UI v2 acknowledgment's bad image quality hint by adding the ability to present up to 5 lines.
- Android: Added basic support for landscape mode in RTU-UI v2.
- Android: The Review Screen zoom button in RTU-UI v2 now allows its text to be hidden.
- iOS: Improved performance when editing a page in RTU-UI v2 Document Scanner Review Screen.
- iOS: Improved captured image quality.
- iOS: Improved the accessibility handling in RTU-UI v2 Document Scanner. Accessibility for the document preview button is now activated only when scanned pages are available.
- Added
- Image Processing:
- New Image Processor preset
BinarizationFilterPreset.PRESET_5
for documents with barcodes.
- New Image Processor preset
- PDF & TIFF Generation:
- PDF Generator with OCR layer now handles non-ASCII characters correctly.
- Document Quality Analyzer:
- Guarantee the same document quality score for 90 degrees rotated images.
- OCR Engine:
- Simplified OCR API:
performOCR(PerformOCRArguments args)
.
- Simplified OCR API:
- MRZ Scanner:
- For pre-2022 Costa Rican passports, ID Number is returned as
documentNumber
and Sequence Number aspersonalNumber
in MRZ fields.
- For pre-2022 Costa Rican passports, ID Number is returned as
- Text Pattern Scanner:
- Improved performance with the same quality.
- VIN Scanner:
- Validation of VINs implements the full ISO 3779 standard, reducing false positives.
- Document Data Extractor:
- Higher accuracy for document classification.
- Digits can no longer be recognized as part of given names or surnames.
- No longer needs the additional data bundle with OCR languages.
- Barcode Scanner:
- GS1 Composite codes are now processed faster in Scan from Image mode.
- By default, Code 93 now includes check digits in the result. To disable this and restore the previous behavior, set
stripCheckDigits = true
. - Improved barcode detection for various barcode types.
- Significant speed-up in live mode on very large input resolutions.
- More robust QR code recognition (timing patterns, alignment, artistic QR codes).
- Improved quiet zone checks for
ITF
,CODE_11
,MSI_PLESSEY
,IATA_2_OF_5
,INDUSTRIAL_2_OF_5
, andCODE_25
. - Improved the false positive rate for
ITF
barcodes. - Added the option to ignore barcodes that do not decode to one of the accepted document formats for Barcode Scanner RTU-UI v2 (
BarcodeScannerConfiguration.onlyAcceptDocuments
). - Added support for
maximumTextLength
constraint onCODE_11
,CODE_39
,CODE_93
,CODE_128
, andCODABAR
barcode formats. - Improved performance when scanning four-state postal barcodes.
- Added new accessibility descriptions for some buttons in
BarcodeTextLocalization
.
- Improved memory management, logging, and resource deallocation for the Classic UI components.
- Reorganized SDK into modular service-style components:
ScanbotDocument
,ScanbotImageOperations
,ScanbotImageRecognitionOperations
, andScanbotSdk
. - Enhanced consistency across document-related methods with clearer return types.
- Added new accessibility descriptions for the buttons in
ActionBarConfiguration
. - The camera permission screen will now appear if camera access is restricted in all RTU-UI screens.
- Android: Proguard rules needed for Scanbot SDK are embedded in the package. There is no need to manually specify them in your project.
- Android: Improved camera resolution selection strategies.
- Document Scanner:
- 🐞 Bug Fixes:
- Document Scanner:
- Fixed Document Scanner point sorting.
- Fixed TIFF generator bug (JPEG-encoded colored TIFFs).
- Android: Fixed
content://
URI handling forPdfGenerator
,TiffGenerator
andOcrEngine
. - Android: In Document Scanner RTU-UI v2,
PageSnapFeedbackNone()
no longer prevents auto-transition to review screen at max pages limit. - Android: Document Scanner RTU-UI v2: The horizontal layout camera bar now has a fixed width.
- Android: Cropping Screen RTU-UI v2 status bar light/dark mode now correctly applied.
- Android: Cropping Screen RTU-UI v2 now returns result instead of canceling if no changes were made.
- Android: Fixed Document Scanner
polygonColor
(not filled by default) RTU-UI v1. - Android: Fixed Document Scanner/Finder User Guidance default background for RTU-UI v1.
- Android: Fixed Document Scanner shutter button default color for RTU-UI v1.
- Android: RTU-UI v2: Removed accessibility container for user guidance image.
- iOS: Fixed UI bug in Document Scanner RTU-UI v2 where the bar buttons weren't properly grayed out when disabled.
- iOS: Fixed UI bug in Document Scanner Classic UI where accepted document's
fillColor
wasn't removed withautoSnapProgressStrokeColor
fillColor
. - iOS: Fixed a layout bug in the RTU-UI v2 cropping screen's top bar.
- iOS: Fixed layout when hiding the text of the close button on zooming in RTU-UI v2 Document Scanner.
- iOS: Fixed a memory leak when dealing with grayscale images.
- iOS: Fixed a bug in all cropping screens where the magnetic lines were missing.
- iOS: Fixed an issue in RTU-UI v2 where the introduction screen appeared automatically even when camera access was denied.
- MRZ Scanner:
- Android: Scanning from still images now correctly returns
MrzScannerResult.success
as true.
- Android: Scanning from still images now correctly returns
- Document Quality Analyzer:
- Fixed crash when
maxImageSize
was0
. - Fixed patch size when
minFraction
was1
.
- Fixed crash when
- Text Pattern Scanner:
- Fixed incorrect output for Unicode symbols.
- Document Data Extractor:
- Resolved high peak memory consumption issue.
- Fixed bug determining validation status when fields excluded.
- Fixed incorrect handling of Driver License expiry date validation.
- Fixed merging of
maidenName
andsurname
on some German ID cards.
- Check Scanner:
- Android: Fixed Check Scanner User Guidance default background (was absent) for RTU-UI v1.
- Medical Certificate Scanner:
- Android: Fixed Medical Certificate Scanner User Guidance default background (was absent) for RTU-UI v1.
- Barcode Scanner:
- Fixed returned results for all types of
UpcEanExtensionBehavior
. - Fixed checksum for
CODE_39
barcode format. - Fixed an overflow when decoding
MICRO_QR_CODE
with wrong bits in numeric mode. - Fixed
minimumTextLength
forITF
barcode format (checked symbols instead of text length). - Fixed sorting of quad points for four-state/postal barcode types.
- Fixed incorrect raw bytes returned for 2D barcode types.
- In
CODE_11
barcodes with 10 data digits, whenchecksum
is enabled andstripCheckDigits
istrue
, scanner now correctly strips both check digits. - Classic UI Android: Fixed the resolution strategy for the square preview.
- Android:
FindAndPickScanningMode.sheetContent.barcodeItemImageVisible
in RTU-UI v2 now correctly applies visibility. - Android: Fixed potential issue during
onDestroy
when the AR overlay is displayed. - iOS: Fixed a bug in Barcode Scanner RTU-UI v2 where the flip camera button was not resetting to the widest available camera.
- iOS: Fixed a UI bug in Barcode Scanner RTU-UI v2 where the sheet button overlapped the action bar.
- iOS: Fixed a bug in AR Barcode Scan and Count where the scanner would get stuck if no barcode was detected.
- iOS: Fixed an issue when scanning Code 93 barcodes with
stripCheckDigits = false
(default) and the check digit was an extension character. - iOS: Fixed a crash in the RTU-UI v2 Barcode Scanner when using
FindAndPickScanningMode
- Fixed returned results for all types of
- Android: Accessibility content for action buttons in RTU-UI v2 now properly applied.
- Android: In RTU-UI v2, modal dialog no longer appears below status bar.
- Android: Fixed nested views of camera components when readjusting parent view size.
- Android: Fixed screen insets for Android API 35 with forced edge-to-edge mode by opting out for RTU-UI v1 screens.
- iOS: Fixed an issue where quickly stopping and starting the camera session of any scanner screen could lead to a crash or unpredictable behavior.
- Document Scanner:
- ⚠️ Breaking changes:
- General API structure:
ResultWrapper
has been removed from all API responses, except those returned by RTU-UI.- In
ResultWrapper<T>
, renamed propertyvalue
todata
. - Renamed
expirationDate
tolicenseExpirationDate
andstatus
tolicenseStatus
inSdkLicenseStatus
. - Renamed enum
Status
toSdkLicenseStatus
with PascalCase values. - Removed
licenseErrorHandler
fromScanbotSdkConfig
.
- Feature renaming:
- Renamed
startGenericDocumentRecognizer
tostartDocumentDataExtractor
and related types fromGenericDocumentRecognizer
toDocumentDataExtractor
. - Renamed
recognizeGenericDocumentOnImage
toextractDocumentDataFromImage
. - Renamed Text Data Scanner (also Generic Text Recognizer) to Text Pattern Scanner.
- Renamed
- Feature removal:
- Removed RTU-UI v1 APIs:
startMrzScanner
,startTextDataScanner
,startBarcodeScanner
,startBatchBarcodeScanner
,startLicensePlateScanner
and related types. Use corresponding RTU-UI v2 methods. - Removed legacy classes:
TextDataScanResult
,TextDataScanResultField
,TextDataScannerConfiguration
. Replaced withTextPatternScannerResult
andTextPatternScannerConfiguration
.
- Removed RTU-UI v1 APIs:
- Configuration object changes:
- Replaced Barcode Scanner
recognizerConfiguration
withscannerConfiguration
. - Renamed
DocumentScannerConfiguration
toDocumentScannerScreenConfiguration
. - Renamed
BarcodeScannerConfiguration
toBarcodeScannerScreenConfiguration
. - Renamed
documentDetectorMode
todocumentScannerEngineMode
inScanbotSdkConfig
. - Changed default text values for
CameraPermissionScreen
styled texts. - Renamed
CameraConfiguration
toBaseCameraConfiguration
. - Renamed
Gs1HandlingMode
toGs1Handling
,MSIPlesseyChecksumAlgorithm
toMsiPlesseyChecksumAlgorithm
.
- Replaced Barcode Scanner
- Result type changes:
startEHICScanner
andrecognizeHealthInsuranceCardOnImage
now returnEuropeanHealthInsuranceCardRecognitionResult
.startMedicalCertificateScanner
andrecognizeMedicalCertificateOnImage
now returnMedicalCertificateScanningResult
.startDocumentDataExtractor
andextractDocumentDataFromImage
now returnDocumentDataExtractionResult
.startCheckScanner
andrecognizeCheckOnImage
now returnCheckScanningResult
.startBarcodeScanner
(RTU-UI v2) now returnsBarcodeScannerUiResult
.analyzeQualityOfDocument
now returnsDocumentQualityAnalyzerResult
.startVinScanner
now returnsVinScannerResult
.- Removed
MrzScanningResult
andMrzGenericScanningResult
models.
- Data model changes:
- Removed
NONE
fromCommonFieldType
. - Renamed all
CommonFieldType
values to uppercase with underscores. - Renamed
ValidationStatus
toFieldValidationStatus
and addedINFERRED
,IGNORED
states. Field.validationStatus
default is nowFieldValidationStatus.NONE
(wasnull
).
- Removed
- Document Scanner:
- Removed properties (e.g.,
acceptedAngleScore
) fromDocumentScannerCameraConfiguration
, moved toDocumentScannerParameters
. - Renamed
detectorMode
toengineMode
andignoreBadAspectRatio
toignoreOrientationMismatch
inDocumentScannerScreenConfiguration
andFinderDocumentScannerConfiguration
. - Renamed
DocumentDetectorMode
toDocumentScannerEngineMode
and updated the type literals.
- Removed properties (e.g.,
- Barcode Scanner:
- Removed
additionalParameters
fromBarcodeScannerScreenConfiguration
and the generalBarcodeScannerConfiguration
. - Classic UI: In
BarcodeClassicScannerConfiguration
,barcodeFormats
changed tobarcodeFormatConfigurations
. - Classic UI:
barcodeListener
callback parameter is nowBarcodeItem[]
.
- Removed
- VIN Scanner:
- Renamed
minimumNumberOfRequiredFramesWithEqualRecognitionResult
tominimumNumberOfRequiredFramesWithEqualScanningResult
inVinScannerConfiguration
.
- Renamed
- General API structure:
- ⚠️ Deprecations:
- Deprecated
ScanbotSdk.createPdf
andScanbotSdk.createTiff
in favor ofScanbotDocument.createPDFForDocument
andScanbotDocument.createTIFFForDocument
.
- Deprecated
- 🚙 Under the hood:
- Upgraded the native Scanbot Android SDK to v7.0.2.
- Upgraded the native Scanbot iOS SDK to v7.0.3.
- Added
ffi
package for native interoperability. - Upgraded
nlohmann::json
to 3.11.3. - Upgraded
xsimd
to 13.2. - Upgraded
xtl
to 0.8. - Upgraded
xtensor
to 0.26.0-scanbot. - Upgraded
yaml-cpp
to 0.8. - Upgraded spdlog to 1.15.2.
- Upgraded Boost to 1.88.
- Android: Android Jetpack Compose updated to 1.7.8.
- Android: Updated Compile Sdk to 35.
- Android: Upgrade OpenCV to 4.10.
- Android: Updated
androidx.camera:camera-camera2
to 1.4.1 with 16kb page support.
Version 6.1.2 (17 January 2025) #
- 🐞 Bug fixes:
- Android: Resolved an issue with detected polygon display for Document Classic UI Component.
- 🚙 Under the hood:
- Downgraded the
kotlin_version
to v1.8.20.
- Downgraded the
Version 6.1.1 (16 December 2024) #
- 🐞 Bug fixes:
- Android: Resolved a crash with legacy
startDocumentScanner
whendocumentImageSizeLimit
is set in DocumentScannerConfiguration.
- Android: Resolved a crash with legacy
Version 6.1.0 (12 December 2024) #
- 🎉 New:
- Implemented new RTU-UI v2 Document Scanner screen with extended scanning and reviewing capabilities. Added
startDocumentScanner
andstartCroppingScreen
APIs that can be imported frompackage:scanbot_sdk/scanbot_sdk_ui_v2.dart
. See full documentation here. - Implemented new ImageOperations API for creating TIFFs, extracting images from PDFs, generating PDFs, rotating images, and applying filters on images.
- Implemented new Document API to perform document creation and editing.
- Moved all RTU-UI v2 scanners into
ScanbotSdkUiV2
. - Added support for German health insurance cards (front side) and European health insurance cards to
startGenericDocumentRecognizer
andrecognizeGenericDocumentOnImage
. Added literalsDE_HEALTH_INSURANCE_CARD_FRONT
andEU_HEALTH_INSURANCE_CARD
toGenericDocumentType
. AddedEuropeanHealthInsuranceCard
andDeHealthInsuranceCardFront
. - Added support for new barcode types
MAXI_CODE
,RMQR_CODE
,CODE_11
andCODE_32
. Added literals that represent the new barcode types inBarcodeFormat
. - Added a new optional property
recognizerParameters
of typeHealthInsuranceCardRecognizerParameters
inHealthInsuranceCardScannerConfiguration
to configure live detection parameters. - Added a new property
accessibilityDescription
inRoundButton
andButtonConfiguration
. - Added a new property
allowEmptySubmission
inMultipleScanningMode
to allow submission of an empty barcode list in the Multiple Barcodes use case in RTU-UI v2. - Added new optional properties
useIATA2OF5Checksum
,useCode11Checksum
andaustraliaPostCustomerFormat
inBarcodeScannerConfiguration
,BatchBarcodeScannerConfiguration
andBarcodeRecognizerConfiguration
. - Added new optional property
enableNativeLogging
inScanbotSdkConfig
. - iOS: Added new zoom control slider (controlled by the new camera control button) to all view controllers. Available on all the new iPhone 16 models.
- Android: Added support for 16KB page size (Android 15).
- Implemented new RTU-UI v2 Document Scanner screen with extended scanning and reviewing capabilities. Added
- 🚀 Improvements:
- Document detector:
- Improved detection speed and robustness against orientation changes.
- Improved robustness against picking up random contours.
- Improved robustness against documents with colored corners, booklets, handheld documents, and cards, documents near edges of tables, and overlapping documents.
- Improved detection of
UPC
andEAN
extensions. - Added support for Extended Channel Interpretation (ECI) for Datamatrix and Aztec barcodes.
- Improved performance of
documentQualityAnalyzer
. - For
CODE_128
andITF
, we improved the recognition of barcodes generated by defective thermal printers that do not print certain black bars correctly. - iOS: Improved sharpness of captured images in
documentScanner
by tweaking various timing related default values, such asautoSnappingDelay
. - Android: Improved generic document recognition on static images.
- Document detector:
- 🐞 Bug fixes:
- Fixed KANJI mode for QR codes.
- iOS: Fixed a UI issue in the RTU-UI v2 Barcode Scanner
FindAndPickScanningModeUseCase
that never showed the expected barcodes title, but always the barcode value. - iOS: Fixed a UI issue in the RTU-UI v2 Barcode Scanner
FindAndPickScanningModeUseCase
in button sheet mode where the counter badge was not visible. - iOS: Fixed a UI issue on the RTU-UI v2 Barcode Scanner's sheet screen where the subtitle label was being vertically cut off.
- iOS: Fixed a UI issue on the RTU-UI v2 Barcode Scanner's confirmation sheet in the
SingleScanningModeUseCase
where the loading indicator was not centered when the loading message was hidden. - iOS: Fixed a bug in RTU-UI v2 Barcode Scanner where extended barcodes are displayed along with their non-extended versions.
- iOS: Fixed a UI issue in the RTU-UI v2 Barcode Scanner where a title that was too long would cut off the cancel button.
- iOS: Fixed a UI issue in RTU-UI v2 Barcode Scanner's finder where the background color overlapped with the line color.
- iOS: Fixed a crash when zooming with invalid
minZoom
andmaxZoom
values. - iOS: Fixed a bug that did not mirror the front camera as expected.
- Android: Fixed image preprocessing for
documentQualityAnalyzer
. - Android: Fixed R8 obfuscation config for SDK logging classes.
- Android: Minor fixes for appearance in RTU-UI v2 Barcode Scanner to make it consistent with its iOS counterpart.
- Android: Fix point sorting in the contour detector.
- Android: Fixed an issue with AR Overlay and barcode mapping in RTU-UI v2 Barcode Scanner, where the mapped image wasn't shown on the AR Overlay until the same barcode appeared in the list below.
- ⚠️ Breaking Changes:
- Introduced new properties,
fileEncryptionPassword
andfileEncryptionMode
, inScanbotSdkConfig
to replace the encryption parameters. - Deprecated
startDocumentScanner
,startFinderDocumentScanner
,startCroppingScreen
and related configurations and result types. See RTU-UI v2 Document Scanner. - Removed property
codeDensity
fromBarcodeScannerConfiguration
,BatchBarcodeScannerConfiguration
andBarcodeRecognizerConfiguration
. - Removed property
sharpnessAcceptanceFactor
fromGenericDocumentRecognizerConfiguration
. - Removed type literals
VALIDATE
andDECODE
and replaced them withVALIDATE_STRUCTURE
,DECODE_STRUCTURE
,VALIDATE_FULL
andDECODE_FULL
inGs1HandlingMode
. - Removed type literals
SuccessFound
andErrorTooBlurry
and added newErrorUnknownDocument
,ErrorUnacceptableDocument
andIncompleteValidation
inGenericDocumentRecognitionStatus
. - Removed
scanbot_sdk_v2
and moved initialization of sdk intoscanbot_sdk
. - Removed
EncryptionParameters
andencryptionParameters
property fromScanbotSdkConfig
. - Removed
OK_BARCODE
type literal fromDetectionStatus
. - Renamed property name
engine
toengineMode
inOcrOptions
. - Changed property name
imageFormat
tostorageImageFormat
, andimageQuality
tostorageImageQuality
inScanbotSdkConfig
. - Changed default values for properties
enableCameraButton
andcloseButton
inCameraPermissionScreen
. - Changed default values for properties
okButton
,cancelButton
andactionButton
inScanbotAlertDialog
. - Changed default value for property
visible
inArOverlayFindAndPickConfiguration
to true forFindAndPickScanningMode
. - ResultWrapper model changes:
- Added a new
OperationStatus
enum and an extension method for parsing strings toOperationStatus
.
- Added a new
- Document models changes:
- Added property
cardAccessNumber
and removed propertypin
inDeIdCardFront
andDeResidencePermitFront
models. pseudonym
property now returnsField | undefined
inDeIdCardBack
model.restrictions
property now returnsField | undefined
inDeDriverLicenseBack
model.- Replaced
m
property of typeDeDriverLicenseBack.Categories.M
witham
property of typeDeDriverLicenseBack.Categories.AM
. - Replaced
standard
andvalidationStatus
fields withvalidationErrors
in theGS1.Element
class.
- Added property
- Android: Changed
barcodesRegexFilter
behavior inBarcodeRecognizerConfiguration
forBarcodeScannerConfiguration
config for RTU-UI v2 Barcode Scanner. Barcodes are accepted if the barcode data contains the part that matches the regex. - Android: Some newly created files, like PDF, TIFF, or temporary images, will have different paths than previously created files.
- Introduced new properties,
- 🚙 Under the hood:
- Upgraded the native Scanbot Android SDK to v6.1.2.
- Upgraded the native Scanbot iOS SDK to v6.1.1.
- Added gs1-syntax-dictionary lib.
Version 5.1.3 (5 November 2024) #
- 🚀 Improvements:
- iOS:
- Added
widgetFadeAnimationDurationiOS
toScanbotCroppingWidget
to customize the animation duration.
- Added
- iOS:
- 🐞 Bug Fixes:
- Android:
- Fixed an issue where polygon detection didn't work after switching the page inside
ScanbotCroppingWidget
.
- Fixed an issue where polygon detection didn't work after switching the page inside
- iOS:
- Resolved a blink issue that caused brief redraws during page changes inside
ScanbotCroppingWidget
.
- Resolved a blink issue that caused brief redraws during page changes inside
- Android:
Version 5.1.2 (25 October 2024) #
- 🐞 Bug fixes:
- iOS:
- Fixed the image processing and editing flow in
ScanbotCroppingWidget
.
- Fixed the image processing and editing flow in
- iOS:
Version 5.1.1 (21 October 2024) #
- 🚀 Improvements:
- Updated visibility of
ScanbotCameraWidgetState
to allow access tochannelName
.
- Updated visibility of
- 🐞 Bug fixes:
- Android:
- Fixed transitive resources issue for proper references across modules.
- Android:
Version 5.1.0 (20 September 2024) #
- 🎉 New:
- Introduced the redesigned RTU-UI version 2.0 for enhanced Barcode scanning, featuring advanced agile configuration options.
- Added support for the Micro PDF 417 barcode format.
- Added support for parsing AAMVA Certificate of Title for motor vehicle barcodes.
- Added a new field
shouldReturnCroppedImage
inBarcodeClassicScannerConfiguration
for theBarcodeScannerCamera
Classic UI. When set totrue
, the result will be returned in thebarcodeImageBase64
field of theBarcodeItem
model. - Added new RTU components:
- VIN Scanner: The
startVinScanner
component is designed to accurately scan and decode Vehicle Identification Numbers (VINs). This scanner is optimized to handle VINs from a variety of sources, including vehicle dashboards and registration documents, providing precise extraction and decoding of this critical vehicle information. - Check Scanner: With the
startCheckScanner
component, you can scan and recognize various check formats. This scanner processes checks to extract key data fields, enabling streamlined check processing and verification. - Text Data Scanner: The
startTextDataScanner
component extracts text data from documents using Optical Character Recognition (OCR). It is particularly useful for capturing and digitizing text from forms, invoices, and other text-heavy documents, facilitating efficient data entry and management. - Medical Certificate Scanner: The
startMedicalCertificateScanner
component is tailored for scanning and recognizing medical certificates. It supports various medical document formats, extracting essential information such as patient details, diagnoses, and treatment data, which is crucial for healthcare documentation and management.
- VIN Scanner: The
- Added new
ParametricFilter
APIs:ScanbotBinarizationFilter
CustomBinarizationFilter
ColorDocumentFilter
BrightnessFilter
ContrastFilter
GrayscaleFilter
WhiteBlackPointFilter
LegacyFilter
- Added support for German residence permits (2011 and 2019 formats) in GenericDocumentRecognizer.
PdfRenderingOptions
now allows setting thejpegQuality
for image encoding. Additional fields includepageFitMode
,dpi
, andresample
.- Introduced a new class
ScanbotSdkRecognizeOperations
with operations:recognizeMrzOnImage
recognizeMedicalCertificateOnImage
recognizeHealthInsuranceCardOnImage
recognizeGenericDocumentOnImage
recognizeCheckOnImage
- 🚀 Improvements:
- The Health Insurance Card Recognizer now implements the new Scanbot OCR engine. The recognition is faster and more accurate than before.
- Improved speed and quality of scanning for Generic Document.
- Improved detection of UPC/EAN barcode extensions in live mode.
- Improved speed and image quality of still image capturing.
- 🐞 Bug Fixes
- Fixed issue with misaligned barcode polygons on devices with horizontal orientation.
- Fixed a crash with BarcodeFormat.PDF_417 due to an uncovered cluster generation case.
- Fixed error handling in storage cleanup and page loading.
- ⚠️ Breaking Changes:
- Deprecated the Ready-to-Use UI v1.0 barcode scanners. Adoption of the RTU UI v2 scanner API is strongly recommended.
- Transitioned barcode result structures from record classes to
GenericDocument
, affecting RTU UI v1 but standardizing across RTU UI v1 and v2. - Renamed
BarcodeFormat.RSS_14
toBarcodeFormat.DATABAR
andBarcodeFormat.RSS_EXPANDED
toBarcodeFormat.DATABAR_EXPANDED
. - Eliminated the
LiveDetector
andCameraController
classes. Their functionalities are now integrated within the widgets. - Updated widgets to automatically adjust to configuration changes received by the camera widget constructors.
- Updated
BarcodeScannerCamera
Classic UI Component:- Previous Structure:
- Used
ScanbotCameraController
for camera control and barcode detection, withcameraDetector
andonWidgetReady
for initialization.
- Used
- New Structure:
- Simplified to use direct callbacks:
barcodeListener
for handling scanning results,errorListener
for error handling, andonCameraPreviewStarted
for setup after the camera preview starts.ScanbotCameraController
andcameraDetector
are no longer needed.
- Simplified to use direct callbacks:
- Previous Structure:
- Updated
DocumentScannerCamera
Classic UI Component:- Previous Structure:
- Relied on
DocumentCameraLiveDetector
for document scanning and separate listeners for results, errors, and document contours. RequiredScanbotCameraController
for control and initialization.
- Relied on
- New Structure:
- Consolidated functionality into the
DocumentScannerCamera
widget. UsessnapListener
for handling scanned pages,errorListener
for errors,documentContourListener
for document contours, andonCameraPreviewStarted
for setup after the preview starts.
- Consolidated functionality into the
- Previous Structure:
- Updated
MedicalCertificateScannerCamera
Classic UI Component:- Previous Structure:
- Used
MedicalCertificateCameraLiveDetector
andScanbotCameraController
for control and initialization. Includedfinder
andonWidgetReady
for UI setup.
- Used
- New Structure:
- Integrated all functionality into the
MedicalCertificateScannerCamera
widget. Now usesmcListener
for medical certificate results,errorListener
for error handling, andonCameraPreviewStarted
for setup. Enhancedfinder
configuration includes new UI options.
- Integrated all functionality into the
- Previous Structure:
- Removed Legacy Components:
- Removed
DocumentCameraLiveDetector
andScanbotCameraController
in favor of a streamlined approach. - Removed
MedicalCertificateCameraLiveDetector
; its functionality is now integrated directly into theMedicalCertificateScannerCamera
widget. - Removed the
LiveDetector
andCameraController
classes. Their functionality is now integrated directly into theBarcodeScannerCamera
widget.
- Removed
- 🚙 Under the Hood:
- Updated the native Scanbot iOS SDK to v5.1.3 (cf. changelog).
- Updated the native Scanbot Android SDK to v5.1.2 (cf. changelog).
- Android:
- Updated Kotlin to version 1.8.22 and set
jvmTarget
to "17". - Updated 3rd-party libraries:
libjpeg-turbo
to 2.1.5.1libpng
to 1.6.40libtiff
to 4.6.0- Added
zlib
library
- Updated Kotlin to version 1.8.22 and set
- iOS:
- Updated 3rd-party libraries:
zlib
to 1.3.1libtiff
to 4.6.0libjpeg-turbo
to 2.1.5.1libpng
to 1.6.40
- Updated 3rd-party libraries:
Version 4.2.3 (26 August 2024) #
- 🐞 Bug fixes:
- Android:
- Resolved a build failure in the
CameraDisplayOwner
class that occurred due to incorrect implementation of theLifecycleOwner
interface.
- Resolved a build failure in the
- Android:
Version 4.2.2 (12 April 2024) #
- 🐞 Bug fixes:
- iOS:
- Changed privacy manifest to comply with the latest Apple specs.
- iOS:
- 🚙 Under the hood:
- Updated the native iOS Scanbot SDK to 4.2.2 (cf. changelog)
Version 4.2.1 (5 February 2024) #
- 🐞 Bug fixes:
- Android:
- Fixed an unhandled exception when closing the Document Scanner classic component.
- Android:
Version 4.2.0 (12 January 2024) #
- 🎉 New:
- Added support for new barcode type
BarcodeFormat.GS1_COMPOSITE
. - Added analyzer image size limit property for Document Quality Analyzer
analyzeQualityOfDocument(Page page, Size? analyzerImageSizeLimit)
. IfanalyzerImageSizeLimit
not set, the image will be downscaled to 2500 px. - Added support for Kuwait ID cards in the MRZ scanner.
- Added support for new barcode type
- 🚀 Improvements:
- Added more control over how to handle GS1 messages in barcodes. See
BarcodeScannerAdditionalConfig.setGs1HandlingMode
.
- Added more control over how to handle GS1 messages in barcodes. See
- ⚠️ Breaking Changes:
- Replaced
BarcodeScannerConfiguration.gs1DecodingEnabled
withBarcodeScannerConfiguration.gs1DecodingMode
in the RTU-UI Barcode Scanner and Batch Barcode Scanner.
- Replaced
- 🐞 Bug fixes:
- Android:
- Fixed the Camera Preview blinking after capturing a picture.
- Android:
- 🚙 Under the hood:
Version 4.1.0 (15 December 2023) #
- 🎉 New:
- Added a new Optical Character Recognition engine based on machine learning algorithms that is usually much faster and less error prone. This new OCR engine currently supports all languages with latin letters, there is no need to specify the languages for it. The legacy engine, based on Tesseract, can still be used for non latin-based languages.
- New PDF renderer for simple PDFs and "sandwiched" PDFs generation.
- Added support for custom PDF metadata.
- Added support for portrait, landscape and auto locks for the page orientation.
- Extended the list of supported page sizes (A3, A5, B4, B5, etc.)
- Added new Document Quality Analyzer. Use
ScanbotSdk.analyzeQualityOfDocument
. - Added new barcode types:
AUSTRALIA_POST
,JAPAN_POST
,ROYAL_MAIL
,ROYAL_TNT_POST
,USPS_INTELLIGENT_MAIL
,DATABAR_LIMITED
. - Added
touchToFocusEnabled
to the RTU-UI scanner configs. - Added
CameraModule.BACK_WIDEST
to thecameraModule
config.
- 🚀 Improvements:
- Improved the document detector with better performance and less memory consumption.
- 🐞 Bug fixes:
- Fixed the behavior of the Barcode Scanner when an empty array is set. Now it scans all barcode types for iOS.
- ⚠️ Breaking Changes:
photoQualityPrioritization
parameter spelling was fixed in the Document Scanner.- Removed
autoCancelTimeout
parameter from the MRZ Scanner. - Removed
ScanbotSdk.estimateBlurOnPage
method. Use the newScanbotSdk.analyzeQualityOfDocument
method instead. - Removed
PdfRenderSize
enum in favor ofPageSize
class. - The default OCR engine has changed from
TESSERACT
toSCANBOT_OCR
. Please useTESSERACT
if you need to recognize non-Latin language texts.
- 🚙 Under the hood:
- Changed the behavior of classic components
cameraZoomFactor
parameter. Now 0..1 maps to the real zoom value in the range 1.0..12.0x on both Android and iOS. - Changed the behavior of the barcode data mapper callback.
- Updated the native iOS Scanbot SDK to 4.1.0 (cf. changelog)
- Updated the native android Scanbot SDK to 4.1.1 (cf. changelog)
- Changed the behavior of classic components
Version 2.13.6 (24 October 2023) #
- 🐞 Bug fixes:
- Fixed a bug where
documentContourListener
was not correctly returningDetectionStatus.OK
whenignoreBadAspectRatio: true
was set.
- Fixed a bug where
Version 2.13.5 (16 October 2023) #
- 🐞 Bug fixes:
- Fixed
ScanbotCroppingWidget
not showing the image whenencryptionEnabled
mode is set.
- Fixed
Version 2.13.4 (13 October 2023) #
- 🚀 Improvements:
- Optimized preview image quality in
ScanbotCroppingWidget
in Android. - Optimized behavior of
DocumentScannerCamera
. When scanning withignoreBadAspectRatio: true
, thedocumentContourListener
won't returnDetectionStatus.OK_BUT_BAD_ASPECT_RATIO
.
- Optimized preview image quality in
Version 2.13.3 (4 October 2023) #
- 🐞 Bug fixes:
- Fixed a focusing issue with the new iPhone 15 Pro and 15 Pro Max.
- Fixed an issue that prevented the Batch Barcode screen from starting.
Version 2.13.2 (26 September 2023) #
- 🎉 New:
- Added named parameters
originalImageSizeLimit
anddocumentImageSizeLimit
toScanbotSdk.createPage
,ScanbotSdk.createPageFromBytes
andDocumentClassicScannerConfiguration
that limits page images size to this value. If the image size exceeds the limit, the image will be downscaled to fit the limit. Cropped images will never be bigger than the original images. - Added
ContourConfiguration.showPolygonInManualMode
toDocumentScannerConfiguration
that allows to show/hide polygon contour when auto-snapping is disabled.
- Added named parameters
- 🚀 Improvements:
- Improved behavior of
DocumentScannerCamera
. Now it automatically reacts to the changes ofDocumentClassicScannerConfiguration.autoSnapEnabled
parameter. Hence, you can change this parameter and don't need to callliveDetector.setAutoSnappingEnabled
when changing this state by pressing a button. - Improved behavior of
CroppingController.rotateCw()
andCroppingController.rotateCCW()
. Now the call can be awaited so you can block UI elements during the rotation animation.
- Improved behavior of
- 🐞 Bug fixes:
- Fixed a bug with encryption where
EncryptionParameters.password
had a default empty value which is not correct. Nowpassword
is a required parameter to encrypt the data. - Fixed documentation for
acceptedAngleScore
andacceptedSizeScore
inDocumentClassicScannerConfiguration
. The range changed to 0-100 in percentage values. - Fixed behavior of document contour in
DocumentScannerCamera
. Now it's the same for both platforms. - Fixed
DocumentCameraLiveDetector.documentContourListener
callback. Now it always returns the detection status on iOS. - Fixed crash in iOS when partially filled sub-objects of RTU-UI configurations were set.
- Fixed a bug with encryption where
Version 2.13.1 (20 September 2023) #
- 🐞 Bug fixes:
- Fixed a bug in the RTU-UI Document Scanner due to an issue with config parsing.
Version 2.13.0 (15 August 2023) #
- 🎉 New:
- Added
MICRO_QR_CODE
barcode format toBarcodeFormat
. - Added
onCameraPreviewStarted
callback to custom components to get notified when the camera preview is started. It also runs each time the preview restarts after the picture is taken (Android). - Changed behavior of
onWidgetReady
callback in custom camera components. It is now called when the camera widget is initialized and ready to use. This happens not only once when the widget is created but also when the app returns to the foreground and the user pops to the camera page from another page, ifScanbotCamera.scanbotSdkRouteObserver
is registered. - Added barcode scanning classic component AR overlay feature.
- Added
BarcodeCameraConfiguration.overlayConfiguration
to configure the barcode scanning classic component AR overlay.
- Added
- 🚀 Improvements:
- Refactored behavior colors. The colors in RTU-UI screens that should be displayed as semi-transparent should be used with alpha as follows:
fillColor: Colors.red.withAlpha(150)
.
- Refactored behavior colors. The colors in RTU-UI screens that should be displayed as semi-transparent should be used with alpha as follows:
- 🐞 Bug fixes:
- Fixed bug with
ScanbotSdk.refreshImageUris
method on Android. Now it renews uris properly. ScanbotCroppingWidget
now properly reacts to thePage
object changes. If you reassign a new page to the page property (with a new id), it will reset its content and cropping state to the new state.- Fixed a bug when the camera is disabled, the document scanner screen could crash on iOS.
- Fixed bug with
- ⚠️ Breaking Changes:
- Refactored the structure of ALL RTU-UI scanners configuration classes. Please check example app and documentation for more details.
- Refactored the way we process and return the data for the Generic Document Scanner and MRZ Scanner. The structure of the result classes for the both scanners are changed to support the
GenericDocument
structure. Same as the native SDKs. Please check example app and documentation for more details. - Refactored imports structure inside scanbot_sdk. Please replace all scanbot_sdk related imports to
import 'package:scanbot_sdk/scanbot_sdk.dart';
in your code. For imports with the prefixes please useimport 'package:scanbot_sdk/scanbot_sdk.dart' as ScanbotSdk;
. Please check example app and documentation for more details.
- 🚙 Under the hood:
- Default set of params applied for all RTU-UI scanner configs if not specified explicitly.
- Added dart library
dart:collections
v.1.17.1 to the internal usage of scanbot_sdk,json_annotation
dependency updated to 4.8.1,environment:sdk
tool to>=2.17.0 <4.0.0
. - Updated the native iOS Scanbot SDK to 2.3.1-Beta4 (cf. changelog)
- Updated the native android Scanbot SDK to 2.3.0 (cf. changelog)
Version 2.12.1 (9 June 2023) #
- 🐞 Bug fixes:
- Fixed a crash in the iOS Classic components for when the scanners were closed multiple times.
Version 2.12.0 (8 May 2023) #
- 🎉 New:
- Added
IATA_2_OF_5
,INDUSTRIAL_2_OF_5
andCODE_25
barcode formats toBarcodeFormat
. - Added property
recognitionConfidenceValue
toMcPatientInfoField
.
- Added
- 🚀 Improvements:
- Improved behavior of Classic UI components for asynchronous communication with the native SDK.
- ⚠️ Breaking Changes:
- Changed structure of
MedicalCertificateRecognizerResult
:McInfoBoxSubType
renamed toMedicalCertificateCheckBoxType
.McPatientInfoFieldType
renamed toMedicalCertificatePatientInfoFieldType
.MedicalCertificateInfoBox
type split intoMedicalCertificatePatientInfoField
andMedicalCertificateCheckBox
.MedicalCertificateInfoBox.patientInfoFields
property now available asMedicalCertificateInfoBox.patientInfoBox.patientInfoFields
.DateRecord.validationConfidenceValue
removed.
- Removed parameter
decodeStacks1D
. The decoding of stacked barcodes is now handled automatically.
- Changed structure of
- 🚙 Under the hood:
Version 2.11.0 (27 March 2023) #
- 🎉 New:
- Introduced Classical Components for the Medical Certificate Scanner that allow you to build your own flexible and fully customizable UI for Scanning German Medical Certificates. Use the classes
MedicalCertificateScannerCamera
andScanbotCameraController
to build a custom document scanner UI.
- Introduced Classical Components for the Medical Certificate Scanner that allow you to build your own flexible and fully customizable UI for Scanning German Medical Certificates. Use the classes
- 🚙 Under the hood:
Version 2.10.1 (20 January 2023) #
- 🎉 New:
- Introduced Classical Components for Cropping Page that allow you to build your own flexible and fully customizable UI for cropping Page Objects. Use the classes
ScanbotCroppingWidget
andCroppingController
to build a custom cropping UI.
- Introduced Classical Components for Cropping Page that allow you to build your own flexible and fully customizable UI for cropping Page Objects. Use the classes
- ⚠️ Breaking Changes:
- Renamed
DetectionResult
toDetectionStatus
- Renamed
FinderInsets
toInsets
- Renamed
- 🐞 Bug fixes:
- Fixed
enableCameraButtonTitle
andenableCameraExplanationText
in EHIC and MRZ Scanners - Fixed image saving for classical document scanner on android
- Fixed
Version 2.10.0 (17 November 2022) #
- 🎉 New:
- Introduced Classical Components for Document Scanning that allow you to build your own flexible and fully customizable UI for the document scanner. Use the classes
DocumentScannerCamera
,DocumentCameraLiveDetector
, andScanbotCameraController
to build a custom document scanner UI. - Added
GS1
barcode document toBarcodeDocumentFormat
.
- Introduced Classical Components for Document Scanning that allow you to build your own flexible and fully customizable UI for the document scanner. Use the classes
- ⚠️ Breaking Changes:
- Changed file location of Barcode Scanner and Batch Barcode Scanner related classes.
- Renamed
AcceptedDocumentFormat
toBarcodeDocumentFormat
- Renamed
CameraOrientationMode
toOrientationLockMode
- 🚙 Under the hood:
Version 2.9.1 (28 September 2022) #
- 🐞 Bug fixes:
- Fixed compatibility issues with Xcode 14 (build error)
- Fixed compatibility issues with Kotlin 1.7.10 (build error)
Version 2.9.0 (22 June 2022) #
- 🎉 New:
- Introduced Classical Components for Barcode Scanning that allow you to build your own flexible and fully customizable UI for the barcode scanner. Use the classes
BarcodeScannerCamera
,BarcodeCameraLiveDetector
andScanbotCameraController
to build a custom scanner UI.
- Introduced Classical Components for Barcode Scanning that allow you to build your own flexible and fully customizable UI for the barcode scanner. Use the classes
- 🚀 Improvements:
- Improved 1D barcode recognition
- 🚙 Under the hood:
Version 2.8.3 (31 May 2022) #
- 🚀 Improvements:
- Updated README
Version 2.8.2 (31 May 2022) #
- 🐞 Bug fixes:
- Fixed compatibility issues with Flutter v3.0.1+
Versions 2.8.1 (16 March 2022) #
- 🐞 Bug fixes:
- Fixed
LicenseExpirationDate
: Invalid date format.
- Fixed
Version 2.8.0 (8 March 2022) #
- 🎉 New:
- Introduced the
Generic Document Recognizer
, providing the ability to scan various types of documents, includingGerman ID cards
,German passports
andGerman driver's licenses
- Added
detectBarcodesOnImages
inScanbotSdk
for detecting barcodes on multiple still images. - Android: Added
useCameraX
inScanbotSdkConfig
. You can now enable CameraX under the hood. - Android: Added
allowXnnpackAcceleration
inScanbotSdkConfig
which allows controlling whether the XNN pack optimizations should be used. - Android: Added
allowGpuAcceleration
inScanbotSdkConfig
which enables GPU acceleration for TensorFlow ML models. - Added the ability to disable auto-focus by locking the lens at the specified lens position. See
minFocusDistance
inBarcodeScannerConfiguration
andBatchBarcodeScannerConfiguration
- Introduced the
- 🚀 Improvements:
- Improved Aztec barcode recognition.
- Improved PDF417 recognition performance on single photos.
- Improved barcode detection on large documents.
- Improved GS-1 databar recognition in the next-gen barcode scanner.
- 🐞 Bug fixes:
- Fixed
LicenseExpirationDate
returning the incorrect time.
- Fixed
- ⚠️ Breaking Changes:
- Renamed
detectBarcodeFromImageFile
parameter todetectBarcodesOnImage
- Renamed
- 🚙 Under the hood:
Version 2.7.0 (3 Dec 2021) #
- 🎉 New:
- Added
createPageFromBytes
function to create a page object without storing a temporary image object outside the SDK - Added support for
AcceptedDocumentFormats
inBarcodeScannerConfiguration
,BatchBarcodeScannerConfiguration
anddetectBarcodeFromImageFile
- Added
- 🚀 Improvements:
- Significant performance improvements for all scanners
- 🚙 Under the hood
- 🐞 Bug fixes:
- Fixed
CroppingResult.error()
return forCroppingResult
object in the page cropping component
- Fixed
Version 2.6.0 (23 Jul 2021) #
- 🎉 New:
- Brand new "Next Generation" machine-learning-based barcode scanning engine with improved reliability and much faster performance
- API changes for the new barcode engine: added
engineMode
property of typeEngineMode
on barcode scanning APIs -BarcodeScannerConfiguration
andBatchBarcodeScannerConfiguration
to switch between the legacy barcode engine and the new Next Generation barcode engine. By default, the new engine is used. - Added the new
cameraZoomFactor
property inBarcodeScannerConfiguration
for configuring the zoom level of the camera. - Added support for MSI Plessey barcodes.
- 🚙 Under the hood
- Updated the native iOS Scanbot SDK to 1.19.3 (cf. changelog)
- Updated the native Android Scanbot SDK to 1.85.1 (cf. changelog)
- ⚠️ Breaking Changes:
- Removed
enableHighSensitivityMode
property onBarcodeScanner
, because it is no longer needed
- Removed
Version 2.5.0 (2 Jun 2021) #
- 🎉 New:
- Added NFC Passport Reader.
- Add License Plate scanner for the EU cars license plates.
- 🚙 Under the hood:
- Updated the native iOS Scanbot SDK to 1.15.1 (cf. changelog)
- Updated the native Android Scanbot SDK to 1.83.0 (cf. changelog)
Version 2.4.1 (1 Apr 2021) #
- 🐞 Bug fixes:
- iOS: Fixed a mapping issue of the config parameter
flashButtonHidden
in the Document Scanner.
- iOS: Fixed a mapping issue of the config parameter
Version 2.4.0 (30 Mar 2021) #
- 🎉 New:
- Add null safety support for the SDK.
- ⚠️ Breaking Changes:
- Due to null safety support update please follow compilation issues and warnings from 'flutter analyze' command
- Updated minimum dart sdk to
2.12.0-0
and flutter to2.0.1
Version 2.3.0 (11 Mar 2021) #
- 🎉 New:
- Encryption for images, PDF, and TIFF files, generated by the SDK. For more details please check out the section Storage Encryption.
- Blur estimation feature. See the new API function estimateBlurOnPage.
- 🐞 Bug fixes:
- iOS: Multiple UI fixes for barcode scanners.
- 🚙 Under the hood:
- Updated the native iOS Scanbot SDK to 1.14.0 (cf. changelog)
- Updated the native Android Scanbot SDK to 1.80.0 (cf. changelog)
Version 2.2.2 (16 Feb 2021) #
- ⚠️ Breaking Changes:
- Android compileSdkVersion is set to 30
- Increase flutter min support version to 1.22.6
- 🐞 Bug fixes:
- Fix compilation for compileSdkVersion 30 for android
Version 2.2.1 (12 Feb 2021) #
- 🐞 Bug fixes:
- Added missing permission text properties
enableCameraButtonTitle
andenableCameraExplanationText
toDocumentScannerConfiguration
- Added missing permission text properties
Version 2.2.0 (12 Feb 2021) #
- 🎉 New:
- Batch Barcode Scanner - a new RTU-UI screen component to scan multiple barcodes in a row.
See the new API function
startBatchBarcodeScanner
. - Added barcode detection from still images, see
detectBarcodeFromImageFile
. - New result field
BarcodeItem.rawBytes
that contains the raw bytes from the scanned barcode.
- Batch Barcode Scanner - a new RTU-UI screen component to scan multiple barcodes in a row.
See the new API function
- ⚠️ Breaking Changes:
- Replaced
finderAspectRatio
parameter withfinderWidth
andfinderHeight
inBarcodeScannerConfiguration
andMrzScannerConfiguration
.
- Replaced
- 🚙 Under the hood:
- Updated the native Android Scanbot SDK to 1.77.2 (cf. changelog)
- Updated the native iOS Scanbot SDK to 1.13.0 (cf. changelog)
Version 2.1.0 (15 Dec 2020) #
- 🐞 Bug fixes:
- iOS: Introduced a new API method
refreshImageUris(pages)
to fix image file paths after app updates. For more details please check out the section Persistence of Page Objects. - iOS: Fixed de-/serialization of the property
Page.detectionStatus
.
- iOS: Introduced a new API method
Version 2.0.1 (28 Nov 2020) #
- 🚀 Improvements:
- iOS: Swift 5 support
Version 2.0.0 (30 Oct 2020) #
- 🎉 New:
- A new Machine Learning based approach for document detection.
See the new SDK initialization parameter
documentDetectorMode
. - Barcode Scanner: Added barcode data parsers for several document types. See the new result field
BarcodeItem.formattedResult
as well as the corresponding implementations ofBarcodeFormattedResult
.
- A new Machine Learning based approach for document detection.
See the new SDK initialization parameter
- 🚀 Improvements:
- Android: Some big improvements in the Document Scanner UI that make document scanning perform better and much smoother. Decreased start-up time of the camera preview. Faster saving of the snapped pages. Optimized performance of the image processing for simple operations (rotate, crop, resize).
- Barcode Scanner: Multi-barcode scan support!
- ⚠️ Breaking Changes:
- Android: Migrated to Android embedding v2
- Android: Raised
minSdkVersion
to21
- iOS: Dropped support for iOS 9 and iOS 10!
- 🚙 Under the hood:
- Upgraded the native Scanbot Android SDK to v1.74.0 (cf. changelog)
- Upgraded the native Scanbot iOS SDK to v1.11.6 (cf. changelog)
Version 1.1.4 (29 Sep 2020) #
- 🚀 Improvements:
- iOS: Changed presenter logic for all Scanbot SDK RTU-UI screens.
Version 1.1.3 (27 Aug 2020) #
- 🐞 Bug fixes:
- iOS: Fixed a mapping issue of the config parameter
doneButtonTitle
in Cropping UI.
- iOS: Fixed a mapping issue of the config parameter
Version 1.1.2 (28 May 2020): #
- 🚀 Improvements:
OperationResult.CANCELED
when the user pressescancel
in any Scanbot UI screen component
Version 1.1.1 (13 May 2020): #
- 🐞 Bug fixes:
- Android: Fixed a bug with mappings of OCR language data files
(
zh-Hans
andzh-Hant
tochi_sim.traineddata
andchi_tra.traineddata
).
- Android: Fixed a bug with mappings of OCR language data files
(
Version 1.1.0 (9 Dec 2019): #
- 🎉 New:
- Added further TIFF options
dpi
andcompression
. See createTiff(pages, options).
- Added further TIFF options
- 🚀 Improvements:
- Improved OCR API. The OCR results now contain bounding boxes and values of recognized words, lines and paragraphs.
See the API docs of
OcrResult.pages
for more details.
- Improved OCR API. The OCR results now contain bounding boxes and values of recognized words, lines and paragraphs.
See the API docs of
- 🐞 Bug fixes:
- iOS: Fixed file URI handling in the native implementation of the
createPage()
method.
- iOS: Fixed file URI handling in the native implementation of the
Version 1.0.0 (6 Nov 2019): #
- 🎉 First release.