API reference

TextToSpeechAgent Class

Extends MonoBehaviour

Fields

onClipReady : TtsAudioClipEvent
Signature 
TtsAudioClipEvent onClipReady
onSpeakFinished : UnityEvent
Signature 
UnityEvent onSpeakFinished
onSpeakStarting : TtsTextEvent
Signature 
TtsTextEvent onSpeakStarting

Properties

CurrentText : string
[Get][Set]
Signature 
string CurrentText
LastClip : AudioClip
[Get]
Signature 
AudioClip LastClip

Methods

ApplyPreset ( p )
Signature 
void ApplyPreset(TtsPreset p)
Parameters
p: TtsPreset
Returns
void
SpeakText ( overrideText )
Public entry so other systems (e.g., LLM) can trigger TTS.
Signature 
void SpeakText(string overrideText=null)
Parameters
overrideText: string
Returns
void
StopSpeaking ()
Signature 
void StopSpeaking()
Returns
void

Inner Classes

TtsAudioClipEvent Class

TtsTextEvent Class

Inner Enum

TtsPreset Enum

Enumeration Constants

Member
Greeting
Llama
PromptReply
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta