GetTtsCapabilities

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

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.