Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Inject a text-to-speech message

Inject a text-to-speech message into Vivox channels.
Read time 1 minuteLast updated 2 days ago

To inject a text-to-speech (TTS) message into channel or local audio, use
ITextToSpeech::Speak()
:
ITTSMessage *Message;TTSDestination Destination = TTSDestination::QueuedRemoteTransmissionWithLocalPlayback;MyLoginSession->TTS().Speak("Hello World!", Destination, &Message);
Speak()
accepts the following parameters:
  • The text to be converted into speech.
  • The TTSDestination.
  • Optionally as an out parameter, a TTS message reference set to the newly created ITTSMessage, regardless of whether it is currently playing in the destination or is in a queue waiting to be synthesized.
If multiple TTS users are in one voice or text channel, then you can prefix the display name of the user who is sending the TTS message. For example, “[Display name] says…”