API reference
TTSDiskCache Class
Extends MonoBehaviour, ITTSDiskCacheHandler
Fields
string DiskPath[Get]
TTSDiskCacheSettings DiskCacheDefaultSettings[Get]
Properties
TTSStreamEvents DiskStreamEvents[Get]
Protected Functions
virtual void OnDestroy ( )
virtual void OnStreamReady
( TTSClipData clipData,
string error )
Performs on ready callback if no error is present, otherwise considered complete
Parameters
clipData
The audio clip data container
error
Any error that occured during the stream.
virtual void OnStreamComplete
( TTSClipData clipData,
string error )
Removes request from list and performs final callbacks
Parameters
clipData
The audio clip data container
error
Any error that occured during the stream.
Member Functions
string GetDiskCachePath
( TTSClipData clipData )
Builds full cache path
Parameters
clipData
Returns
bool ShouldCacheToDisk
( TTSClipData clipData )
Determine if should cache to disk or not
Parameters
clipData
All clip data
Returns
Returns true if should cache to disk
void CheckCachedToDisk
( TTSClipData clipData,
Action< TTSClipData, bool > onCheckComplete )
Determines if file is cached on disk
Parameters
clipData
Request data
Returns
True if file is on disk
void StreamFromDiskCache
( TTSClipData clipData,
Action< TTSClipData, float > onProgress )
Performs async load request
void CancelDiskCacheStream
( TTSClipData clipData )
Cancels unity request
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)
© 2026 Meta