API reference
TTSWit Class
Extends TTSService, ITTSVoiceProvider, ITTSWebHandler, IWitConfigurationProvider, IWitConfigurationSetter, ILogSource
Fields
override ITTSVoiceProvider VoiceProvider[Get]
The voice provider used for preset voice settings. Uses TTSWit with TTSWitVoiceSettings
override ITTSWebHandler WebHandler[Get]
This script provides web request handling
TTSWitRequestSettings RequestSettings[Get]
TTSWitVoiceSettings [] PresetWitVoiceSettings[Get]
TTSVoiceSettings VoiceDefaultSettings[Get]
Properties
WitConfiguration Configuration[Get]
The configuration to be updated
TTSVoiceSettings [] PresetVoiceSettings[Get]
Events
Action< WitConfiguration > OnConfigurationUpdated
Callback following configuration change
Protected Functions
virtual override void OnEnable ( )
Attempt to instantiate web socket adapter and setup audio system
virtual void RefreshWebSocketSettings ( )
Refreshes client provider on web socket settings
virtual override void OnDisable ( )
Ensures web socket adapter disconnects from the client
Member Functions
virtual override string GetInvalidError ( )
Returns error if invalid
string GetWebErrors
( TTSClipData clipData )
Method for determining if there are problems that will arise with performing a web request prior to doing so
Parameters
clipData
The clip data to be used for the request
Returns
Invalid error(s). It will be empty if there are none
TTSClipData CreateClipData
( string clipId,
string textToSpeak,
TTSVoiceSettings voiceSettings,
TTSDiskCacheSettings diskCacheSettings )
Method for creating a new TTSClipData
Parameters
clipId
Unique clip identifier
textToSpeak
Text to be spoken
voiceSettings
Settings for how the clip should sound during playback.
diskCacheSettings
If and how this clip should be cached.
bool DecodeTtsFromJson
( WitResponseNode responseNode,
out string textToSpeak,
out TTSVoiceSettings voiceSettings )
Decode a response node into text to be spoken or a specific voice setting Example Data: { "q": "Text to be spoken" "voice": "Charlie }
Parameters
responseNode
Parsed data that includes text to be spoken and voice settings
textToSpeak
The text to be spoken output
voiceSettings
The output for voice settings
Returns
True if decode was successful
async Task< string > RequestStreamFromWeb
( TTSClipData clipData,
Action< TTSClipData > onReady )
Method for streaming audio from a back-end service.
Parameters
clipData
Information about the clip being requested.
onReady
Callback on request is ready for playback.
Task< string > RequestDownloadFromWeb
( TTSClipData clipData,
string diskPath )
Method for performing a web download request
Parameters
clipData
Clip request data
diskPath
The specific disk path the file should be downloaded to
async Task< string > IsDownloadedToDisk
( string diskPath )
Checks if file exists on disk
async Task< string > RequestStreamFromDisk
( TTSClipData clipData,
string diskPath,
Action< TTSClipData > onReady )
Streams from disk
bool CancelRequests
( TTSClipData clipData )
Cancels any running requests
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