Skip to content

Commit 7f9d2bf

Browse files
jeroenterheerdtfabaff
authored andcommitted
Update tts.microsoft.markdown (home-assistant#3923)
1 parent a86926a commit 7f9d2bf

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

source/_components/tts.microsoft.markdown

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: page
33
title: "Microsoft Text-to-Speech"
44
description: "Instructions how to setup Microsoft Text-to-Speech with Home Assistant."
5-
date: 2017-10-23 11:00
5+
date: 2017-11-07 12:00
66
sidebar: true
77
comments: false
88
sharing: true
@@ -27,10 +27,13 @@ tts:
2727
Configuration variables:
2828
2929
- **api_key** (*Required*): Your API key.
30-
- **language** (*Optional*): The language to use. Defaults to `en-us`. Accepted values are listed in the documentation mentioned below.
30+
- **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.
3131
- **gender** (*Optional*): The gender you would like to use for the voice. Accepted values are `Female` and `Male`. Defaults to `Female`
3232
- **type** (*Optional*): The voice type you want to use. Accepted values are listed in the service name mapping [in the documentation](https://docs.microsoft.com/en-us/azure/cognitive-services/Speech/api-reference-rest/bingvoiceoutput). Defaults to `ZiraRUS`
33-
33+
- **rate** (*Optional*): Change the rate of speaking. Example values: `-25%`, `+50%`. Defaults to `+0%` (no change)
34+
- **volume** (*Optional*): Change the volume of the output. Example values: `-20%`, `+70%`. Defaults to `+0%` (no change)
35+
- **pitch** (*Optional*): Change the pitch of the output. Example values: `high`. Defaults to `default` (no change)
36+
- **contour** (*Optional*): Change the contour of the output. 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%)`
3437

3538
A full configuration sample including optional configuration variables:
3639

@@ -39,7 +42,11 @@ A full configuration sample including optional configuration variables:
3942
tts:
4043
- platform: microsoft
4144
api_key: XXXXXXXXX
42-
language: en-us
43-
gender: male
44-
type: BenjaminRUS
45+
language: en-gb
46+
gender: Male
47+
type: George, Apollo
48+
rate: +20%
49+
volume: -50%
50+
pitch: high
51+
contour: (0%, +0%) (100%, +100%)
4552
```

0 commit comments

Comments
 (0)