GetTtsPlaybackState: 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: | ||
= getTtsPlaybackState = | = getTtsPlaybackState = | ||
<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 function is | <div style="color:#111111; margin-top:0.25rem;">This function is available since G1R:MP 0.1.7.</div> | ||
</div> | </div> | ||
| Line 23: | Line 23: | ||
== Notes == | == Notes == | ||
* Server-side only. | * Server-side only. Available since 0.1.7. | ||
* See [[Server TTS]], [[TTS configuration]] and [[TTS voices]] for installation, options, ownership, cache and examples. | * 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. | * 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. | ||
Latest revision as of 23:50, 10 October 2026
getTtsPlaybackState
AVAILABLE SINCE UPDATE 0.1.7
This function is available since G1R:MP 0.1.7.
Reads an active playback/preload handle.
Syntax
table|false getTtsPlaybackState(number playback)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playback |
number |
yes | Active playback/preload ID owned by this resource; not a job or ordinary sound handle. |
Returns
A table {id, state, recipients}; state is preparing, playing or paused, and recipients is a count. Finished handles return false, reason; use terminal events to record results.
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.
- playing means a common start has been scheduled (normally 500 ms ahead), not proof that a speaker already emitted sound.