Hosted Experience
Events

3min
There may be times when you want even more fine tuned control of your client application, and to synchronise your website with the state of the digital human. For this, we provide message events from the digital human application that may be consumed by your web client. To do this, you may listen to window event UneeqMessage.
Example

The below code example demonstrates how you can listen for messages, and in this case update the class list of the body element when the session becomes live. There are many more message events you may want to listen for, these are listed below.
JS
window.addEventListener( 'UneeqMessage', (event) => {
    const msg = event.detail;
    console.log('UneeQ Message: ', msg);

    switch( msg.uneeqMessageType ){

        case 'SessionStateUpdate':
            if( msg.live ) {
                document.body.classList.add('uneeq-session-live');
            } else {
                document.body.classList.remove('uneeq-session-live');
            }
            break;

        // Add additional event handlers here...

        default:
            break;

    }
});
window.addEventListener( 'UneeqMessage', (event) => {
    const msg = event.detail;
    console.log('UneeQ Message: ', msg);

    switch( msg.uneeqMessageType ){

        case 'SessionStateUpdate':
            if( msg.live ) {
                document.body.classList.add('uneeq-session-live');
            } else {
                document.body.classList.remove('uneeq-session-live');
            }
            break;

        // Add additional event handlers here...

        default:
            break;

    }
});
﻿
﻿
Messages
The complete list of messages you may listen for are defined below:
Notification
SessionStateUpdate
CallToActionDismissed
FrameReady
MicPermissionDenied
CustomMetadataUpdated
SessionLive
SessionEnded
AvatarUnavailable
AvatarAnswerContent
PromptRequest
PromptResult
DeviceError
ServiceUnavailable
SessionError
Instructions
RecordingStarted
RecordingStopped
UserStartedSpeaking
UserStoppedSpeaking
DigitalHumanPlayedInMutedModeSuccess
DigitalHumanUnmuted
EnableMicrophoneUpdated
SpeechTranscription
VadInterruptionAllowed
SessionReconnecting
AvatarStoppedSpeaking
AvatarStartedSpeaking
VadInterruptionAllowed
SessionReconnecting
SessionDisconnected
SpeechEvent
WaitingInQueue
﻿
﻿
Language Strings
Speech Events