2024-11-27 18:57:16 +01:00

2.7 KiB

title description ha_category ha_release ha_iot_class ha_domain ha_platforms ha_integration_type related ha_quality_scale
Yandex TTS Instructions on how to setup Yandex SpeechKit TTS with Home Assistant.
Text-to-speech
0.36 Cloud Push yandextts
tts
integration
docs title
/docs/configuration/ Configuration file
legacy

The yandextts text-to-speech {% term integration %} uses Yandex SpeechKit text-to-speech engine to read a text with natural sounding voices.

{% important %} This integration is working only with old API keys. For the new API keys, this integration cannot be used. {% endimportant %}

Configuration

To enable text-to-speech with Yandex SpeechKit, add the following lines to your {% term "configuration.yaml" %} file. {% include integrations/restart_ha_after_config_inclusion.md %}

# 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