Reader SDK Documents
Reader SDK Documents
Breadcrumbs

v3.0.0

1. Overview

This release introduces improvements to visualization, error reporting, and platform compatibility across Android and iOS.
The update also includes dependency upgrades and small API changes that may require adjustments in your integration.

2. New Features (Shared)

2.1. SVG Visualization Support

  • Description: Reader overlay now supports SVG path-based visualizations.

  • Default Behavior: Existing configurations continue using DotMatrix visualization mode automatically.

  • Migration Note:
    To use the new SVG visualization, request an updated reader configuration file containing pathData.
    No code changes are required for apps that continue using the default mode.

2.2. New Exposure Strip Error Icon

  • Description: A new, dedicated icon is displayed for exposure-related errors, replacing the generic alert triangle.

  • Developer Impact: No code changes required. The updated icon appears automatically when exposure errors are detected.

3. Breaking vs. Non-breaking Summary

Change Type

Impact

Platforms

Visualization Mode (SVG)

Additive – no API changes required unless adopting new configuration

Android, iOS

Exposure Strip Error Icon

Non-breaking visual enhancement

Android, iOS

PMF Loader Parameter Change

Breaking (method signature and parameter label/type changed)

Android, iOS

Dependency Upgrades (Java 17, AGP, NDK, etc.)

Potentially breaking for projects on older toolchains

Android

OpenCV Library Update

Non-breaking (binary compatible)

Android, iOS

4. When to Upgrade

Recommended For:

  • Integrators needing SVG overlay support for richer visualization control.

  • Teams maintaining Play Store–published Android apps (Java 17, AGP 8.9, 16KB page size, SDK 35 compliance).

  • Projects aiming for improved readability of exposure error feedback in UI.

Not Required For:

  • Integrations that do not require SVG path visualization or already use stable DotMatrix rendering.

  • Internal builds not targeting recent Play Store SDK/NDK compliance deadlines.

5. Compatibility Notes

  • Android: Requires Gradle Plugin 8.0+ and JDK 17 or later.
    Confirm compileSdk = 35 and targetSdk = 35 in your project settings.

  • iOS: no build tool changes.

  • Reader Configuration Files: Existing configurations remain valid; SVG mode only activates when pathData is included in the configuration.

6. Summary of Developer Actions

Platform

Area

Action Required

Android

Java/Kotlin target

Migrate build settings to Java 17

Android

Named params in PMF loader

Rename parameter if used

Android

Build environment

Update AGP, SDK 35, NDK 29, CMake 3.22

iOS

PMF loader

Update to loadAnalyserConfiguration(from:) and pass Data

Both

OpenCV

Ensure binary compatibility after upgrade

7. Platform-Specific Notes

See detailed examples and API notes in: