OnTtsReady: Difference between revisions
Jump to navigation
Jump to search
Document upcoming 0.1.7: optional server TTS, 33 functions, 4 events, English voice/setup guides and NPC meleeSkillTier; not a release |
Release 0.1.7 / BUILD199 / Protocol 39: current API availability, setup and improvements |
||
| Line 1: | Line 1: | ||
= onTtsReady = | = onTtsReady = | ||
<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;"> | <div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;"> | ||
<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;"> | <div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE SINCE UPDATE 0.1.7</div> | ||
<div style="color:#111111; margin-top:0.25rem;">This event is | <div style="color:#111111; margin-top:0.25rem;">This event is available since G1R:MP 0.1.7.</div> | ||
</div> | </div> | ||
| Line 32: | Line 32: | ||
== Notes == | == 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. | * 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. | * 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. | ||
Latest revision as of 23:50, 10 October 2026
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.