Home Assistant

VoiceRSS

The voicerss text-to-speech platform uses VoiceRSS text-to-speech engine to read a text with natural sounding voices.

Configuration

To enable text-to-speech with VoiceRSS, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
tts:
  - platform: voicerss
    api_key: YOUR_API_KEY

Configuration Variables

Looking for your configuration file?
api_key string Required

The API Key for VoiceRSS.

language string (Optional, default: en-us)

The language to use.

codec string (Optional, default: mp3)

The audio codec.

format string (Optional, default: 8khz_8bit_mono)

The audio sample format.

Check the VoiceRSS API documentation for allowed values.

Full configuration example

The configuration sample below shows how an entry can look like:

# Example configuration.yaml entry
tts:
  - platform: voicerss
    api_key: YOUR_API_KEY
    language: "de-de"
    codec: mp3
    format: "8khz_8bit_mono"

Please note, some media_players require a certain format. For example the Sonos requires a format of ‘44khz_16bit_stereo’