Handling measurement results
Handling measurement results
Once a measurement has started, the Shen AI SDK communicates with your application through a series of events. These events tell you what's happening during the measurement, help you guide the user, and notify your application when the results are ready.
This guide explains how the measurement flow works and what your application should do at each stage.
The measurement lifecycle
Throughout the scan, the SDK sends events that describe its current state.
In a typical measurement, your application will receive events in the following order:
1. The measurement starts.
2. Progress and guidance events are reported while the scan is running.
3. The SDK either returns the final results or reports that the measurement couldn't be completed.
Monitoring measurement progress
While the user is being scanned, the SDK continuously reports progress. Your application can use these updates to display a progress indicator or let users know that the measurement is still running.
The SDK also provides guidance events when the current conditions could affect measurement quality. For example, the user may need to hold the device more steadily, improve the lighting, or reposition their face.
Responding to these events in real time creates a much smoother user experience than waiting until the measurement has finished.
Receiving the results
When the measurement is complete, the SDK returns the requested physiological measurements to your application. The exact data depends on your SDK configuration and subscription plan.
Once the results are available, your application can:
- display them to the user,
- save them for future reference,
- send them to your backend,
- or use them in other workflows.
If you've enabled health indices, these are also returned after the measurement and can be processed alongside the physiological measurements.
Handling warnings and errors
Warnings let your application know that the measurement can continue, but that the current conditions may affect the result. For example, lighting may not be ideal or the user may be moving too much.
Errors indicate that the measurement couldn't be completed successfully. When this happens, your application should explain the issue to the user and offer another attempt where appropriate.
Next step
Now that you know how the SDK communicates during and after a measurement, you're ready to build a user experience around those results. Continue with Customizing the measurement experience, where you'll learn how to adjust the SDK to your exact needs and branding.
