PreloadTtsAudio
preloadTtsAudio
PLANNED FOR UPDATE 0.1.7
This function is planned for G1R:MP 0.1.7. It is not included in the public 0.1.6 release.
Asks recipients to download, validate and decode ready audio without playing it.
Syntax
number|false preloadTtsAudio(number readyJob, table options)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
readyJob |
number |
yes | Job ID owned by this resource, returned by renderTts/generateTts/loadTtsAudio. |
options |
table |
yes | Required table, {} for defaults. players, volume, looped, lateJoin, readyTimeoutMs; position/minDistance/maxDistance for spatial playback; attachment only for playTtsAttached. See Server TTS#Playback and synchronization. |
Returns
A playback/preload handle, or false, reason. The job must retain ready audio.
Notes
- Server-side only. Coming in 0.1.7 — not released yet; not included in public 0.1.6.
- See Server TTS, TTS configuration and TTS voices for installation, options, ownership, cache and examples.
- Invalid requests return false, reason. Profiles, jobs and playback handles belong to the calling resource; do not use handles from another resource or a previous resource lifetime.
- Returns a separate playback/preload ID, not the job ID. Observe onTtsPlaybackStateChange. Acceptance/readiness does not prove speaker audibility.
- Omitting players selects currently connected players. Explicit recipients must be online; an empty list is rejected. lateJoin defaults to false and does not expand an explicit recipient list.
- The handle terminates at preloaded or preload-timeout. To play later, keep a ready job (or reload its saved name) and call a play function for a new playback ID. Preload does not reserve an indefinite client cache entry.