home-assistant.io/source/_components/voicerss.markdown

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, redirect_from

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release	redirect_from
page	VoiceRSS	Instructions on how to setup VoiceRSS TTS with Home Assistant.	2016-12-13 07:00	true	false	true	true	voicerss.png	Text-to-speech	0.35	/components/tts.voicerss/

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

{% linkable_title 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 %} api_key: description: The API Key for VoiceRSS. required: true type: string language: description: The language to use. required: false type: string default: "en-us" codec: description: The audio codec. required: false type: string default: mp3 format: description: The audio sample format. required: false type: string default: 8khz_8bit_mono {% endconfiguration %}

Check the VoiceRSS API documentation for allowed values.

{% linkable_title 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'