home-assistant.io/source/_components/yandextts.markdown
Franck Nijhof 1833c32a2c Cleans up front matter (#9835)
* Sets front matter defaults

* Removes default front matter from section templates/pages

* Removes default front matter from addon pages

* Removes default front matter from integration pages

* Removes default front matter from posts

* Removes default front matter from docs pages

* Removes default front matter from other pages

* Fixes blog category pages
2019-07-11 14:35:08 -07:00

2.4 KiB

title, description, logo, ha_category, ha_release, redirect_from
title description logo ha_category ha_release redirect_from
Yandex TTS Instructions on how to setup Yandex SpeechKit TTS with Home Assistant. yandex.png
Text-to-speech
0.36
/components/tts.yandextts/

The yandextts text-to-speech platform uses Yandex SpeechKit Text-to-Speech engine to read a text with natural sounding voices.

Configuration

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

# Example configuration.yaml entry
tts:
  - platform: yandextts
    api_key: THE_API_KEY

{% configuration %} api_key: description: The API Key for use this service. required: true type: string language: description: "The language to use. Supported languages are en-US, ru-RU, uk-UK and tr-TR." required: false type: string default: "en-US" codec: description: "The audio codec. Supported codecs are mp3, wav and opus." required: false type: string default: "mp3" voice: description: "The speaker voice. Supported female voices are jane, oksana, alyss, omazh, silaerkan, nastya, sasha, tanya, tatyana_abramova, voicesearch, and zombie. Male voices are zahar, ermil, levitan, ermilov, kolya, kostya, nick, erkanyavas, zhenya, anton_samokhvalov, ermil_with_tuning, robot, dude, and smoky." required: false type: string default: "zahar" emotion: description: "The speaker emotional intonation. Supported emotions are good (friendly), evil (angry) and neutral" required: false type: string default: "neutral" speed: description: The speech speed. Highest speed is 3 and lowest 0,1 required: false type: float default: "1" {% endconfiguration %}

Please check the API documentation for details. It seems that the English version of documentation is outdated. You could request an API key by email or online.

Full configuration example

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

# Example configuration.yaml entry
tts:
  - platform: yandextts
    api_key: YOUR_API_KEY
    language: 'ru-RU'
    codec: mp3
    voice: oksana
    emotion: evil
    speed: 2