# Text to Speech

> Symcon documentation · English · generated on 2026-09-26  
> Index: https://www.symcon.de/en/llms.txt

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/text-to-speech/

The TTS module can convert text to speech. The system-internal speech software or a post-installed one is used for this.

> **Warning:** The TTS module can currently only be used in the Windows installation. Alternatively, the "[Text to Speech (AWS Polly)](ttsawspolly.md)" module from the Module Store can be used. This works on all operating systems.

### Setup in IP-Symcon

The speech engine and the audio output device can be set in the configuration tab.

In order to make a voice output, the PHP function [TTS_Speak](text-to-speech.md) or [TTS_GenerateFile](text-to-speech.md) must be called from a script.

> **Warning:** The TTS_Speak function is deprecated and no longer supported on Windows Vista or higher. TTS_GenerateFile works in all versions.

When using [TTS_GenerateFile](text-to-speech.md), the use of [MediaPlayer](amazon-alexa.md)  is necessary.
An example code can be found under [TTS_GenerateFile](text-to-speech.md).

### Installation

In addition to possible standard voices, other German and international versions can be found [here](http://ttssamples.syntheticspeech.de/deutsch/index.html) .

#### Exception Windows Vista/7
In order to be able to use the speech output under Windows Vista/7, the IP-Symcon service must be run as a local user. It should be noted that this means that the IPS_ExecuteEx function is no longer available.

Call up the service management via Start > Run
_%SystemRoot%\system32\services.msc /s_

![Service Overview](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/text-to-speech/cd32996812-1790424938/tts-dienstuebersicht.png)

Double click on the entry IP-Symcon Environment. The following dialog should open and the password for the current user must be entered in the "Login" tab.

![Register Service](https://www.symcon.de/media/pages/service/dokumentation/modulreferenz/benachrichtigungen/text-to-speech/4ad5a8da5a-1790424938/tts-dienstanmelden.png)

After confirming with Apply/OK, the IP-Symcon service must be restarted. The easiest way to stop and start this is via the tray.

## TTS_GenerateFile

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/text-to-speech/tts-generatefile/

`bool TTS_GenerateFile(int $InstanceID, string $Text, string $Filename, int $Format)`

generates a WAV file with the desired text

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Text` (string): Text to be said
- `$Filename` (string): Filename/-path in the system
- `$Format` (int)

  | Format               | Value |
  | -------------------- | ----- |
  | Default              | 0     |
  | 8kHz, 8Bit, Mono     | 4     |
  | 8kHz, 8Bit, Stereo   | 5     |
  | 8kHz, 16Bit, Mono    | 6     |
  | 8kHz, 16Bit, Stereo  | 7     |
  | 11kHz, 8Bit, Mono    | 8     |
  | 11kHz, 8Bit, Stereo  | 9     |
  | 11kHz, 16Bit, Mono   | 10    |
  | 11kHz, 16Bit, Stereo | 11    |
  | 12kHz, 8Bit, Mono    | 12    |
  | 12kHz, 8Bit, Stereo  | 13    |
  | 12kHz, 16Bit, Mono   | 14    |
  | 12kHz, 16Bit, Stereo | 15    |
  | 16kHz, 8Bit, Mono    | 16    |
  | 16kHz, 8Bit, Stereo  | 17    |
  | 16kHz, 16Bit, Mono   | 18    |
  | 16kHz, 16Bit, Stereo | 19    |
  | 22kHz, 8Bit, Mono    | 20    |
  | 22kHz, 8Bit, Stereo  | 21    |
  | 22kHz, 16Bit, Mono   | 22    |
  | 22kHz, 16Bit, Stereo | 23    |
  | 24kHz, 8Bit, Mono    | 24    |
  | 24kHz, 8Bit, Stereo  | 25    |
  | 24kHz, 16Bit, Mono   | 26    |
  | 24kHz, 16Bit, Stereo | 27    |
  | 32kHz, 8Bit, Mono    | 28    |
  | 32kHz, 8Bit, Stereo  | 29    |
  | 32kHz, 8Bit, Stereo  | 30    |
  | 32kHz, 16Bit, Stereo | 31    |
  | 44kHz, 8Bit, Mono    | 32    |
  | 44kHz, 8Bit, Stereo  | 33    |
  | 44kHz, 16Bit, Mono   | 34    |
  | 44kHz, 16Bit, Stereo | 35    |
  | 48kHz, 8Bit, Mono    | 36    |
  | 48kHz, 8Bit, Stereo  | 37    |
  | 48kHz, 16Bit, Mono   | 38    |
  | 48kHz, 16Bit, Stereo | 39    |

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

| Format               | Value |
| -------------------- | ----- |
| Default              | 0     |
| 8kHz, 8Bit, Mono     | 4     |
| 8kHz, 8Bit, Stereo   | 5     |
| 8kHz, 16Bit, Mono    | 6     |
| 8kHz, 16Bit, Stereo  | 7     |
| 11kHz, 8Bit, Mono    | 8     |
| 11kHz, 8Bit, Stereo  | 9     |
| 11kHz, 16Bit, Mono   | 10    |
| 11kHz, 16Bit, Stereo | 11    |
| 12kHz, 8Bit, Mono    | 12    |
| 12kHz, 8Bit, Stereo  | 13    |
| 12kHz, 16Bit, Mono   | 14    |
| 12kHz, 16Bit, Stereo | 15    |
| 16kHz, 8Bit, Mono    | 16    |
| 16kHz, 8Bit, Stereo  | 17    |
| 16kHz, 16Bit, Mono   | 18    |
| 16kHz, 16Bit, Stereo | 19    |
| 22kHz, 8Bit, Mono    | 20    |
| 22kHz, 8Bit, Stereo  | 21    |
| 22kHz, 16Bit, Mono   | 22    |
| 22kHz, 16Bit, Stereo | 23    |
| 24kHz, 8Bit, Mono    | 24    |
| 24kHz, 8Bit, Stereo  | 25    |
| 24kHz, 16Bit, Mono   | 26    |
| 24kHz, 16Bit, Stereo | 27    |
| 32kHz, 8Bit, Mono    | 28    |
| 32kHz, 8Bit, Stereo  | 29    |
| 32kHz, 8Bit, Stereo  | 30    |
| 32kHz, 16Bit, Stereo | 31    |
| 44kHz, 8Bit, Mono    | 32    |
| 44kHz, 8Bit, Stereo  | 33    |
| 44kHz, 16Bit, Mono   | 34    |
| 44kHz, 16Bit, Stereo | 35    |
| 48kHz, 8Bit, Mono    | 36    |
| 48kHz, 8Bit, Stereo  | 37    |
| 48kHz, 16Bit, Mono   | 38    |
| 48kHz, 16Bit, Stereo | 39    |

**Example**

```php
TTS_GenerateFile(44007, "Hello World", "C:/HelloWorld.WAV", 19);
```

## TTS_Speak

Source: https://www.symcon.de/en/service/documentation/module-reference/notifications/text-to-speech/tts-speak/

`bool TTS_Speak(int $InstanceID, string $Text, bool $Waiting)`

speaks any text on the selected sound card

**Parameters**

- `$InstanceID` (int): ID of the device to be switched
- `$Text` (string): Text to be said
- `$Waiting` (bool): __TRUE__ for On, __FALSE__ for Off

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

__TRUE__ for On, __FALSE__ for Off

**Example**

```php
TTS_Speak(12345, "Hallo Welt!", true); //Wait until it was spoken to the end
```