Speech Events

2min
It is possible to inject "speech events" into your digital human responses and have the event trigger in your front end web page and the precise time it is spoken by your digital human.
For example, if the digital human is instructed to respond with the following message, your web client will receive SpeechEvent messages at the precise time the tags are spoken in the response:
Text
Hello there, I am a digital human. <uneeq:custom_event name="a_test_event" /> What can I help you with today?
Hello there, I am a digital human. <uneeq:custom_event name="a_test_event" /> What can I help you with today?
﻿
When the above text is spoken by a digital human, either with speak() or as a result of a chatPrompt the following event will occur in your front end client:
JS
window.addEventListener('UneeqMessage', (event) => {
    switch (msg.uneeqMessageType) {
	    case 'SpeechEvent':
		    const eventValue = msg.speechEvent.param_value
		    console.log('SpeechEvent value: ', eventValue)
		    break
		    
	    default:
	        break
	}
})
window.addEventListener('UneeqMessage', (event) => {
    switch (msg.uneeqMessageType) {
	    case 'SpeechEvent':
		    const eventValue = msg.speechEvent.param_value
		    console.log('SpeechEvent value: ', eventValue)
		    break
		    
	    default:
	        break
	}
})
﻿
Example Use Case
You may choose to use SpeechEvent messages to synchronise what the digital human is saying with what is happening on your web page. You could use these events to display an image or scroll to certain content at the precise time the digital human is speaking about it.
Events
Methods