GetTtsAudioInfo

From Wiki G1R-MP G1 Remake Multiplayer
Jump to navigation Jump to search

getTtsAudioInfo

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

Reads the current job information (both getters return the same information table).

Syntax

table|false getTtsAudioInfo(number job)

Parameters

Name Type Required Description
job number yes Job ID owned by this resource, returned by renderTts/generateTts/loadTtsAudio.

Returns

Table with id, state, error, source; name when named; sha256, bytes, duration (seconds), codec and sampleRate when audio is retained. Invalid/released handles return 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.
  • States: queued, running, ready, failed, cancelled, expired. source may be empty before readiness, then generated, disk or memory. Do not assume every optional field exists or every state transition emits an event.