From 33317ebc2806b1177e8a9407f17beb6bf1bbd599 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 16 Oct 2018 08:54:36 +0200 Subject: [PATCH] Update Yandextts component configuration variable (#6832) * Update Yandextts component configuration variable * Minor changes --- source/_components/tts.yandextts.markdown | 47 ++++++++++++++++++----- 1 file changed, 37 insertions(+), 10 deletions(-) diff --git a/source/_components/tts.yandextts.markdown b/source/_components/tts.yandextts.markdown index af30eacea74..3bf29219ea6 100644 --- a/source/_components/tts.yandextts.markdown +++ b/source/_components/tts.yandextts.markdown @@ -14,27 +14,54 @@ ha_release: 0.36 The `yandextts` text-to-speech platform uses [Yandex SpeechKit](https://tech.yandex.com/speechkit/) Text-to-Speech engine to read a text with natural sounding voices. +## {% linkable_title Configuration %} + To enable text-to-speech with Yandex SpeechKit, add the following lines to your `configuration.yaml`: ```yaml # Example configuration.yaml entry tts: - platform: yandextts - api_key: 'XXXXXXXX' + api_key: THE_API_KEY ``` -Configuration variables: - -- **api_key** (*Required*): API Key for use this service. -- **language** (*Optional*): The language to use. Defaults to `en-US`. Supported `en-US`, `ru-RU`, `uk-UK`, `tr-TR`. -- **codec** (*Optional*): Audio codec. Default is `mp3`. Supported us `mp3`, `wav`, `opus`. -- **voice** (*Optional*): Speaker voice. Default is `zahar`. Supported female voices are `jane`, `oksana`, `alyss`, `omazh` and male voices are `zahar` and `ermil`. -- **emotion** (*Optional*): Speaker emotional intonation. Default is `neutral`. Also supported are `good` (friendly) and `evil` (angry) -- **speed** (*Optional*): Speech speed. Default value is `1`. Highest speed is `3` and lowest `0,1` +{% configuration %} +api_key: + description: The API Key for use this service. + required: true + type: string +language: + description: "The language to use. Supported `en-US`, `ru-RU`, `uk-UK`, `tr-TR`." + required: false + default: "`en-US`" + type: string +codec: + description: "The audio codec. Supported us `mp3`, `wav`, `opus`." + required: false + default: "`mp3`" + type: string +voice: + description: "The speaker voice. Supported female voices are `jane`, `oksana`, `alyss`, `omazh` and male voices are `zahar` and `ermil`." + required: false + default: "`zahar`" + type: string +emotion: + description: "The speaker emotional intonation. Also supported are `good` (friendly) and `evil` (angry)" + required: false + default: "`neutral`" + type: string +speed: + description: The speech speed. Highest speed is `3` and lowest `0,1` + required: false + default: "`1`" + type: float +{% endconfiguration %} Please check the [API documentation](https://tech.yandex.com/speechkit/cloud/doc/guide/concepts/tts-http-request-docpage/) for details. It seems that the English version of documentation is outdated. You could request an API key [by email](https://tech.yandex.com/speechkit/cloud/) or [online](https://developer.tech.yandex.ru/). -A full configuration sample: +## {% linkable_title Full configuration example %} + +The configuration sample below show how a entry can look like: ```yaml # Example configuration.yaml entry