Customizing "Welcome Screen"
This document describes how to customize the text and button label in the Digital Human's welcome message. You can customize these elements via embedded snippet attributes.
If your digital human uses streaming mode, please refer to our SDK documentation instead.
To check whether your digital human is in legacy or streaming mode, see this page.
If the digital human configuration states that videoStreaming=true then your digital human is in streaming mode.
Overview
The welcome message is the initial message displayed to users when they interact with the Digital Human. This is mainly to comply with the internet browser's requirements regarding media assets playback. Customizing this message allows you to provide a tailored introduction or call to action.
You can customize the welcome message text and button label using the Embedded Snippet Attributes, when embedding the Digital Human into a web page using the provided code snippet.
Customization via Embedded Snippet Attributes
When embedding the Digital Human using the provided code snippet, you can customize the welcome message text and button label using the following data- attributes within the <div> tag:
- data-welcome_message: Sets the text of the welcome message.
- data-welcome_button_text: Sets the text of the button in the welcome message.
Example
<body> <div id="talking-head" data-api_base="https://chat-origin.api.unith.live" data-api_key="<your-api-key>" data-embed="true" data-org_id="<your-org-id>" data-head_id="<your-head-id>" data-theme="demo" data-vm_version="1" ... data-welcome_message="Hello! How can I assist you today?" data-welcome_button_text="Begin" ></div> </body>
In this example:
- data-welcome_message is set to "Hello! How can I assist you today?".
- data-welcome_button_text is set to "Begin".
You can hide the welcome message complety by setting the value of the data-welcome_message to "null".
Please keep in mind that there are currently no character length limitations.