ReleaseTtsJob

From Wiki G1R-MP G1 Remake Multiplayer
Revision as of 23:50, 10 October 2026 by QCherry (talk | contribs) (Release 0.1.7 / BUILD199 / Protocol 39: current API availability, setup and improvements)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

releaseTtsJob

AVAILABLE SINCE UPDATE 0.1.7
This function is available since G1R:MP 0.1.7.

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. 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.
  • The handle immediately becomes invalid. No completion callback is promised after release. Stored recordings remain, and active playbacks retain their own audio reference.