home-assistant.io/source/_components/tts.microsoft.markdown

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release
page	Microsoft Text-to-Speech	Instructions how to setup Microsoft Text-to-Speech with Home Assistant.	2017-10-23 11:00	true	false	true	true	microsoft.png	Text-to-speech	0.57

The microsoft text-to-speech platform uses Microsoft Text-to-Speech engine to read a text with natural sounding voices. This component uses an API that is part of the Cognitive Services offering and is known as the Bing Speech API. You will need an API key, which is free. You can use your Azure subscription or get an API key on the Cognitive Services site.

To enable text-to-speech with Microsoft, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
tts:
  - platform: microsoft
    api_key: [YourAPIKey]

Configuration variables:

• 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.
• 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 in the service name mapping in the documentation. Defaults to ZiraRUS

A full configuration sample including optional configuration variables:

# Example configuration.yaml entry
tts:
  - platform: microsoft
    api_key: XXXXXXXXX
    language: en-us
    gender: male
    type: BenjaminRUS