CreateTtsPreset

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

createTtsPreset

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.

Creates a reusable server-owned preset configuration; does not train a model or generate audio.

Syntax

table|false createTtsPreset(string name, table configuration)

Parameters

Name Type Required Description
name string yes Resource-private identifier: 1–64 ASCII letters, digits, underscores or hyphens; case-sensitive.
configuration table yes engine, language, optional seed, reference, referenceHash and parameters. No text field. See TTS voices for complete examples and bounds.

Returns

The normalized validated configuration, or false, reason.

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.
  • Creation rejects an existing name. Updating requires an existing profile when using updateTtsPreset.
  • Profiles are in-memory per resource. Persist with exportTtsPresets/writeResourceData and restore with importTtsPresets. The audio samples remain separately in voiceDirectory.