Release Notes Version 5.1.0

Prev Next

Deprecations

Android

QRCodeScannerSDKActivity

The QRCodeScannerSDKActivity class has been declared deprecated and will be removed in a future release. Build your own camera UI with CameraX and call QRCodeScannerSDK.decodeImage instead. For more information, see Integrate the Image Scanner SDK.

QRCodeScannerSDKConstants

The QRCodeScannerSDKConstants class, containing the constants, has been declared deprecated and will be removed in a future release.

New features and enhancements

Android

SDK source code rewritten in Kotlin

The Android source code of the SDK has been rewritten in Kotlin. The code is compatible with Java. This allows the code to be more robust, subject to fewer bugs, and more easily maintained. The API reference included in the product documentation is now generated with Dokka and covers the Kotlin sources. A javadoc.jar file is is available in the product package. And the sample app included in the product package has also been converted to Kotlin.

Java code that calls the SDK continues to compile without changes. Static methods, constants, and getters remain the same from Java (@JvmStatic, @JvmField, const val).

A few aspects change when integrating the SDK:

  • QRCodeScannerSDKConstants is now a Kotlin object, not a Java interface.

    // Before
    class MyScanner implements QRCodeScannerSDKConstants { ... QR_CODE ... }
    // After
    QRCodeScannerSDKConstants.QR_CODE
  • Kotlin callers now receive explicit nullability information instead of platform types. QRCodeScannerSDKDecodingResultData.scannedImageData is now exposed as String? and must be null-checked before use.

    val result = QRCodeScannerSDK.decodeImage(imageProxy, QRCodeScannerSDKConstants.QR_CODE)
    result.scannedImageData?.let { data -> /* handle decoded data */ }

To avoid compilation issues, you must add the Kotlin dependencies to the build.gradle file.

Maven-based integration

The SDK artifact is now delivered as a local Maven repository, in addition to the previously published standalone aar artifact, and the package now also includes a documentation jar file. For more information, see Maven-based integration.

iOS

Breaking change: xcframework now dynamic

MSSImageScanner.xcframework is now a dynamic framework.

You must embed MSSImageScanner.xcframework into your app. If you only link it, the app will terminate unexpectedly at launch!

To embed MSSImageScanner.xcframework, in Xcode, go to Frameworks, Libraries, and Embedded Content and set it to Embed & Sign.

As side-effect of this change, you no longer need to link the C++ standard library. The framework now loads libc++ itself and you can remove the libc++ or -lc++ link from your target, if you added it only for this SDK.

Enhanced error lookup

The technical documentation provided in the product package now includes the numeric value of each error code (ImageScannerErrorCodes), making error lookup easier.

Fixes and other updates

All platforms

[MSS-14059—Support case INC0016884] Unexpected termination during Cronto image decoding

Description: Sometimes while decoding Cronto images the SDK would access memory out-of-bounds, leading to a native unexpected termination of the app or returning unreliable decoding results.

Status: This issue has been fixed.

Android

Unexpected termination due to library mismatch

Description: The sample included in the product package terminated unexpectedly due to a mismatched version of the zxing-cpp library.

Status: This issue has been fixed.

[MSS-13978—Support case INC0016764] Inverted QR codes not scanned

Description: The SDK did not support scanning inverted QR codes. When a QR code with a black or dark background and white QR modules, or a code displayed in dark mode with inverted colors, was scanned from an app, the SDK did not detect it and threw an error. It only scanned QR codes with white backgrounds and black QR modules correctly.

Status: This issue has been fixed. The SDK now correctly decodes QR codes with inverted colors (light modules on a dark background) and rotated QR codes with decodeImage and decodeBitmap.

Supported platforms

For information on the supported operating systems and platforms supported by Mobile Security Suite and the affiliated SDKs, see Supported platforms.

Known issues

For information on issues that have not yet been resolved in this release of Mobile Security Suite, see Known issues.

API reference documentation and sample applications

To learn more about the public APIs and their functions, exceptions, and error codes, refer to the technical documentation that is included in the product package for each SDK and each platform. In the product package, you can also find the sample applications provided for each platform to see examples of how the SDKs can be used.

These sample apps are intended only to demonstrate basic scenarios and SDK usage. They are not designed to be copied directly into production projects!

Third party licenses

For information on third party dependencies associated with Mobile Security Suite and the affiliated SDKs in this release, see Third party licenses.