API reference
ISpeaker Interface
Properties
bool IsSpeaking[Get]
Whether a clip is currently playing for this speaker
bool IsPaused[Get]
Whether a clip is currently paused
TTSSpeakerEvents Events[Get]
Events related to the playback of
TTSVoiceSettings VoiceSettings[Get]
The specific voice properties used by this speaker
IAudioPlayer AudioPlayer[Get]
The script used to perform audio playback of IAudioClipStreams.
Member Functions
void Speak
( string textToSpeak,
TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified text & playback events. Cancels all previous clips when loaded & then plays.
Parameters
textToSpeak
The text to be spoken
playbackEvents
Events to be called for this specific tts playback request
void SpeakQueued
( string textToSpeak,
TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified text & playback events. Cancels all previous clips when loaded & then plays.
Parameters
textToSpeak
The text to be spoken
playbackEvents
Events to be called for this specific tts playback request
IEnumerator SpeakAsync
( string textToSpeak )
Load a tts clip using the specified text and then waits for the file to load & play. Cancels all previous clips when loaded & then plays.
Parameters
textToSpeak
The text to be spoken
Task SpeakTask
( string textToSpeak )
Load a tts clip using the specified text and then waits for the file to load & play. Cancels all previous clips when loaded & then plays.
Parameters
textToSpeak
The text to be spoken
Task SpeakTask
( string textToSpeak,
TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified text & playback events and waits for the file to load and play Cancels all previous clips when loaded & then plays.
Parameters
textToSpeak
The text to be spoken
playbackEvents
Events to be called for this specific tts playback request
Task SpeakTask
( WitResponseNode responseNode,
TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified response node & playback events Cancels all previous clips when loaded & then plays.
Parameters
responseNode
Parsed data that includes text to be spoken & voice settings
playbackEvents
Events to be called for this specific tts playback request
bool Speak
( WitResponseNode responseNode,
TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified response node & playback events Cancels all previous clips when loaded & then plays.
Parameters
responseNode
Parsed data that includes text to be spoken & voice settings
playbackEvents
Events to be called for this specific tts playback request
Returns
True if responseNode is decoded successfully
IEnumerator SpeakQueuedAsync
( WitResponseNode responseNode,
TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified text phrases & playback events and then waits for the files to load & play. Adds clip to playback queue and will speak once queue has completed all playback.
Parameters
responseNode
Parsed data that includes text to be spoken & voice settings
playbackEvents
Events to be called for this specific tts playback request
Task SpeakQueuedTask
( WitResponseNode responseNode,
TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified text phrases & playback events and then waits for the files to load & play. Adds clip to playback queue and will speak once queue has completed all playback.
Parameters
responseNode
Parsed data that includes text to be spoken & voice settings
playbackEvents
Events to be called for this specific tts playback request
IEnumerator SpeakQueuedAsync
( string [] textsToSpeak,
TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified text phrases & playback events and then waits for the files to load & play. Adds clip to playback queue and will speak once queue has completed all playback.
Parameters
textsToSpeak
Multiple texts to be spoken
playbackEvents
Events to be called for this specific tts playback request
Task SpeakQueuedTask
( string [] textsToSpeak,
TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified text phrases & playback events and then waits for the files to load & play. Adds clip to playback queue and will speak once queue has completed all playback.
Parameters
textsToSpeak
Multiple texts to be spoken
playbackEvents
Events to be called for this specific tts playback request
void Stop ( )
Stops loading & playback immediately
void Pause ( )
Pause any current or future loaded audio playback
void Resume ( )
Resume playback for current and future audio clips
void PrepareToSpeak ( )
Call before sending speech data to warm up system
void StartTextBlock ( )
Call at the start of a larger text block to indicate many queued requests will be coming
void EndTextBlock ( )
Call at the end of a larger text block to indicate a block of text is complete.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta