Documentation

​
​

Development

User Acquisition

Monetization

Industry

Vivox Unreal SDK

Vivox Unreal SDK

Vivox
​
​
Vivox Unreal SDK
  • Overview
  • Get started
  • Release notes
  • Developer guide
  • Tutorials
  • Reference
    • Vivox Core Unreal class model overview
    • Vivox Unreal conventions
    • Unreal API Reference Manual
      • Class List
        • AccountId
        • Channel3DProperties
        • ChannelId
        • FVivoxCoreModule
        • IAudioDevice
        • IAudioDevices
        • IChannelConnectionState
        • IChannelSession
        • IChannelTextMessage
        • IClient
        • IDirectedTextMessage
        • ILoginSession
        • IParticipant
        • IParticipantProperties
        • IPresenceLocation
        • IPresenceSubscription
        • ITextMessage
        • ITextToSpeech
        • ITranscribedMessage
        • ITTSAudioBuffer
        • ITTSMessage
        • ITTSVoice
        • Presence
        • VivoxConfig
      • Deprecated List
    • Access Token Developer Guide
    • Server to Server Web API Reference Guide
    • Third-party license information
  1. Vivox Unreal SDK documentation

ITTSMessage

Reference the ITTSMessage interface for text-to-speech messages.
Read time 1 minute
Last updated 8 months ago
A spoken message in the text-to-speech subsystem.
#include <ITTSMessage.h>

Public Functions

Name

virtual const ITTSVoice &Voice() const =0
The voice used to synthesize this message.
virtual const FString &Text() const =0
The text to be synthesized into speech.
virtual const TTSDestination &Destination() const =0
The destination of this message.
virtual const TTSUtteranceId &UtteranceId() const =0
An internal utterance identifier.
virtual const TTSMessageState &State() const =0
The Playing/Enqueued state of the message.
virtual boolIsValid() const =0
True if created by using a non-default constructor and Text is not empty.

Public Functions Documentation

function Voice

virtual const ITTSVoice & Voice() const =0
The voice used to synthesize this message.

function Text

virtual const FString & Text() const =0
The text to be synthesized into speech.

function Destination

virtual const TTSDestination & Destination() const =0
The destination of this message.

function UtteranceId

virtual const TTSUtteranceId & UtteranceId() const =0
An internal utterance identifier.

function State

virtual const TTSMessageState & State() const =0
The Playing/Enqueued state of the message.

function IsValid

virtual bool IsValid() const =0
True if created by using a non-default constructor and Text is not empty.
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.

  • On this page

    • Public Functions

    • Public Functions Documentation

      • function Voice

      • function Text

      • function Destination

      • function UtteranceId

      • function State

      • function IsValid

Report a problem with this page