GetTtsCapabilities: Difference between revisions

From Wiki G1R-MP G1 Remake Multiplayer
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:
= getTtsCapabilities =
= getTtsCapabilities =
<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;">PLANNED FOR UPDATE 0.1.7</div>
<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 planned for G1R:MP 0.1.7. It is not included in the public 0.1.6 release.</div>
<div style="color:#111111; margin-top:0.25rem;">This function is available since G1R:MP 0.1.7.</div>
</div>
</div>


Line 26: Line 26:


== Notes ==
== Notes ==
* Server-side only. Coming in 0.1.7 — not released yet; not included in public 0.1.6.
* 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

getTtsCapabilities

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

Reads supported engines, language lists, parameter bounds and service status without loading a model.

Syntax

table getTtsCapabilities()

Parameters

This function does not accept parameters.

Returns

A table containing schema, engines, maxTextBytes, maxAudioBytes, maxDurationSeconds, liveGeneration, enabled, workerThreads and cachedBytes.

Examples

local caps = getTtsCapabilities()
local bounds = caps.engines.chatterbox_v3.parameters.temperature
outputDebugString("Default temperature: " .. bounds[1])

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.
  • engines[engine].parameters[name] is an array: [1] default, [2] minimum, [3] maximum. Capability metadata is available with TTS disabled; enabled is then false.
  • Capabilities describe the API, not proof that every engine is installed or reachable. workerThreads is not a count of loaded speech models.