API reference
ITTSWebHandler Interface
Member Functions
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
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
Task< string > RequestStreamFromWeb
( TTSClipData clipData,
Action< TTSClipData > onReady )
Streams audio from a web service and returns an error if applicable.
Parameters
clipData
Information about the clip being requested.
onReady
Callback on request is ready for playback.
Task< string > IsDownloadedToDisk
( string diskPath )
Performs a check to determine if a file is cached to disk or not
Parameters
diskPath
The path to be checked
Returns
Returns an error if the path cannot be found
Task< string > RequestStreamFromDisk
( TTSClipData clipData,
string diskPath,
Action< TTSClipData > onReady )
Downloads audio from a web service and returns an error if applicable.
Parameters
clipData
Information about the clip being requested.
diskPath
The specific disk path of the file.
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
bool CancelRequests
( TTSClipData clipData )
Cancels any request for a specific clip
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