Parameters#

The Tokkio UI configuration options are provided below:

Tokkio UI Configuration#

UCS Parameter

Environment Variable

Default Value

Description

appTitle

APP_TITLE

NVIDIA

The title of the application displayed in the top bar.

enableCountdown

ENABLE_COUNTDOWN

false

Set to true to enable a countdown timer. Set to false to disable the countdown timer.

countdownDuration

COUNTDOWN_DURATION

180

The number of seconds to count down from before ending the user’s session.

enableFeedback

ENABLE_FEEDBACK

false

Set to true to enable the feedback overlay. Set to false to disable the feedback overlay.

enableMic

ENABLE_MIC

true

Set to true to enable the microphone toggle. If false, the microphone will always be unmuted.

enableFullscreenToggle

ENABLE_FULLSCREEN_TOGGLE

true

Set to true to enable the full-screen toggle. If false, the user will not be able to toggle the UI into full-screen mode.

enableStartPage

ENABLE_START_PAGE

false

Set to true to enable the start page. If true, the user will see a start page with a button to start the session. If false, the avatar will be displayed immediately.

enableTopBar

ENABLE_TOP_BAR

true

Set to true to enable the top bar. If false, the top bar will not be displayed.

enableLogs

ENABLE_LOGS

true

Set to true to enable the logs. If false, the logs will not be displayed in the user’s browser console.

enableOverlay

ENABLE_OVERLAY

true

Set to true to display the bottom overlay with the controls in the UI. Setting this to false will hide the overlay and only show the digital human video stream.

enableCustomView

ENABLE_CUSTOM_VIEW

true

Set to true to enable the custom UI feature in the UI.

enableASRTranscripts

ENABLE_ASR_TRANSCRIPTS

true

Set to true to enable the ASR transcripts. If false, the transcripts for the user’s speech will not be displayed.

enableTTSTranscripts

ENABLE_TTS_TRANSCRIPTS

true

Set to true to enable the TTS transcripts. If false, the transcripts for the digital human’s speech will not be displayed.

enableErrorCode

ENABLE_ERROR_CODE

true

Set to true to show the error code in the UI when the user encounters an error and is sent to the error page.

enableDetailedErrorMessages

ENABLE_DETAILED_ERROR_MESSAGES

true

Set to true to show the detailed error messages in the UI when the user encounters an error and is sent to the error page. Setting this to false will show a less descriptive, but more user-friendly error message.

enablePip

ENABLE_PIP

false

Set to true to enable the picture-in-picture toggle in the UI.

ingressEndpoint

INGRESS_ENDPOINT

This should be set to be the endpoint where the UI can call the APIs of the Ingress service.

aceControllerWebsocketEndpoint

ACE_CONTROLLER_WEBSOCKET_ENDPOINT

This should be set to the endpoint where the UI can make a WebSocket connection to the ACE Controller service.

vstWebsocketEndpoint

VST_WEBSOCKET_ENDPOINT

This should be set to the endpoint where the UI can make a WebSocket connection to the VST service.