Configuration

The Tokkio UI configuration options are provided below:

Tokkio UI Configuration

Environment variable	Default value	Description
APPLICATION_TYPE	"custom"	Dictates the type of UI that will appear. Set to "retail" for the Retail UI with the restaurant menu, set to "custom" for the UI with a full screen digital human.
APP_TITLE	"NVIDIA"	The title of the application displayed in the top bar.
ENABLE_CAMERA	false	Set to true if video (camera) is enabled. Set to false for audio only pipeline.
OVERLAY_VISIBLE	true	Set to true to see a overlay at the bottom of the screen to mute the microphone, open custom view, etc. Set to false to show only the avatar. This configuration is only available for the "custom" application_type.
UI_WINDOW_VISIBLE	false	Set to true to enable a custom UI, which will display UIs that are sent to the PUT /view/custom/{id} route of the UI server. This configuration is only available for the "custom" application_type.
TOP_BAR_VISIBLE	true	Set to true to display the top bar. Setting this to false will hide the top bar and only show the digital human video stream. This configuration is only available for the "custom" application_type.
ASR_VISIBLE	true	Controls whether the user’s speech transcriptions are shown in the UI.
TTS_VISIBLE	true	Controls whether the digital human’s speech transcriptions are shown in the UI.
UI_SERVER_ENDPOINT		Do not set this if deploying using the one-click scripts. This should be set to be the endpoint where the UI can call the APIs of the UI server. This happens through Ingress, and should usually be set to http(s)://<ingress host IP>:30888. Ingress host IP is the IP address of the system where Tokkio is deployed.
WEBSOCKET_ENDPOINT		Do not set this if deploying using the one-click scripts. This should be set to the endpoint where the UI can make a WebSocket connection to the UI server. This happens through Ingress, and should usually be set to ws(s)://<ingress host IP>:30888/ws. Ingress host IP is the IP address of the system where Tokkio is deployed.
VST_WEBSOCKET_ENDPOINT		Do not set this if deploying using the one-click scripts. This should be set to the endpoint where the UI can make a WebSocket connection to the VMS. This happens through Ingress, and should usually be set to ws(s)://<ingress host IP>:30888/vms/ws. Ingress host IP is the IP address of the system where Tokkio is deployed.