ReleaseTtsJob
releaseTtsJob
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.
Releases a job handle and cancels work still pending for that handle.
Syntax
bool releaseTtsJob(number job)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
job |
number |
yes | Job ID owned by this resource, returned by renderTts/generateTts/loadTtsAudio. |
Returns
true if released, or false, reason.
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.
- The handle immediately becomes invalid. No completion callback is promised after release. Stored recordings remain, and active playbacks retain their own audio reference.