GetTtsPlaybackState

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.