Skip to main content

​
Overview

Telehealth sessions are a special type of ambient session that you can use for remote patient care. The Suki Web SDK (version 2.1.0 and later) now supports capturing audio from different tabs directly from your browser.
Compatibility:
  • Supported: Audio capture from different tabs in the same browser window (with or without a headset).
  • Not Supported: Audio capture from local or native desktop applications (e.g., a standalone Zoom or Teams app).

​
How To Enable Telehealth Feature

This feature is an opt-in setting and is disabled by default. To enable this feature, follow these steps:
1

Navigate to Settings

In the Suki Web SDK UI, navigate to the Ambient Settings option.
Settings
2

Turn on Telehealth Audio Capture

Turn on the Enable audio from web toggle button.
Telehealth Audio Capture

​
How It Works

When you enable Telehealth Audio Capture and click Start Ambient or Re-Ambient, the SDK prompts you to share your screen.
You must select the browser tab that contains your telehealth call.
The browser modal to select a screen, window, or tab to share.
In the browser’s share modal, you must also select the Also Share Tab Audio (or similar) checkbox.

​
Session Behavior

The following are the different states of the ambient session when telehealth audio capture is enabled:

On Pause

If you close the shared tab or click the browser’s Stop Sharing button, the ambient session will automatically pause.

On Resume

To restart the session, click Resume in the SDK. This action will open the browser’s share modal again.

On Window/Screen Selection

The SDK uses experimental browser APIs to capture audio. While you must share a tab, selecting a Window or Screen by mistake should not result in an error.

​
Recommendations For Partners

For the best compatibility and performance, follow these recommendations:
  • Use the latest version of Google Chrome.
  • Use browser-based telehealth workflows.
  • When you use the browser’s Share screen modal, you may see an option to share system audio if you select a specific window or your entire screen.
Suki does not officially support sharing system audio. While these options may appear and might be experimentally available in different browsers or operating systems, they are inconsistent and may not function correctly.
Suki only supports sharing tab audio. You must ensure that you select a browser tab and enable the tab audio option when prompted.

​
Error Handling

Cause: This error occurs if you did not select the Also Share Tab Audio checkbox in the browser’s share modal. The SDK requires the tab’s audio stream to function.Solution: Start the ambient session again. In the share modal, make sure you select the correct browser tab and enable the Also Share Tab Audio option.

​
Next Steps

Refer to Brading guide to learn more about how to brand the Suki Web SDK.