API reference
TTSClipData Class
Fields
string textToSpeak[Get]
string clipID[Get]
AudioType audioType[Get]
TTSVoiceSettings voiceSettings[Get]
TTSDiskCacheSettings diskCacheSettings[Get]
bool queryStream[Get]
Dictionary< string, string > queryParameters[Get]
TTSClipLoadState loadState[Get]
float loadProgress[Get]
float readyDuration[Get]
Amount of time from request begin to ready callback in seconds
float completeDuration[Get]
Amount of time from request begin to complete callback in seconds
Action< TTSClipData, TTSClipLoadState > onStateChange[Get]
bool useEvents[Get]
Whether or not this tts clip data is requesting event data with tts stream.
string extension[Get]
The file extension to be used for this specific file type. Includes the period.
Action< TTSClipData > onPlaybackReady[Get]
A callback when clip stream is ready Returns an error if there was an issue
Action< string > onDownloadComplete[Get]
A callback when clip has downloaded successfully Returns an error if there was an issue
Action< TTSClipData > onPlaybackQueued[Get]
Called when a script has queued playback with this clip
Action< TTSClipData > onPlaybackBegin[Get]
Called when a script has began playback with this clip
Action< TTSClipData > onPlaybackComplete[Get]
Called when a script has completed playback with this clip
Properties
string queryRequestId[Get]
Unique request id used for tracking & logging
IAudioClipStream clipStream[Get]
AudioClip clip[Get]
TTSEventContainer Events[Get]
The currently set tts events
string LoadError[Get]
Any error that occurs during the load process
TaskCompletionSource< bool > LoadReady[Get]
Task that returns when ready for playback
TaskCompletionSource< bool > LoadCompletion[Get]
Task that returns when complete
Member Functions
override bool Equals
( object obj )
Compare clips if possible
bool Equals
( TTSClipData other )
Compare clip ids
bool HasClipId
( string clipId )
Compare clip ids
override int GetHashCode ( )
Get hash code
override string ToString ( )
Obtains all clip data via formatting
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