home-assistant.io/source/_components/tts.voicerss.markdown
Stuart McCroden 72631830da Standardize example configuration blocks (#6953)
* Standardized values in the example configuration

Removed what appear to be an actual API key from the example configuration.yaml block. And, replaced with values as described in the [developer docs](https://developers.home-assistant.io/docs/en/documentation_standards.html#component-and-platform-pages)

* Standardize example configuration-ecobee

* Standardize example configuration-coinbase

* Standardize example configuration-google assistant

* Standardize example configuration-cloudflare

* Standardize example configuration-cloudflare

* Standardize example configuration-habitica

* Standardize example configuration-ifttt

* Standardize example configuration-openalpr

* Standardize example configuration-multiple

* Standardize example configuration-instapush

* Standardize example configuration-llamalab

* Standardize example configuration-notify

* Standardize example configuration-mailgun

* Standardize example configuration-MULTIPLE

* Standardize example configuration-rtm

* Standardize example configuration-spotcrime

* Standardize example configuration-trafikverket

* Standardize example configuration-uk transport

* Standardize example configuration-wunderground

* Standardize example configuration-wsdot

* Standardize example configuration-telegram

* Standardize example configuration-tts

* Standardize example configuration-tts, vultr

* Replace email entry

* Replace IP address

* Place email address
2018-10-19 22:52:25 +02:00

1.5 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release
layout title description date sidebar comments sharing footer logo ha_category ha_release
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

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 default: "en-us" type: string codec: description: The audio codec. required: false default: mp3 type: string format: description: The audio sample format. required: false default: 8khz_8bit_mono type: string {% endconfiguration %}

Check the VoiceRSS API documentation for allow values.

{% linkable_title Full configuration example %}

The configuration sample below show how a 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'