Service: TTS
Text-to-Speech functions that can be used for speech synthesis
Provides functions to get the capabilities for speech synthesis and to execute speech syntehsis. WinGuard itself only routes these function calls to a TTS extension which actually has them implemented. If no TTS extension is configured these functions will return an exception.
Functions
| Result | Name / Params | Comment | ||
|---|---|---|---|---|
| TtsCapabilities | tts.GetCapabilities ≥tts 0.1.0 | Returns the Text-to-Speech capabilities. | ||
| data | tts.SynthesizeSpeech ≥tts 0.1.0 | Synthesizes the given text to speech. | ||
| text | string | The text that should be synthesized to speech. If SSML is supported, the markup file can be put here. | ||
| language | string | (Optional) The language that should be used. If no language is provided, the language from the settings of the TTS extension is used. | ||
| voice | string | (Optional) The voice that should be used. If no voice is provided, the voice from the settings of the TTS extension is used. | ||
| format | string | (Optional) The format that should be used. If no format is provided, the format from the settings of the TTS extension is used. | ||
| rate | int | (Optional) The rate that should be used. If no rate is provided, the rate from the settings of the TTS extension is used. | ||
Objects
TtsCapabilities
| Property | Type | Description |
|---|---|---|
| Languages | string[] | Supported languages for speech synthesis. |
| Voices | string[] | Supported voices for speech synthesis. |
| Formats | string[] | Supported formats for speech synthesis. |
| Rates | int[] | Supported rates for speech synthesis. |
| SSML | bool | True if SSML is supported, otherwise false. |
Last modified September 25, 2026