Documentation

​
​

Development

User Acquisition

Monetization

Industry

Vivox Core SDK

Vivox Core SDK

Vivox
​
​
Vivox Core SDK
  • Overview
  • Before you begin
  • Get started
  • Release notes
  • Developer Guide
    • Client SDK basics
    • Channels
    • Presence management
    • Messaging
    • Manage audio
    • Couch co-op
    • Android app development
    • iOS app development
    • macOS app development
    • Windows app development
    • Real-time recording
    • Speech-to-text audio transcription
    • Text-to-speech
      • Initialize 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
      • Shut down text-to-speech
    • Troubleshooting
  • Reference
  • Privacy overview
  1. Vivox Core SDK documentation
  2. Text-to-speech

Inject a text-to-speech message

Inject a text-to-speech message into Vivox channels.
Read time 1 minute
Last updated 8 months ago

To inject a text-to-speech (TTS) message into channel or local audio, use
vx_tts_speak
vx_tts_utterance_id utteranceId;vx_tts_speak(managerId, voiceId, "Example message, this is great!", tts_dest_queued_local_playback, &utteranceId);
vx_tts_speak
accepts the following parameters:
  • The TTS manager identifier that is generated at TTS initialization.
  • The ID of the voice to be used when synthesizing the speech.
  • The message to be converted into speech.
  • The destination.
  • An out parameter that contains the utterance identifier. You can use the utterance identifier later, for example, to cancel TTS messages.
    Note
    The word “utterance” is used to refer to the TTS message 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…”

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