Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

ITTSMessage

Reference the ITTSMessage interface for text-to-speech messages.
Read time 1 minuteLast updated 2 days 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.