When constructing the Uneeq() object, you are required to pass in UneeqOptions. These options are defined as follows.
Server URL to connect to.
Type: string
Uneeq conversation ID to use for the session.
Type: string
The div element that the avatars video should be placed inside.
Type: HTMLDivElement
The div element that the local video should be placed inside.
Type: string (optional)
Enable diagnostic callbacks.
Type: string (optional)
Default Value: false
This option controls the visibility of client-side network performance messages in the developer console. These WebRTC statistics (eg packetsLost, framesDropped, framesPerSec) help identify if session quality is being impacted by client-side conditions. Irrespective of this visibility setting, UneeQ's servers receive these messages to help measure platform performance and stability for end users.
Type: boolean (optional)
Default Value: false
This option controls whether the Digital Human is rendered with a transparent background, allowing them to be overlaid on top of your experience. If true, the digital human's configured background image will be replaced with a transparent background. If false, your configured background image will be displayed.
Type: boolean (optional)
Default Value: false
Enable logging.
Type: boolean (optional)
Default Value: false
Provide a function to be used for message handler call backs.
Type: function (msg: <any>) (optional)
Default Value: undefined
Whether you want to receive mic activity messages or not.
Type: boolean (optional)
Default Value: false
Whether the NLP welcome message should be triggered.
Type: boolean (optional)
Default Value: false
Device ID of the preferred camera to start the session with.
Type: string (optional)
Default Value: undefined
Type: string (optional)
Default Value: undefined
Device ID of the preferred speaker to start the session with.
Type: string (optional)
Default Value: undefined
Whether the users local audio stream (microphone) should be sent on session start.
Type: boolean (optional)
Default Value: true
Whether the users local video stream (camera) should be sent on session start.
Type: boolean (optional)
Default Value: true