OnTtsReady

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

onTtsReady

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

Reports that a job now retains ready audio.

Availability

This event is available in server scripts.

Callback signature

function(id, info)

Parameters

Name Type Description
id number Resource-owned job ID.
info table id, state="ready", error, source, sha256, bytes, duration, codec, sampleRate; name when saved. Play/preload here; this is not a playback-start event.

Examples

addEventHandler("onTtsReady", resourceRoot, function(id, info)
    outputDebugString("TTS " .. id .. ": " .. tostring(info.state))
end)

Notes

  • Available since 0.1.7.
  • Register with addEventHandler on resourceRoot before submitting requests. Delivered only to the owning server resource; info is a Lua table, not JSON text.
  • See Server TTS for complete lifecycle examples and cleanup. Stopping the resource cleans up its work/audio; no callbacks are promised after its VM stops.