Documentation

​
​

Development

User Acquisition

Monetization

Industry

Vivox Unreal SDK

Vivox Unreal SDK

Vivox
​
​
Vivox Unreal SDK
  • Overview
  • Get started
  • Release notes
  • Developer guide
    • Set up your project
    • Unity Authentication Service in Unreal
    • Create voice and text channels
    • Messaging
    • Audio management
    • Muting
    • In-game moderation
    • Android app development
    • iOS app development
    • Server-side recording
    • Speech-to-text audio transcription
    • Text-to-speech
      • Text-to-speech voice options
      • Text-to-speech destinations
      • Inject a text-to-speech message
      • Queue a text-to-speech message
      • Cancel a text-to-speech message
      • Text-to-speech events
      • Get raw audio of synthesized speech
      • Use text-to-speech for incoming messages
    • Real-time recording
    • Transmission
    • Troubleshooting
  • Tutorials
  • Reference
  1. Vivox Unreal SDK documentation
  3. Text-to-speech

Queue a text-to-speech message

Inject a text-to-speech message into Vivox channels.
Read time 1 minute
Last updated 8 months ago
Some destinations offer a built-in queuing system. When a new message is injected and there is an ongoing message playing, then the new message is put into a queue. After the ongoing message finishes playing, the next message in the queue automatically begins playing.
// Returns VxErrorSuccess and starts playing immediately.MyLoginSession->TTS().Speak("First Message.", TTSDestination::QueuedLocalPlayback);// Returns VxStatusTTSInputTextWasEnqueued and put in a queue.// After the first message finishes playback, this message will start.MyLoginSession->TTS().Speak("Second Message.", TTSDestination::QueuedLocalPlayback);
A queue is shared between 
TTSDestination::QueuedRemoteTransmission
and 
TTSDestination::QueuedRemoteTransmissionWithLocalPlayback
. The destination 
TTSDestination::QueuedLocalPlayback
has its own queue.
A destination queue can hold up to 10 messages. If a message is added when a destination queue is full, the Vivox SDK discards the message and the method returns the error 
VxErrorTTSDestinationQueueIsFull
. In this case, no text-to-speech related events are raised.
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

    Report a problem with this page