Choosing SDK mode

The SDK can provide the whole measurement UI, only the camera view, or no visible UI at all. Choose the mode based on which parts of the user experience your app needs to own.

Option 1: Full SDK UI (Default)

Use this mode when you want the SDK to render the complete measurement flow.

The SDK shows:

• onboarding and instructions
• camera preview, face positioning, and visual warnings
• START and STOP controls
• measurement progress
• results, summary screens, and health risk screens when enabled

This is the fastest integration path. It is best when the built-in flow matches your product. Some embedded UI details, such as text content and result layout, cannot currently be customized.

All available customization options, including themes, visible metrics, and 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: SDK Camera View With App UI

Use this mode when your app owns the controls and screen layout, but you still want the SDK to render the camera view and measurement guidance.

The SDK view stays visible and can show the camera feed, face positioning overlay, and visual warnings. Your app renders the surrounding UI and calls SDK APIs to start or stop measurements, read results, and react to SDK events.

Common initialization settings:

• showUserInterface: false hides SDK controls, result tiles, and built-in screens.
• onboardingMode: HIDDEN shows the camera preview immediately after initialization.
• Keep showFacePositioningOverlay and showVisualWarnings enabled if you want SDK guidance on top of the camera feed.

You still need to create the SDK view. Use measurement APIs for your own START and STOP controls, and use SDK events to keep your UI in sync with the measurement flow.

Option 3: Fully Custom UI

Use this mode when your app owns the full visual experience.

In this setup, your app does not create the SDK view. The SDK does not render camera preview, overlays, controls, or results. Your app must provide the user interface for camera access, guidance, progress, and results.

Set showUserInterface: false in InitializationSettings and omit the SDK view.

You still have access to SDK methods, measurement data, and SDK events through the API. This mode is useful for background measurements, native camera pipelines, and products that need a fully custom interface.