Getting startedChoosing SDK mode

Choosing SDK mode

The SDK offers several modes of integration, depending on how much of the user experience (UX) you want to use out of the box or build yourself.

Option 1: Full UX Flow (Default)

By default, the SDK provides a complete guided experience for end-users, including:

  • Step-by-step instructions
  • Camera feedback and positioning hints
  • Result interpretation and health risk assessments

This is called the Full UX flow and is ideal if you want a ready-to-use experience. However, note that some parts of the embedded UI such as text content or how results are displayed cannot currently be customized.

Screens

All available customization options (e.g., themes, visible metrics, screen visibility) can be explored in the web playground.

See Providing the user interface for details on how to place the SDK’s view in your app.

Option 2: Partially Custom UI (Camera Feed Only)

If you need more control but still want the SDK to handle camera feedback, you can choose a mode that shows:

  • Only the camera feed
  • Positioning hints
  • Visual overlays

To disable the built-in UI elements, set the following settings during initialization (in InitializationSettings):

  • showUserInterface: false to hide all UI elements
  • Set onboardingMode to HIDDEN so that camera preview is shown immediately after initialization

You can manage the rest of the UI independently, using the SDK API to retrieve real-time data and events.

You’ll still need to create the SDK view in your app, but it will only show the camera feed and positioning hints without any additional UI elements.

Option 3: Full Custom UI (No Visual Elements)

For maximum flexibility, you can disable the SDK’s entire embedded interface and build your own UX from scratch. This is useful if:

  • You want to fully control the look and feel
  • You’re running measurements in the background
  • You’re providing camera feedback via your own interface

To use the SDK in this mode, set showUserInterface: false in InitializationSettings during initialization, and omit creating the SDK view in your app altogether.

You’ll still have full access to all SDK data and events through the API.

Getting startedAuthorization
;