Choosing SDK mode

By default, the SDK guides end-users through the measurement process, providing feedback, results interpretation, and health risk assessments.

You can use the default configuration or customize the SDK to fit your needs. All screens and UI elements can be configured or disabled, down to displaying only the camera feed. You can also opt to exclude all SDK-provided visuals entirely, running the measurement in the background.

Full UX flow

In the default mode, the SDK provides a complete user experience, guiding users through the measurement process and displaying results.

The color theme and displayed metrics can be adjusted, and non-measurement screens can be disabled. Explore all available customization options in the web playground at playground.shen.ai.

Camera feedback

If the available customization options are insufficient, the SDK can operate in a mode that displays only the camera feed, positioning hints, and visualizations. You retain full control over the rest of the UI, retrieving data from the SDK’s API as needed.

No visual elements

The SDK can also be used without any visual elements. This mode is ideal for scenarios where the SDK performs measurements without user interaction—such as in the background—or if camera feedback is provided by other means.

To customize the SDK’s visual experience, set the appropriate options during initialization or at runtime (see Configuration).