CancelTtsJob
cancelTtsJob
AVAILABLE SINCE UPDATE 0.1.7
This function is available since G1R:MP 0.1.7.
Cancels a queued/running job owned by this resource.
Syntax
bool cancelTtsJob(number job)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
job |
number |
yes | Job ID owned by this resource, returned by renderTts/generateTts/loadTtsAudio. |
Returns
true when cancelled; false for a job no longer pending; false, reason for an invalid handle.
Notes
- Server-side only. Available since 0.1.7.
- 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.
- Cancellation produces a cancelled notification. Release the handle afterwards. This does not delete stored recordings or stop a playback started from an earlier ready job.