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

Cancel a text-to-speech message

Cancel a queued text-to-speech message.
Read time 1 minute
Last updated 8 months ago
To cancel a currently playing or enqueued text-to-speech (TTS) message, use 
ITextToSpeech::CancelMessage()
with the 
ITTSMessage
that you want to cancel. For example:
ITTSMessage *Message;MyLoginSession->TTS().Speak("Some Text", TTSDestination::RemoteTransmission, &Message);MyLoginSession->TTS().CancelMessage(*Message);
In destinations that contain queues, canceling an ongoing TTS message automatically triggers playback of the next message. Canceling an enqueued TTS message shifts all later messages up one place in the queue.
You can cancel all TTS messages in a destination (ongoing and enqueued), or all TTS messages in all destinations.
// Cancel all TTS messages in the destination for Queued Local PlaybackMyLoginSession->TTS().CancelDestination(TTSDestination::QueuedLocalPlayback);// Cancel all TTS messages in all destinationsMyLoginSession->TTS().CancelAll();
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