LoadTtsAudio

From Wiki G1R-MP G1 Remake Multiplayer
Revision as of 22:48, 8 October 2026 by QCherry (talk | contribs) (Document upcoming 0.1.7: optional server TTS, 33 functions, 4 events, English voice/setup guides and NPC meleeSkillTier; not a release)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

loadTtsAudio

PLANNED FOR UPDATE 0.1.7
This function is planned for G1R:MP 0.1.7. It is not included in the public 0.1.6 release.

Loads a previously named recording from persistent storage without inference.

Syntax

number|false loadTtsAudio(string name)

Parameters

Name Type Required Description
name string yes Resource-private identifier: 1–64 ASCII letters, digits, underscores or hyphens; case-sensitive.

Returns

An asynchronous job ID, or false, reason. Wait for onTtsReady/onTtsError.

Notes

  • Server-side only. Coming in 0.1.7 — not released yet; not included in public 0.1.6.
  • 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.
  • name is a prior saveAs name in the same resource, not a filename or URL. Missing/corrupt recordings report an error; this function never generates a replacement.
  • The server TTS feature must remain enabled, but loading an existing recording does not require an inference worker.