2024.11.2
Home ▸ Integrations ▸

VoiceRSS

The VoiceRSS text-to-speech integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] 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.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# 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’

Related topics