3.9 KiB
title, description, ha_category, ha_iot_class, ha_release, ha_domain, ha_platforms, ha_integration_type
| title | description | ha_category | ha_iot_class | ha_release | ha_domain | ha_platforms | ha_integration_type | ||
|---|---|---|---|---|---|---|---|---|---|
| Microsoft Text-to-Speech (TTS) | Instructions on how to set up Microsoft text-to-speech with Home Assistant. |
|
Cloud Push | 0.57 | microsoft |
|
integration |
The microsoft text-to-speech platform uses the TTS engine of the Microsoft Speech Service to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Microsoft Speech API. For this integration to work, you need a free API key. You can use your Azure subscription to create an Azure Speech resource.
Configuration
To enable text-to-speech with Microsoft, add the following lines to your configuration.yaml:
# Example configuration.yaml entry
tts:
- platform: microsoft
api_key: YOUR_API_KEY
{% configuration %}
api_key:
description: Your API key.
required: true
type: string
language:
description: The language to use. Note that if you set the language to anything other than the default, you will need to specify a matching voice type as well. For the supported languages check the list of available languages.
required: false
type: string
default: "en-us"
gender:
description: The gender you would like to use for the voice. Accepted values are Female and Male.
required: false
type: string
default: "Female"
type:
description: "The voice type you want to use. Accepted values are listed as the service name mapping in the documentation."
required: false
type: string
default: "JennyNeural"
rate:
description: "Change the rate of speaking in percentage. Example values: 25, 50."
required: false
type: integer
default: 0
volume:
description: "Change the volume of the output in percentage. Example values: -20, 70."
required: false
type: integer
default: 0
pitch:
description: "Change the pitch of the output. Example values: high."
required: false
type: string
default: "default"
contour:
description: "Change the contour of the output in percentages. This overrides the pitch setting. See the W3 SSML specification for what it does. Example value: (0,0) (100,100)."
required: false
type: string
region:
description: "The region of your API endpoint. See documentation."
required: false
type: string
default: "eastus"
{% endconfiguration %}
Not all Azure regions support high-quality neural voices. Use this overview to determine the availability of standard and neural voices by region/endpoint.
New users (any newly created Azure Speech resource after August 31st, 2021) can only use neural voices. Existing resources can continue using standard voices through August 31st, 2024.
If you set the language to anything other than the default en-us, you will need to specify a matching voice type as well.
Full configuration example
A full configuration sample including optional variables:
# Example configuration.yaml entry
tts:
- platform: microsoft
api_key: YOUR_API_KEY
language: en-gb
gender: Male
type: RyanNeural
rate: 20
volume: -50
pitch: high
contour: (0, 0) (100, 100)
region: eastus