SetTtsVolume
setTtsVolume
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.
Changes playback volume without changing the generated recording.
Syntax
bool setTtsVolume(number playback, number volume)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playback |
number |
yes | Active playback/preload ID owned by this resource; not a job or ordinary sound handle. |
volume |
number |
yes | Finite value 0..1. |
Returns
true when accepted, 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.
- No onTtsPlaybackStateChange event is promised for every control call. Query getTtsPlaybackState when appropriate. Distances affect spatial audio, not the voice/model configuration.