home-assistant.io/source/_components/tts.voicerss.markdown
Alok Saboo 1aca7b08cf Misc fixes: e.g. -> e.g., and proper case for Home Assistant (#4942)
* e.g. to e.g., and proper case for Home Assistant

* Instructions how to -> Instructions on how to
2018-03-17 20:20:37 +01:00

1.3 KiB

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.

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

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

Configuration variables:

  • api_key (Required): API Key for use this service.
  • language (Optional): The language to use. Defaults to en-us.
  • codec (Optional): Audio codec. Default is 'mp3'.
  • format (Optional): Audio sample format. Default is '8khz_8bit_mono'

See on api documentation for allow values.

A full configuration sample:

# Example configuration.yaml entry
tts:
  - platform: voicerss
    api_key: 'XXXXX'
    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'