Hosted Experience
Methods

32min
Once you've created an instance of Uneeq, you can interact with it to control behaviour dynamically. The below methods are available on your Uneeq instance (e.g. uneeqInstance.
You can learn more about Uneeq options: Configuration Options﻿ 
JS
const uneeqInstance = new Uneeq(options)
// Now you can call methods on uneeqInstance, e.g.
// uneeqInstance.cameraAnchorHorizontal('center', 500)
const uneeqInstance = new Uneeq(options)
// Now you can call methods on uneeqInstance, e.g.
// uneeqInstance.cameraAnchorHorizontal('center', 500)
﻿
﻿
Methods
init()
Initializes the Uneeq instance by validating options and setting up the message event handler.
JS
uneeqInstance.init()
uneeqInstance.init()
﻿
﻿
cameraAnchorHorizontal(position, duration)
Requests the camera to move to a specified anchor position.
Parameters
position (string): The desired camera anchor position. 'left' | 'right' | 'center' | 'close_up' | 'loose_close_up' | 'tight_medium_shot' | 'medium_shot' | 'medium_full_shot' | 'full_shot'
duration (number): The duration for the camera movement in milliseconds.
JS
uneeqInstance.cameraAnchorHorizontal('right', 500);
uneeqInstance.cameraAnchorHorizontal('right', 500);
﻿
﻿
cameraAnchorDistance(position, duration)
Requests the camera to move to a specified anchor position.
Parameters
position (string): The desired camera anchor position. 'close_up' | 'loose_close_up' | 'tight_medium_shot' | 'medium_shot' | 'medium_full_shot' | 'full_shot'
duration (number): The duration for the camera movement in milliseconds.
JS
uneeqInstance.cameraAnchorDistance('close_up', 500);
uneeqInstance.cameraAnchorDistance('close_up', 500);
﻿
﻿
chatPrompt(prompt, addClosedCaption)
Sends a chat prompt to the digital human.
Parameters
prompt (string): The chat prompt message.
addClosedCaption (boolean): Should the prompt message be added to the closed captions. Default: false.
JS
uneeqInstance.chatPrompt('Hello, how are you?', true);
uneeqInstance.chatPrompt('Hello, how are you?', true);
﻿
﻿
speak(speech)
Sends a speak request to the digital human. This will interrupt any speech that is in progress. Sending multiple/overlapping speak requests will not result in those requests being queued.
Parameters
speech (string): The text to be spoken by the digital human.
JS
uneeqInstance.speak('Welcome to our service.');
uneeqInstance.speak('Welcome to our service.');
﻿
﻿
enableMicrophone()
Enables the user's microphone for audio recording.
JS
uneeqInstance.enableMicrophone();
uneeqInstance.enableMicrophone();
﻿
﻿
endSession()
Ends the current session.
JS
uneeqInstance.endSession();
uneeqInstance.endSession();
﻿
﻿
pauseSpeechRecognition()
Pauses speech recognition processing. This is equivilent to muting the users microphone.
JS
uneeqInstance.pauseSpeechRecognition();
uneeqInstance.pauseSpeechRecognition();
﻿
﻿
resumeSpeechRecognition()
Resumes speech recognition processing. This is equivilent to un-muting the users microphone.
JS
uneeqInstance.resumeSpeechRecognition();
uneeqInstance.resumeSpeechRecognition();
﻿
﻿
setCustomPromptMetadata(customMetadata)
Sets custom metadata for chat prompts.
Parameters
customMetadata (Object): The custom metadata for chat.
JS
uneeqInstance.setCustomPromptMetadata({"key":"value"});
uneeqInstance.setCustomPromptMetadata({"name": "john"})
uneeqInstance.setCustomPromptMetadata({"key":"value"});
uneeqInstance.setCustomPromptMetadata({"name": "john"})
﻿
﻿
setLayoutMode(layoutMode)
Sets the layout mode of the interface.
Parameters
layoutMode (string): 'overlay' | 'fullScreen' | 'contained'
JS
uneeqInstance.setLayoutMode('fullScreen');
uneeqInstance.setLayoutMode('fullScreen');
﻿
﻿
setWebRtcStatsEnabled(enableMessages: boolean, enableLogs: boolean)
To diagnose video or audio quality issues, you can turn on (or off) webrtc logging enableLogs to have them output to the browsers console. If you want to programatically handle these messages you can enableMessages to have them passed through to your page for handling.
When enableMessages is enabled your page will receive a message with the key/value pair uneeqMessageType: "WebRtcStats"
JS
uneeqInstance.setWebRtcStatsEnabled(true, true);
uneeqInstance.setWebRtcStatsEnabled(true, true);
﻿
﻿
stopSpeaking()
Instructs the digital human to stop speaking.
JS
uneeqInstance.stopSpeaking();
uneeqInstance.stopSpeaking();
﻿
﻿
unmuteDigitalHuman()
Unmutes the digital human if the browser has muted it due to auto-play policy.
JS
uneeqInstance.unmuteDigitalHuman();
uneeqInstance.unmuteDigitalHuman();
﻿
﻿
muteDigitalHuman()
Mutes the digital human. You must call unmuteDigitalHuman() to receive audio again. There is no on screen indicator of this muted state.
JS
uneeqInstance.muteDigitalHuman();
uneeqInstance.muteDigitalHuman();
﻿
﻿
updateDisplayContent(htmlContent)
Sets HTML content to be displayed in the content window.
Parameters
htmlContent (string): The HTML content to display.
JS
uneeqInstance.updateDisplayContent('<p>New Content</p>');
uneeqInstance.updateDisplayContent('<p>New Content</p>');
﻿
﻿
setShowClosedCaptions(show)
Sets whether closed captions are displayed.
Parameters
show (boolean): True to show closed captions, false otherwise.
JS
uneeqInstance.setShowClosedCaptions(true);
uneeqInstance.setShowClosedCaptions(true);
﻿
﻿
setShowUserInputInterface(show)
Sets whether the user input interface (text/voice input UI) is displayed.
Parameters
show (boolean): True to show the user input interface, false otherwise.
JS
uneeqInstance.setShowUserInputInterface(true);
uneeqInstance.setShowUserInputInterface(true);
﻿
﻿
startSession()
Starts a session with the digital human.
JS
uneeqInstance.startSession();
uneeqInstance.startSession();
﻿
﻿
Speech Events
Multiple Digital Humans