API reference
API reference
Select your platform
No SDKs available
No versions available

ISpeaker Interface

Properties

AudioPlayer : IAudioPlayer
[Get]
The script used to perform audio playback of IAudioClipStreams.
Signature
IAudioPlayer Meta.WitAi.TTS.Interfaces.ISpeaker.AudioPlayer
[Get]
Events related to the playback of TTS
Signature
TTSSpeakerEvents Meta.WitAi.TTS.Interfaces.ISpeaker.Events
IsPaused : bool
[Get]
Whether a clip is currently paused
Signature
bool Meta.WitAi.TTS.Interfaces.ISpeaker.IsPaused
IsSpeaking : bool
[Get]
Whether a clip is currently playing for this speaker
Signature
bool Meta.WitAi.TTS.Interfaces.ISpeaker.IsSpeaking
VoiceSettings : TTSVoiceSettings
[Get]
The specific voice properties used by this speaker
Signature
TTSVoiceSettings Meta.WitAi.TTS.Interfaces.ISpeaker.VoiceSettings

Methods

EndTextBlock ()
Call at the end of a larger text block to indicate a block of text is complete.
Signature
void Meta.WitAi.TTS.Interfaces.ISpeaker.EndTextBlock()
Returns
void
Pause ()
Pause any current or future loaded audio playback
Signature
void Meta.WitAi.TTS.Interfaces.ISpeaker.Pause()
Returns
void
PrepareToSpeak ()
Call before sending speech data to warm up TTS system
Signature
void Meta.WitAi.TTS.Interfaces.ISpeaker.PrepareToSpeak()
Returns
void
Resume ()
Resume playback for current and future audio clips
Signature
void Meta.WitAi.TTS.Interfaces.ISpeaker.Resume()
Returns
void
Speak ( textToSpeak , playbackEvents )
Load a tts clip using the specified text & playback events. Cancels all previous clips when loaded & then plays.
Signature
void Meta.WitAi.TTS.Interfaces.ISpeaker.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 ( responseNode , playbackEvents )
Load a tts clip using the specified response node & playback events Cancels all previous clips when loaded & then plays.
Signature
bool Meta.WitAi.TTS.Interfaces.ISpeaker.Speak(WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken & voice settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
bool  True if responseNode is decoded successfully
SpeakAsync ( 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.
Signature
IEnumerator Meta.WitAi.TTS.Interfaces.ISpeaker.SpeakAsync(string textToSpeak)
Parameters
textToSpeak: string  The text to be spoken
Returns
IEnumerator
SpeakQueued ( textToSpeak , playbackEvents )
Load a tts clip using the specified text & playback events. Cancels all previous clips when loaded & then plays.
Signature
void Meta.WitAi.TTS.Interfaces.ISpeaker.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
SpeakQueuedAsync ( responseNode , 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.
Signature
IEnumerator Meta.WitAi.TTS.Interfaces.ISpeaker.SpeakQueuedAsync(WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken & voice 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 & 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.Interfaces.ISpeaker.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
SpeakQueuedTask ( responseNode , 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.
Signature
Task Meta.WitAi.TTS.Interfaces.ISpeaker.SpeakQueuedTask(WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken & voice 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 & 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.Interfaces.ISpeaker.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
SpeakTask ( 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.
Signature
Task Meta.WitAi.TTS.Interfaces.ISpeaker.SpeakTask(string textToSpeak)
Parameters
textToSpeak: string  The text to be spoken
Returns
Task
SpeakTask ( textToSpeak , 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.
Signature
Task Meta.WitAi.TTS.Interfaces.ISpeaker.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 ( responseNode , playbackEvents )
Load a tts clip using the specified response node & playback events Cancels all previous clips when loaded & then plays.
Signature
Task Meta.WitAi.TTS.Interfaces.ISpeaker.SpeakTask(WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents)
Parameters
responseNode: WitResponseNode  Parsed data that includes text to be spoken & voice settings
playbackEvents: TTSSpeakerClipEvents Events to be called for this specific tts playback request
Returns
Task
StartTextBlock ()
Call at the start of a larger text block to indicate many queued requests will be coming
Signature
void Meta.WitAi.TTS.Interfaces.ISpeaker.StartTextBlock()
Returns
void
Stop ()
Stops loading & playback immediately
Signature
void Meta.WitAi.TTS.Interfaces.ISpeaker.Stop()
Returns
void