/// <summary>
/// Force a runtime cache unload
/// </summary>
public void Unload(TTSClipData clipData)
{
if (RuntimeCacheHandler != null)
{
RuntimeCacheHandler.RemoveClip(clipData.clipID);
}
else
{
OnUnloadBegin(clipData);
}
}
private void OnStreamReady(TTSClipData clipData, bool fromDisk)
{
// Refresh cache for file size
RuntimeCacheHandler?.AddClip(clipData);
// Now loaded
SetClipLoadState(clipData, TTSClipLoadState.Loaded);
// Invoke playback is ready
clipData.onPlaybackReady?.Invoke(string.Empty);
clipData.onPlaybackReady = null;
// Callback delegate
LogClip($"{(fromDisk ? "Disk" : "Web")} Stream Ready", clipData);
Events?.Stream?.OnStreamReady?.Invoke(clipData);
}
/// <summary>
/// Unload all audio clips from the runtime cache
/// </summary>
public void UnloadAll()
{
// Failed
TTSClipData[] clips = RuntimeCacheHandler?.GetClips();
if (clips == null)
{
return;
}
// Copy array
TTSClipData[] copy = new TTSClipData[clips.Length];
clips.CopyTo(copy, 0);
// Unload all clips
foreach (var clip in copy)
{
Unload(clip);
}
}
/// <summary> /// Obtain all clips from the runtime cache, if applicable /// </summary> public TTSClipData[] GetAllRuntimeCachedClips() => RuntimeCacheHandler?.GetClips();
/// <summary> /// Obtain a clip from the runtime cache, if applicable /// </summary> public TTSClipData GetRuntimeCachedClip(string clipID) => RuntimeCacheHandler?.GetClip(clipID);
/// <summary>
/// Perform a request for a TTS audio clip
/// </summary>
/// <param name="textToSpeak">Text to be spoken in clip</param>
/// <param name="clipID">Unique clip id</param>
/// <param name="voiceSettings">Custom voice settings</param>
/// <param name="diskCacheSettings">Custom cache settings</param>
/// <returns>Generated TTS clip data</returns>
public virtual TTSClipData Load(string textToSpeak, string clipID, TTSVoiceSettings voiceSettings,
TTSDiskCacheSettings diskCacheSettings, Action <TTSClipData, string> onStreamReady)
{
// Add delegates if needed
AddDelegates();
// Get clip data
TTSClipData clipData = CreateClipData(textToSpeak, clipID, voiceSettings, diskCacheSettings);
if (clipData == null)
{
Log("No clip provided", TTSLogType.Error);
onStreamReady?.Invoke(clipData, "No clip provided");
return(null);
}
// From Runtime Cache
if (clipData.loadState != TTSClipLoadState.Unloaded)
{
// Add callback
if (onStreamReady != null)
{
// Call once ready
if (clipData.loadState == TTSClipLoadState.Preparing)
{
clipData.onPlaybackReady += (e) => onStreamReady(clipData, e);
}
// Call after return
else
{
CoroutineUtility.StartCoroutine(CallAfterAMoment(() => onStreamReady(clipData,
clipData.loadState == TTSClipLoadState.Loaded ? string.Empty : "Error")));
}
}
// Return clip
return(clipData);
}
// Add to runtime cache if possible
if (RuntimeCacheHandler != null)
{
RuntimeCacheHandler.AddClip(clipData);
}
// Load begin
else
{
OnLoadBegin(clipData);
}
// Add on ready delegate
clipData.onPlaybackReady += (error) => onStreamReady(clipData, error);
// Wait a moment and load
CoroutineUtility.StartCoroutine(CallAfterAMoment(() =>
{
// Check for invalid text
string invalidError = WebHandler.IsTextValid(clipData.textToSpeak);
if (!string.IsNullOrEmpty(invalidError))
{
OnWebStreamError(clipData, invalidError);
return;
}
// If should cache to disk, attempt to do so
if (ShouldCacheToDisk(clipData))
{
// Download was canceled before starting
if (clipData.loadState != TTSClipLoadState.Preparing)
{
string downloadPath = DiskCacheHandler.GetDiskCachePath(clipData);
OnWebDownloadBegin(clipData, downloadPath);
OnWebDownloadCancel(clipData, downloadPath);
OnWebStreamBegin(clipData);
OnWebStreamCancel(clipData);
return;
}
// Download
DownloadToDiskCache(clipData, (clipData2, downloadPath, error) =>
{
// Download was canceled before starting
if (string.Equals(error, CANCEL_WARNING))
{
OnWebStreamBegin(clipData);
OnWebStreamCancel(clipData);
return;
}
// Success
if (string.IsNullOrEmpty(error))
{
DiskCacheHandler?.StreamFromDiskCache(clipData);
}
// Failed
else
{
WebHandler?.RequestStreamFromWeb(clipData);
}
});
}
// Simply stream from the web
else
{
// Stream was canceled before starting
if (clipData.loadState != TTSClipLoadState.Preparing)
{
OnWebStreamBegin(clipData);
OnWebStreamCancel(clipData);
return;
}
// Stream
WebHandler?.RequestStreamFromWeb(clipData);
}
}));
// Return data
return(clipData);
}