v2.1.1 | NDX Reader SDK Documents

1. Overview

Reader SDK v2.1.1 introduces the PMF Story data model, abort functionality, and enhanced per-frame callbacks that provide richer insight into the analysis process.
These foundational changes enable detailed frame-level diagnostics and laid the groundwork for future visualization and data capture improvements in later versions.

2. New Features

2.1. PMF Story Output

A new structured data model, PMF Story, is now included in the SDK output.
It provides a complete timeline of captured frames during the analysis process, recording details such as:

Timestamp
PMF status (analysis state)
Lux (lighting level)
Device orientation
Homography transform
Per-strip baselines, profiles, and statuses
Frame and strip images

This enables developers to visualize analysis progress, collect diagnostic logs, and post-process frame data.

2.2. Abort Functionality

Developers can now abort analysis sessions early and retrieve all PMF Story frames captured up to that point.
This allows partial data review even if the full analysis doesn’t complete.

The returned ResultModel includes a complete pmfStory with all frames collected before the abort.
Aborted sessions cannot be resumed — a new analysis must be started afterward.

Both Android and iOS expose new abort-related API elements (see platform pages for examples).

2.3. Per-Frame Callback Expansion

The previous onProgress callback has been replaced by onFrameCaptured, which provides richer context for each captured frame.
This callback now includes analysis progress, lux, orientation, and status information per frame.

3. API Changes

3.1. Model Updates

The addition of PMF Story required updates to the ResultModel and TestStrip data structures to eliminate duplicate image storage and improve consistency.

Model	Old	New
TestStrip	Included `stripImageBase64`	Removed; images now stored in PMF Story frames
ResultModel	Included `fullImageBase64`	Removed; replaced by per-frame images in PMF Story

These changes affect integrations that previously accessed image data directly from the result models.
Developers should now access frame and strip images from ResultModel.pmfStory.

4. Internal Enhancement

Collection Mode
An internal capture-only mode for development and QA.
This mode performs no analysis and is not available in the public SDK.

5. Developer Migration Summary

Area	Action Required
Image Access	Use `pmfStory` for per-frame images instead of old base64 fields
Progress Callbacks	Replace `onProgress` with `onFrameCaptured`
Aborting Analysis	Implement abort handling for partial results
Collection Mode	No developer action (internal only)

6. Platform-Specific Notes

See detailed examples and API notes in: