API reference

Select your platform

No SDKs available

No versions available

Overview

AudioClipAudioSource

ImageViewer

Lib

TTSSpeaker Class

Extends MonoBehaviour, ISpeechEventProvider, ISpeaker, ITTSEventPlayer, ILogSource

Properties

IVLogger Logger[Get]

TTSService TTSService[Get]

string VoiceID[Get]

TTSVoiceSettings VoiceSettings[Get]

The voice settings to be used for this TTSSpeaker

bool IsPreparing[Get]

Whether any queued clips are still not ready for playback

List< TTSClipData > QueuedClips[Get]

IAudioPlayer AudioPlayer[Get]

The script used to perform audio playback of IAudioClipStreams.

Gets IAudioPlayer component if applied to this speaker

If no IAudioPlayer component is found, the TTSService's audio system will be used to generate an audio player.

If still not found, adds a UnityAudioPlayer.

AudioSource AudioSource[Get]

bool IsPaused[Get]

Whether playback is currently paused or not

int ElapsedSamples[Get]

The current amount of elapsed samples of the playing audio data if applicable

TTSEventSampleDelegate OnSampleUpdated[Get]

The callback following the change of the current sample

TTSEventContainerDelegate OnEventsUpdated[Get]

The callback following a tts event update

Fields

TTSSpeakerEvents Events[Get]

VoiceSpeechEvents SpeechEvents[Get]

string PrependedText[Get]

string AppendedText[Get]

TTSWitVoiceSettings customWitVoiceSettings[Get]

bool IsSpeaking[Get]

Whether a clip is currently playing for this speaker

TTSClipData SpeakingClip[Get]

The data for the currently playing clip

bool IsLoading[Get]

Whether there are any clips in the loading queue

bool IsActive[Get]

Whether the speaker currently has currently speaking clip or a playback queue

int TotalSamples[Get]

The total samples available for the current tts events

TTSEventContainer CurrentEvents[Get]

The current tts events available

Protected Functions

virtual void Start ( )

virtual void OnDestroy ( )

virtual void OnEnable ( )

virtual void OnDisable ( )

virtual void HandleClipUnload

( TTSClipData clipData )

virtual bool IsPlaybackComplete ( )

virtual void HandlePlaybackComplete

( bool stopped )

virtual void SetPause

( bool toPaused )

virtual void RaiseOnPlaybackQueueBegin ( )

virtual void RaiseOnPlaybackQueueComplete ( )

virtual void RaisePlaybackSampleUpdated

( int sample )

Updates callback sample

virtual void RaisePlaybackEventsUpdated

( TTSEventContainer events )

Updates event callback

Member Functions

List< string > GetFinalText

( string textToSpeak )

Gets final text following prepending/appending and any special formatting

Parameters

textToSpeak

The base text to be spoken

Returns

Returns an array of split texts to be spoken

List< string > GetFinalTextFormatted

( string format,

params string [] textsToSpeak )

Obtain final text list from format and text list

Parameters

format

The format to be used

textsToSpeak

The array of strings to be inserted into the format

Returns

Returns a list of formatted texts

string GetFormattedText

( string format,

params string [] textsToSpeak )

Formats text using an initial format string parameter and additional text items to be inserted into the format

Parameters

format

The format to be used

textsToSpeak

The array of strings to be inserted into the format

Returns

A formatted text string

void Speak

( string textToSpeak,

TTSDiskCacheSettings diskCacheSettings,

TTSSpeakerClipEvents playbackEvents )

Load a tts clip using the specified text, disk cache settings and playback events. Cancels all previous clips when loaded and then plays.

Parameters

textToSpeak

The text to be spoken

diskCacheSettings

Specific tts load caching settings

playbackEvents

Events to be called for this specific tts playback request

void Speak

( string textToSpeak,

TTSSpeakerClipEvents playbackEvents )

Load a tts clip using the specified text and playback events. Cancels all previous clips when loaded and then plays.

Parameters

textToSpeak

The text to be spoken

playbackEvents

Events to be called for this specific tts playback request

void Speak

( string textToSpeak,

TTSDiskCacheSettings diskCacheSettings )

Load a tts clip using the specified text and disk cache settings. Cancels all previous clips when loaded and then plays.

Parameters

textToSpeak

The text to be spoken

diskCacheSettings

Specific tts load caching settings

void Speak

( string textToSpeak )

Load a tts clip using the specified text. Cancels all previous clips when loaded and then plays.

Parameters

textToSpeak

The text to be spoken

void SpeakFormat

( string format,

params string [] textsToSpeak )

Loads a formated phrase to be spoken. Cancels all previous clips when loaded and then plays.

Parameters

format

Format string to be filled in with texts

textsToSpeak

Texts to be inserted into the formatter

IEnumerator SpeakAsync

( string textToSpeak,

TTSDiskCacheSettings diskCacheSettings,

TTSSpeakerClipEvents 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.

Parameters

textToSpeak

The text to be spoken

diskCacheSettings

Specific tts load caching settings

playbackEvents

Events to be called for this specific tts playback request

IEnumerator SpeakAsync

( string textToSpeak,

TTSSpeakerClipEvents 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.

Parameters

textToSpeak

The text to be spoken

playbackEvents

Events to be called for this specific tts playback request

IEnumerator SpeakAsync

( string textToSpeak,

TTSDiskCacheSettings 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.

Parameters

textToSpeak

The text to be spoken

diskCacheSettings

Specific tts load caching settings

IEnumerator SpeakAsync

( string 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.

Parameters

textToSpeak

The text to be spoken

Task SpeakTask

( string textToSpeak,

TTSDiskCacheSettings diskCacheSettings,

TTSSpeakerClipEvents 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.

Parameters

textToSpeak

The text to be spoken

diskCacheSettings

Specific tts load caching settings

playbackEvents

Events to be called for this specific tts playback request

Task SpeakTask

( string textToSpeak,

TTSSpeakerClipEvents 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.

Parameters

textToSpeak

The text to be spoken

playbackEvents

Events to be called for this specific tts playback request

Task SpeakTask

( string textToSpeak,

TTSDiskCacheSettings 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.

Parameters

textToSpeak

The text to be spoken

diskCacheSettings

Specific tts load caching settings

Task SpeakTask

( string 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.

Parameters

textToSpeak

The text to be spoken

Task SpeakTask

( WitResponseNode responseNode,

TTSSpeakerClipEvents 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.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

playbackEvents

Events to be called for this specific tts playback request

Returns

True if responseNode is decoded successfully

void SpeakQueued

( string textToSpeak,

TTSDiskCacheSettings diskCacheSettings,

TTSSpeakerClipEvents 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.

Parameters

textToSpeak

The text to be spoken

diskCacheSettings

Specific tts load caching settings

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 and playback events. Adds clip to playback queue and will speak once queue has completed all playback.

Parameters

textToSpeak

The text to be spoken

playbackEvents

Events to be called for this specific tts playback request

void SpeakQueued

( string textToSpeak,

TTSDiskCacheSettings 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.

Parameters

textToSpeak

The text to be spoken

diskCacheSettings

Specific tts load caching settings

void SpeakQueued

( string textToSpeak )

Load a tts clip using the specified text. Adds clip to playback queue and will speak once queue has completed all playback.

Parameters

textToSpeak

The text to be spoken

void SpeakFormatQueued

( string format,

params string [] textsToSpeak )

Loads a formated phrase to be spoken. Adds clip to playback queue and will speak once queue has completed all playback.

Parameters

format

Format string to be filled in with texts

textsToSpeak

Texts to be inserted into the formatter

IEnumerator SpeakQueuedAsync

( string [] textsToSpeak,

TTSDiskCacheSettings diskCacheSettings,

TTSSpeakerClipEvents 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.

Parameters

textsToSpeak

Multiple texts to be spoken

diskCacheSettings

Specific tts load caching 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 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.

Parameters

textsToSpeak

Multiple texts to be spoken

playbackEvents

Events to be called for this specific tts playback request

IEnumerator SpeakQueuedAsync

( string [] textsToSpeak,

TTSDiskCacheSettings 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.

Parameters

textsToSpeak

Multiple texts to be spoken

diskCacheSettings

Specific tts load caching settings

IEnumerator SpeakQueuedAsync

( string [] 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.

Parameters

textsToSpeak

Multiple texts to be spoken

Task SpeakQueuedTask

( string [] textsToSpeak,

TTSDiskCacheSettings diskCacheSettings,

TTSSpeakerClipEvents playbackEvents )

Parameters

textsToSpeak

Multiple texts to be spoken

diskCacheSettings

Specific tts load caching settings

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 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.

Parameters

textsToSpeak

Multiple texts to be spoken

playbackEvents

Events to be called for this specific tts playback request

Task SpeakQueuedTask

( string [] textsToSpeak,

TTSDiskCacheSettings diskCacheSettings )

Parameters

textsToSpeak

Multiple texts to be spoken

diskCacheSettings

Specific tts load caching settings

Task SpeakQueuedTask

( string [] 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.

Parameters

textsToSpeak

Multiple texts to be spoken

void SetVoiceOverride

( TTSVoiceSettings overrideVoiceSettings )

Set a voice override for future requests

Parameters

overrideVoiceSettings

The settings to be applied to upcoming requests

void ClearVoiceOverride ( )

Clears the current voice override

bool Speak

( WitResponseNode responseNode,

TTSDiskCacheSettings diskCacheSettings,

TTSSpeakerClipEvents 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.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

diskCacheSettings

Specific tts load caching settings

playbackEvents

Events to be called for this specific tts playback request

Returns

True if responseNode is decoded successfully

bool Speak

( WitResponseNode responseNode,

TTSDiskCacheSettings diskCacheSettings )

Load a tts clip using the specified response node and disk cache settings Cancels all previous clips when loaded and then plays.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

diskCacheSettings

Specific tts load caching settings

Returns

True if responseNode is decoded successfully

bool Speak

( WitResponseNode responseNode,

TTSSpeakerClipEvents playbackEvents )

Load a tts clip using the specified response node and playback events Cancels all previous clips when loaded and then plays.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

playbackEvents

Events to be called for this specific tts playback request

Returns

True if responseNode is decoded successfully

bool Speak

( WitResponseNode responseNode )

Load a tts clip using the specified response node and playback events Cancels all previous clips when loaded and then plays.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

Returns

True if responseNode is decoded successfully

IEnumerator SpeakAsync

( WitResponseNode responseNode,

TTSDiskCacheSettings diskCacheSettings,

TTSSpeakerClipEvents 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.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

diskCacheSettings

Specific tts load caching settings

playbackEvents

Events to be called for this specific tts playback request

IEnumerator SpeakAsync

( WitResponseNode responseNode,

TTSSpeakerClipEvents 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.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

playbackEvents

Events to be called for this specific tts playback request

IEnumerator SpeakAsync

( WitResponseNode responseNode,

TTSDiskCacheSettings 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.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

diskCacheSettings

Specific tts load caching settings

bool SpeakQueued

( WitResponseNode responseNode,

TTSDiskCacheSettings diskCacheSettings,

TTSSpeakerClipEvents 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.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

diskCacheSettings

Specific tts load caching settings

playbackEvents

Events to be called for this specific tts playback request

Returns

True if responseNode is decoded successfully

bool SpeakQueued

( WitResponseNode responseNode,

TTSSpeakerClipEvents 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.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

playbackEvents

Events to be called for this specific tts playback request

Returns

True if responseNode is decoded successfully

bool SpeakQueued

( WitResponseNode responseNode,

TTSDiskCacheSettings 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.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

diskCacheSettings

Specific tts load caching settings

Returns

True if responseNode is decoded successfully

bool SpeakQueued

( WitResponseNode responseNode )

Load a tts clip using the specified text. Adds clip to playback queue and will speak once queue has completed all playback.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

Returns

True if responseNode is decoded successfully

IEnumerator SpeakQueuedAsync

( WitResponseNode responseNode,

TTSDiskCacheSettings diskCacheSettings,

TTSSpeakerClipEvents playbackEvents )

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

diskCacheSettings

Specific tts load caching settings

playbackEvents

Events to be called for this specific tts playback request

IEnumerator SpeakQueuedAsync

( WitResponseNode responseNode,

TTSSpeakerClipEvents 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.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

playbackEvents

Events to be called for this specific tts playback request

IEnumerator SpeakQueuedAsync

( WitResponseNode responseNode,

TTSDiskCacheSettings diskCacheSettings )

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

diskCacheSettings

Specific tts load caching settings

IEnumerator SpeakQueuedAsync

( WitResponseNode 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.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

Task SpeakQueuedTask

( WitResponseNode responseNode,

TTSDiskCacheSettings diskCacheSettings,

TTSSpeakerClipEvents playbackEvents )

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

diskCacheSettings

Specific tts load caching 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 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.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

playbackEvents

Events to be called for this specific tts playback request

Task SpeakQueuedTask

( WitResponseNode responseNode,

TTSDiskCacheSettings diskCacheSettings )

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

diskCacheSettings

Specific tts load caching settings

Task SpeakQueuedTask

( WitResponseNode 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.

Parameters

responseNode

Parsed data that includes text to be spoken and voice settings

virtual void Stop

( string textToSpeak,

bool allInstances )

Stop load and playback of a specific clip

Parameters

textToSpeak

Stop a specific text phrase

allInstances

Whether to remove the first instance of this clip or all instances