API reference

TTSSpeaker Class

Extends MonoBehaviour
Implements Meta.WitAi.Speech.ISpeechEventProvider, Meta.WitAi.TTS.Interfaces.ISpeaker, Meta.WitAi.TTS.Interfaces.ITTSEventPlayer, Lib.Wit.Runtime.Utilities.Logging.ILogSource

Fields

AppendedText : string
Signature 
string Meta.WitAi.TTS.Utilities.TTSSpeaker.AppendedText
CurrentEvents : TTSEventContainer
The current tts events available
Signature 
TTSEventContainer Meta.WitAi.TTS.Utilities.TTSSpeaker.CurrentEvents
customWitVoiceSettings : TTSWitVoiceSettings
Signature 
TTSWitVoiceSettings Meta.WitAi.TTS.Utilities.TTSSpeaker.customWitVoiceSettings
Signature 
TTSSpeakerEvents Meta.WitAi.TTS.Utilities.TTSSpeaker.Events
IsActive : bool
Whether the speaker currently has currently speaking clip or a playback queue
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.IsActive
IsLoading : bool
Whether there are any clips in the loading queue
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.IsLoading
IsSpeaking : bool
Whether a clip is currently playing for this speaker
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.IsSpeaking
PrependedText : string
Signature 
string Meta.WitAi.TTS.Utilities.TTSSpeaker.PrependedText
SpeakingClip : TTSClipData
The data for the currently playing clip
Signature 
TTSClipData Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakingClip
SpeechEvents : VoiceSpeechEvents
Signature 
VoiceSpeechEvents Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeechEvents
TotalSamples : int
The total samples available for the current tts events
Signature 
int Meta.WitAi.TTS.Utilities.TTSSpeaker.TotalSamples

Properties

AudioPlayer : IAudioPlayer
[Get]
The script used to perform audio playback of IAudioClipStreams.
  1. Gets IAudioPlayer component if applied to this speaker
  2. If no IAudioPlayer component is found, the TTSService's audio system will be used to generate an audio player.
  3. If still not found, adds a UnityAudioPlayer.
Signature 
IAudioPlayer Meta.WitAi.TTS.Utilities.TTSSpeaker.AudioPlayer
AudioSource : AudioSource
[Get]
Signature 
AudioSource Meta.WitAi.TTS.Utilities.TTSSpeaker.AudioSource
ElapsedSamples : int
[Get]
The current amount of elapsed samples of the playing audio data if applicable
Signature 
int Meta.WitAi.TTS.Utilities.TTSSpeaker.ElapsedSamples
IsPaused : bool
[Get]
Whether playback is currently paused or not
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.IsPaused
IsPreparing : bool
[Get]
Whether any queued clips are still not ready for playback
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.IsPreparing
Logger : IVLogger
[Get]
Signature 
IVLogger Meta.WitAi.TTS.Utilities.TTSSpeaker.Logger
OnSampleUpdated : TTSEventSampleDelegate
[Get][Set]
The callback following the change of the current sample
Signature 
TTSEventSampleDelegate Meta.WitAi.TTS.Utilities.TTSSpeaker.OnSampleUpdated
QueuedClips : List< TTSClipData >
[Get]
Signature 
List<TTSClipData> Meta.WitAi.TTS.Utilities.TTSSpeaker.QueuedClips
TTSService : TTSService
[Get]
Signature 
TTSService Meta.WitAi.TTS.Utilities.TTSSpeaker.TTSService
VoiceID : string
[Get][Set]
Signature 
string Meta.WitAi.TTS.Utilities.TTSSpeaker.VoiceID
VoiceSettings : TTSVoiceSettings
[Get]
The voice settings to be used for this TTSSpeaker
Signature 
TTSVoiceSettings Meta.WitAi.TTS.Utilities.TTSSpeaker.VoiceSettings

Protected Methods

