Parameters#

The Tokkio UI configuration options are provided below:

Tokkio UI Configuration#

Parameter

Default Value

Description

app_title

NVIDIA

The title of the application displayed in the top bar.

enable_countdown

false

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

countdown_duration

180

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

enable_feedback

false

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

enable_mic

true

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

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.

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.

enable_top_bar

true

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

enable_logs

true

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

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.

enable_custom_view

true

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

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.

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.

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.

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.

iframe_redirect

When running the Tokkio UI as an iframe in another website, set this parameter to the URL of the parent website. This will redirect the user to the parent website when attempt to open the iframe directly.

enable_pip

false

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

ingress_endpoint

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

ace_controller_websocket_endpoint

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

vst_websocket_endpoint

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

Changing the Parameters#

Note

The below options are only available for a UI deployed within the Kubernetes cluster. For a UI deployed outside the cluster on a CSP, or from source code, the below options will not work. If using a CSP, visit the configuration section for details, parameters can be set through spec > app > configs > ui_settings > user_env_vars. When configuring the UI in this way, variable names should be in all caps (e.g. app_title becomes APP_TITLE).

The UI parameters can be changed in the following ways:

  • Using the ACE Configurator

  • Using helm upgrade

  • Using values.yaml

Change the UI Parameters Using the ACE Configurator#

If you are already using the ACE Configurator, you can change the UI parameters by downloading the UI configuration file through the ACE configurator, editing the parameters in the file, then uploading the file. The UI will automatically restart with the new configuration.

Change the UI Parameters Using helm upgrade#

If you do not want to use the ACE Configurator, the UI parameters may also be updated by using the following helm upgrade command:

helm upgrade <release-name> <path/to/helm/chart> -n app --reuse-values --set tokkio-ui.uiConfig.config.<config-name>=<config-value>

For example, to change the app title to My Awesome App, the following command can be used:

helm upgrade tokkio-app <path/to/helm/chart> -n app --reuse-values --set tokkio-ui.uiConfig.config.app_title="My Awesome App"

Change the UI Parameters Using values.yaml#

For UI parameters to persist between deployments, the parameters can be set in the tokkio-ui.uiConfig section of the values.yaml file. If using this method, the app will need to be redeployed to apply the changes.

tokkio-ui:
  uiConfig:
    config:
      app_title: "My Awesome App"
      # ... other parameters
On this page