jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Microsoft tts component configuration (#6931)

Browse Source 
* Update Microsoft tts component configuration

* 🚑 Remove default with none
This commit is contained in:
Klaas Schoute 2018-10-18 20:23:33 +02:00 committed by Franck Nijhof
parent cbb930e0c7
commit 9c746c1b9d
1 changed files with 41 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
source/_components/tts.microsoft.markdown
View File

@ -24,18 +24,48 @@ tts:
api_key: [YourAPIKey]
```
Configuration variables:
{% configuration %}
api_key:
description: Your API key.
required: true
type: string
language:
description: The language to use. Accepted values are listed in the documentation mentioned below. Note that if you set the language to anything other than the default, you will need to specify a matching voice type as well.
required: false
default: "`en-us`"
type: string
gender:
description: The gender you would like to use for the voice. Accepted values are `Female` and `Male`.
required: false
default: "`Female`"
type: string
type:
description: "The voice type you want to use. Accepted values are listed as the service name mapping [in the documentation](https://docs.microsoft.com/en-us/azure/cognitive-services/Speech/api-reference-rest/bingvoiceoutput)."
required: false
default: "`ZiraRUS`"
type: string
rate:
description: "Change the rate of speaking in percentage. Example values: `25`, `50`."
required: false
default: 0
type: integer
volume:
description: "Change the volume of the output in percentage. Example values: `-20`, `70`."
required: false
default: 0
type: integer
pitch:
description: "Change the pitch of the output. Example values: `high`."
required: false
default: "`default`"
type: string
contour:
description: "Change the contour of the output in percentages. This overrides the pitch setting. See the [W3 SSML specification](http://www.w3.org/TR/speech-synthesis/#pitch_contour) for what it does. Example value: `(0,0) (100,100)`."
required: false
type: string
{% endconfiguration %}
- **api_key** (*Required*): Your API key.
- **language** (*Optional*): The language to use. Defaults to `en-us`. Accepted values are listed in the documentation mentioned below. Note that if you set the language to anything other than the default of `en-us`, you will need to specify a matching voice type as well.
- **gender** (*Optional*): The gender you would like to use for the voice. Accepted values are `Female` and `Male`. Defaults to `Female`.
- **type** (*Optional*): The voice type you want to use. Accepted values are listed as the service name mapping [in the documentation](https://docs.microsoft.com/en-us/azure/cognitive-services/Speech/api-reference-rest/bingvoiceoutput). Defaults to `ZiraRUS`.
- **rate** (*Optional*): Change the rate of speaking in percentage. Example values: `25`, `50`. Defaults to `0` (no change).
- **volume** (*Optional*): Change the volume of the output in percentage. Example values: `-20`, `70`. Defaults to `0` (no change).
- **pitch** (*Optional*): Change the pitch of the output. Example values: `high`. Defaults to `default` (no change).
- **contour** (*Optional*): Change the contour of the output in percentages. This overrides the pitch setting. See the [W3 SSML specification](http://www.w3.org/TR/speech-synthesis/#pitch_contour) for what it does. Example value: `(0,0) (100,100)`.
A full configuration sample including optional configuration variables:
A full configuration sample including optional variables:
```yaml
# Example configuration.yaml entry