HandlePlaybackComplete ( stopped )
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.HandlePlaybackComplete(bool stopped)
Parameters
stopped: bool
Returns
void
IsPlaybackComplete ()
Signature 
virtual bool Meta.WitAi.TTS.Utilities.TTSSpeaker.IsPlaybackComplete()
Returns
bool
OnDestroy ()
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.OnDestroy()
Returns
void
OnDisable ()
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.OnDisable()
Returns
void
OnEnable ()
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.OnEnable()
Returns
void
RaiseOnPlaybackQueueBegin ()
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.RaiseOnPlaybackQueueBegin()
Returns
void
RaiseOnPlaybackQueueComplete ()
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.RaiseOnPlaybackQueueComplete()
Returns
void
RaisePlaybackSampleUpdated ( sample )
Updates callback sample
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.RaisePlaybackSampleUpdated(int sample)
Parameters
sample: int
Returns
void
SetPause ( toPaused )
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.SetPause(bool toPaused)
Parameters
toPaused: bool
Returns
void
Start ()
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.Start()
Returns
void
StopAndUnloadClip ( clipData )
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.StopAndUnloadClip(TTSClipData clipData)
Parameters
clipData: TTSClipData
Returns
void

Methods

ClearVoiceOverride ()
Clears the current voice override
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.ClearVoiceOverride()
Returns
void
EndTextBlock ()
Call at the end of a larger text block to indicate a block of text is complete.
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.EndTextBlock()
Returns
void
GetFinalText ( textToSpeak )
Gets final text following prepending/appending and any special formatting
Signature 
List<string> Meta.WitAi.TTS.Utilities.TTSSpeaker.GetFinalText(string textToSpeak)
Parameters
textToSpeak: string  The base text to be spoken
Returns
List< string >  Returns an array of split texts to be spoken
GetFinalTextFormatted ( format , textsToSpeak )
Obtain final text list from format and text list
Signature 
List<string> Meta.WitAi.TTS.Utilities.TTSSpeaker.GetFinalTextFormatted(string format, params string[] textsToSpeak)
Parameters
format: string  The format to be used
textsToSpeak: params string []  The array of strings to be inserted into the format
Returns
List< string >  Returns a list of formatted texts
GetFormattedText ( format , textsToSpeak )
Formats text using an initial format string parameter and additional text items to be inserted into the format
Signature 
string Meta.WitAi.TTS.Utilities.TTSSpeaker.GetFormattedText(string format, params string[] textsToSpeak)
Parameters
format: string  The format to be used
textsToSpeak: params string []  The array of strings to be inserted into the format
Returns
string  A formatted text string
Pause ()
Pause any current or future loaded audio playback
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.Pause()
Returns
void
PrepareToSpeak ()
Call before sending speech data to warm up TTS system
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.PrepareToSpeak()
Returns
void
Resume ()
Resume playback for current and future audio clips
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.Resume()
Returns
void
SetVoiceOverride ( overrideVoiceSettings )
Set a voice override for future requests
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.SetVoiceOverride(TTSVoiceSettings overrideVoiceSettings)
Parameters
overrideVoiceSettings: TTSVoiceSettings  The settings to be applied to upcoming requests
Returns
void
Speak ( textToSpeak , diskCacheSettings , playbackEvents )
Load a tts clip using the specified text, disk cache settings and playback events. Cancels all previous clips when loaded and then plays.
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.Speak(string textToSpeak, TTSDiskCacheSettings diskCacheSettings, TTSSpeakerClipEvents playbackEvents)
Parameters
textToSpeak: string  The text to be spoken
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
void
Speak ( textToSpeak , playbackEvents )
Load a tts clip using the specified text and playback events. Cancels all previous clips when loaded and then plays.
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.Speak(string textToSpeak, TTSSpeakerClipEvents playbackEvents)
Parameters
textToSpeak: string  The text to be spoken
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
void
Speak ( textToSpeak , diskCacheSettings )
Load a tts clip using the specified text and disk cache settings. Cancels all previous clips when loaded and then plays.
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.Speak(string textToSpeak, TTSDiskCacheSettings diskCacheSettings)
Parameters
textToSpeak: string  The text to be spoken
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
Returns
void
Speak ( textToSpeak )
Load a tts clip using the specified text. Cancels all previous clips when loaded and then plays.
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.Speak(string textToSpeak)
Parameters
textToSpeak: string  The text to be spoken
Returns
void
Speak ( responseNode , diskCacheSettings , playbackEvents )
Load a tts clip using the specified response node, disk cache settings and playback events. Cancels all previous clips when loaded and then plays.
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.Speak(WitResponseNode responseNode, TTSDiskCacheSettings diskCacheSettings, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
bool  True if responseNode is decoded successfully
Speak ( responseNode , diskCacheSettings )
Load a tts clip using the specified response node and disk cache settings Cancels all previous clips when loaded and then plays.
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.Speak(WitResponseNode responseNode, TTSDiskCacheSettings diskCacheSettings)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
Returns
bool  True if responseNode is decoded successfully
Speak ( responseNode , playbackEvents )
Load a tts clip using the specified response node and playback events Cancels all previous clips when loaded and then plays.
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.Speak(WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
bool  True if responseNode is decoded successfully
Speak ( responseNode )
Load a tts clip using the specified response node and playback events Cancels all previous clips when loaded and then plays.
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.Speak(WitResponseNode responseNode)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
Returns
bool  True if responseNode is decoded successfully
SpeakAsync ( textToSpeak , diskCacheSettings , playbackEvents )
Load a tts clip using the specified text, disk cache settings and playback events and then waits for the file to load and play. Cancels all previous clips when loaded and then plays.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakAsync(string textToSpeak, TTSDiskCacheSettings diskCacheSettings, TTSSpeakerClipEvents playbackEvents)
Parameters
textToSpeak: string  The text to be spoken
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
IEnumerator
SpeakAsync ( textToSpeak , playbackEvents )
Load a tts clip using the specified text and playback events and then waits for the file to load and play. Cancels all previous clips when loaded and then plays.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakAsync(string textToSpeak, TTSSpeakerClipEvents playbackEvents)
Parameters
textToSpeak: string  The text to be spoken
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
IEnumerator
SpeakAsync ( textToSpeak , diskCacheSettings )
Load a tts clip using the specified text and disk cache settings and then waits for the file to load and play. Cancels all previous clips when loaded and then plays.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakAsync(string textToSpeak, TTSDiskCacheSettings diskCacheSettings)
Parameters
textToSpeak: string  The text to be spoken
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
Returns
IEnumerator
SpeakAsync ( textToSpeak )
Load a tts clip using the specified text and then waits for the file to load and play. Cancels all previous clips when loaded and then plays.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakAsync(string textToSpeak)
Parameters
textToSpeak: string  The text to be spoken
Returns
IEnumerator
SpeakAsync ( responseNode , diskCacheSettings , playbackEvents )
Load a tts clip using the specified text, disk cache settings and playback events and then waits for the file to load and play. Cancels all previous clips when loaded and then plays.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakAsync(WitResponseNode responseNode, TTSDiskCacheSettings diskCacheSettings, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
IEnumerator
SpeakAsync ( responseNode , playbackEvents )
Load a tts clip using the specified text and playback events and then waits for the file to load and play. Cancels all previous clips when loaded and then plays.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakAsync(WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
IEnumerator
SpeakAsync ( responseNode , diskCacheSettings )
Load a tts clip using the specified text and disk cache settings and then waits for the file to load and play. Cancels all previous clips when loaded and then plays.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakAsync(WitResponseNode responseNode, TTSDiskCacheSettings diskCacheSettings)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
Returns
IEnumerator
SpeakFormat ( format , textsToSpeak )
Loads a formated phrase to be spoken. Cancels all previous clips when loaded and then plays.
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakFormat(string format, params string[] textsToSpeak)
Parameters
format: string  Format string to be filled in with texts
textsToSpeak: params string []  Texts to be inserted into the formatter
Returns
void
SpeakFormatQueued ( format , textsToSpeak )
Loads a formated phrase to be spoken. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakFormatQueued(string format, params string[] textsToSpeak)
Parameters
format: string  Format string to be filled in with texts
textsToSpeak: params string []  Texts to be inserted into the formatter
Returns
void
SpeakQueued ( textToSpeak , diskCacheSettings , playbackEvents )
Load a tts clip using the specified text, disk cache settings and playback events. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueued(string textToSpeak, TTSDiskCacheSettings diskCacheSettings, TTSSpeakerClipEvents playbackEvents)
Parameters
textToSpeak: string  The text to be spoken
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
void
SpeakQueued ( textToSpeak , playbackEvents )
Load a tts clip using the specified text and playback events. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueued(string textToSpeak, TTSSpeakerClipEvents playbackEvents)
Parameters
textToSpeak: string  The text to be spoken
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
void
SpeakQueued ( textToSpeak , diskCacheSettings )
Load a tts clip using the specified text and disk cache settings events. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueued(string textToSpeak, TTSDiskCacheSettings diskCacheSettings)
Parameters
textToSpeak: string  The text to be spoken
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
Returns
void
SpeakQueued ( textToSpeak )
Load a tts clip using the specified text. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueued(string textToSpeak)
Parameters
textToSpeak: string  The text to be spoken
Returns
void
SpeakQueued ( responseNode , diskCacheSettings , playbackEvents )
Load a tts clip using the specified text, disk cache settings and playback events. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueued(WitResponseNode responseNode, TTSDiskCacheSettings diskCacheSettings, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
bool  True if responseNode is decoded successfully
SpeakQueued ( responseNode , playbackEvents )
Load a tts clip using the specified text and playback events. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueued(WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
bool  True if responseNode is decoded successfully
SpeakQueued ( responseNode , diskCacheSettings )
Load a tts clip using the specified text and disk cache settings events. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueued(WitResponseNode responseNode, TTSDiskCacheSettings diskCacheSettings)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
Returns
bool  True if responseNode is decoded successfully
SpeakQueued ( responseNode )
Load a tts clip using the specified text. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
bool Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueued(WitResponseNode responseNode)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
Returns
bool  True if responseNode is decoded successfully
SpeakQueuedAsync ( textsToSpeak , diskCacheSettings , playbackEvents )
Load a tts clip using the specified text phrases, disk cache settings and playback events and then waits for the files to load and play. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedAsync(string[] textsToSpeak, TTSDiskCacheSettings diskCacheSettings, TTSSpeakerClipEvents playbackEvents)
Parameters
textsToSpeak: string []  Multiple texts to be spoken
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
IEnumerator
SpeakQueuedAsync ( textsToSpeak , playbackEvents )
Load a tts clip using the specified text phrases and 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.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedAsync(string[] textsToSpeak, TTSSpeakerClipEvents playbackEvents)
Parameters
textsToSpeak: string []  Multiple texts to be spoken
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
IEnumerator
SpeakQueuedAsync ( textsToSpeak , diskCacheSettings )
Load a tts clip using the specified text phrases and disk cache settings and then waits for the files to load and play. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedAsync(string[] textsToSpeak, TTSDiskCacheSettings diskCacheSettings)
Parameters
textsToSpeak: string []  Multiple texts to be spoken
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
Returns
IEnumerator
SpeakQueuedAsync ( textsToSpeak )
Load a tts clip using the specified text phrases and then waits for the files to load and play. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedAsync(string[] textsToSpeak)
Parameters
textsToSpeak: string []  Multiple texts to be spoken
Returns
IEnumerator
SpeakQueuedAsync ( responseNode , diskCacheSettings , playbackEvents )
Load a tts clip using the specified text phrases, disk cache settings and playback events and then waits for the files to load and play. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedAsync(WitResponseNode responseNode, TTSDiskCacheSettings diskCacheSettings, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
IEnumerator
SpeakQueuedAsync ( responseNode , playbackEvents )
Load a tts clip using the specified text phrases and 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.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedAsync(WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
IEnumerator
SpeakQueuedAsync ( responseNode , diskCacheSettings )
Load a tts clip using the specified text phrases and disk cache settings and then waits for the files to load and play. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedAsync(WitResponseNode responseNode, TTSDiskCacheSettings diskCacheSettings)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
Returns
IEnumerator
SpeakQueuedAsync ( responseNode )
Load a tts clip using the specified text phrases and then waits for the files to load and play. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
IEnumerator Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedAsync(WitResponseNode responseNode)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
Returns
IEnumerator
SpeakQueuedTask ( textsToSpeak , diskCacheSettings , playbackEvents )
Load a tts clip using the specified text phrases, disk cache settings and playback events and then waits for the files to load and play. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedTask(string[] textsToSpeak, TTSDiskCacheSettings diskCacheSettings, TTSSpeakerClipEvents playbackEvents)
Parameters
textsToSpeak: string []  Multiple texts to be spoken
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
Task
SpeakQueuedTask ( textsToSpeak , playbackEvents )
Load a tts clip using the specified text phrases and 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.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedTask(string[] textsToSpeak, TTSSpeakerClipEvents playbackEvents)
Parameters
textsToSpeak: string []  Multiple texts to be spoken
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
Task
SpeakQueuedTask ( textsToSpeak , diskCacheSettings )
Load a tts clip using the specified text phrases and disk cache settings and then waits for the files to load and play. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedTask(string[] textsToSpeak, TTSDiskCacheSettings diskCacheSettings)
Parameters
textsToSpeak: string []  Multiple texts to be spoken
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
Returns
Task
SpeakQueuedTask ( textsToSpeak )
Load a tts clip using the specified text phrases and then waits for the files to load and play. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedTask(string[] textsToSpeak)
Parameters
textsToSpeak: string []  Multiple texts to be spoken
Returns
Task
SpeakQueuedTask ( responseNode , diskCacheSettings , playbackEvents )
Load a tts clip using the specified text phrases, disk cache settings and playback events and then waits for the files to load and play. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedTask(WitResponseNode responseNode, TTSDiskCacheSettings diskCacheSettings, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
Task
SpeakQueuedTask ( responseNode , playbackEvents )
Load a tts clip using the specified text phrases and 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.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedTask(WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
Task
SpeakQueuedTask ( responseNode , diskCacheSettings )
Load a tts clip using the specified text phrases and disk cache settings and then waits for the files to load and play. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedTask(WitResponseNode responseNode, TTSDiskCacheSettings diskCacheSettings)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
Returns
Task
SpeakQueuedTask ( responseNode )
Load a tts clip using the specified text phrases and then waits for the files to load and play. Adds clip to playback queue and will speak once queue has completed all playback.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakQueuedTask(WitResponseNode responseNode)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
Returns
Task
SpeakTask ( textToSpeak , diskCacheSettings , playbackEvents )
Load a tts clip using the specified text, disk cache settings and playback events and then waits for the file to load and play. Cancels all previous clips when loaded and then plays.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakTask(string textToSpeak, TTSDiskCacheSettings diskCacheSettings, TTSSpeakerClipEvents playbackEvents)
Parameters
textToSpeak: string  The text to be spoken
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
Task
SpeakTask ( textToSpeak , playbackEvents )
Load a tts clip using the specified text and playback events and then waits for the file to load and play. Cancels all previous clips when loaded and then plays.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakTask(string textToSpeak, TTSSpeakerClipEvents playbackEvents)
Parameters
textToSpeak: string  The text to be spoken
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
Task
SpeakTask ( textToSpeak , diskCacheSettings )
Load a tts clip using the specified text and disk cache settings and then waits for the file to load and play. Cancels all previous clips when loaded and then plays.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakTask(string textToSpeak, TTSDiskCacheSettings diskCacheSettings)
Parameters
textToSpeak: string  The text to be spoken
diskCacheSettings: TTSDiskCacheSettings  Specific tts load caching settings
Returns
Task
SpeakTask ( textToSpeak )
Load a tts clip using the specified text and then waits for the file to load and play. Cancels all previous clips when loaded and then plays.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakTask(string textToSpeak)
Parameters
textToSpeak: string  The text to be spoken
Returns
Task
SpeakTask ( responseNode , playbackEvents )
Load a tts clip using the specified response node and then waits for the file to load and play. Cancels all previous clips when loaded and then plays.
Signature 
Task Meta.WitAi.TTS.Utilities.TTSSpeaker.SpeakTask(WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken and voice settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
Task  True if responseNode is decoded successfully
StartTextBlock ()
Call at the start of a larger text block to indicate many queued requests will be coming
Signature 
void Meta.WitAi.TTS.Utilities.TTSSpeaker.StartTextBlock()
Returns
void
Stop ( textToSpeak , allInstances )
Stop load and playback of a specific clip
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.Stop(string textToSpeak, bool allInstances=false)
Parameters
textToSpeak: string  Stop a specific text phrase
allInstances: bool  Whether to remove the first instance of this clip or all instances
Returns
void
Stop ( clipData , allInstances )
Stop load and playback of a specific clip
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.Stop(TTSClipData clipData, bool allInstances=false)
Parameters
clipData: TTSClipData  The clip to be stopped and removed from the queue
allInstances: bool  Whether to remove the first instance of this clip or all instances
Returns
void
Stop ()
Stops loading and playback immediately
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.Stop()
Returns
void
StopLoading ()
Abort loading of all items in the load queue
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.StopLoading()
Returns
void
StopSpeaking ()
Stop playback of currently played audio clip
Signature 
virtual void Meta.WitAi.TTS.Utilities.TTSSpeaker.StopSpeaking()
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta