212 lines
12 KiB
HTML
212 lines
12 KiB
HTML
<!doctype html>
|
|
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
|
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
|
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Microsoft Text-to-Speech - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions how to setup Microsoft Text-to-Speech with Home Assistant.">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/tts.microsoft/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Microsoft Text-to-Speech">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/tts.microsoft/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to setup Microsoft Text-to-Speech with Home Assistant.">
|
|
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:site" content="@home_assistant">
|
|
<meta name="twitter:title" content="Microsoft Text-to-Speech">
|
|
<meta name="twitter:description" content="Instructions how to setup Microsoft Text-to-Speech with Home Assistant.">
|
|
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
|
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
|
|
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
|
<link rel='shortcut icon' href='/images/favicon.ico' />
|
|
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
|
</head>
|
|
<body >
|
|
<header class='site-header'>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
|
<a href="/" class="site-title">
|
|
<img width='40' src='/demo/favicon-192x192.png'>
|
|
<span>Home Assistant</span>
|
|
</a>
|
|
</div>
|
|
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
|
<nav>
|
|
<input type="checkbox" id="toggle">
|
|
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
|
<ul class="menu pull-right">
|
|
<li><a href="/getting-started/">Getting started</a></li>
|
|
<li><a href="/components/">Components</a></li>
|
|
<li><a href="/docs/">Docs</a></li>
|
|
<li><a href="/cookbook/">Examples</a></li>
|
|
<li><a href="/developers/">Developers</a></li>
|
|
<li><a href="/blog/">Blog</a></li>
|
|
<li><a href="/help/">Need help?</a></li>
|
|
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
|
</ul>
|
|
</nav>
|
|
<div class='search-container' style='display: none'>
|
|
<div class='search'>
|
|
<i class="icon-search"></i>
|
|
<input id='search' placeholder='Search the docs…'>
|
|
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="grid-wrapper">
|
|
<div class="grid grid-center">
|
|
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
|
<article class="page">
|
|
<header>
|
|
<h1 class="title indent">
|
|
Microsoft Text-to-Speech
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>The <code class="highlighter-rouge">microsoft</code> text-to-speech platform uses <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/speech/home">Microsoft Text-to-Speech engine</a> 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 <a href="https://azure.microsoft.com">Azure subscription</a> or get an API key on the <a href="https://azure.microsoft.com/en-us/try/cognitive-services/">Cognitive Services site</a>.</p>
|
|
<p>To enable text-to-speech with Microsoft, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
|
<span class="s">tts</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">microsoft</span>
|
|
<span class="s">api_key</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">YourAPIKey</span><span class="pi">]</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>Configuration variables:</p>
|
|
<ul>
|
|
<li><strong>api_key</strong> (<em>Required</em>): Your API key.</li>
|
|
<li><strong>language</strong> (<em>Optional</em>): The language to use. Defaults to <code class="highlighter-rouge">en-us</code>. Accepted values are listed in the documentation mentioned below. Note that if you set the language to anything other than the default of <code class="highlighter-rouge">en-us</code>, you will need to specify a matching voice type as well.</li>
|
|
<li><strong>gender</strong> (<em>Optional</em>): The gender you would like to use for the voice. Accepted values are <code class="highlighter-rouge">Female</code> and <code class="highlighter-rouge">Male</code>. Defaults to <code class="highlighter-rouge">Female</code>.</li>
|
|
<li><strong>type</strong> (<em>Optional</em>): The voice type you want to use. Accepted values are listed as the service name mapping <a href="https://docs.microsoft.com/en-us/azure/cognitive-services/Speech/api-reference-rest/bingvoiceoutput">in the documentation</a>. Defaults to <code class="highlighter-rouge">ZiraRUS</code>.</li>
|
|
<li><strong>rate</strong> (<em>Optional</em>): Change the rate of speaking in percentage. Example values: <code class="highlighter-rouge">25</code>, <code class="highlighter-rouge">50</code>. Defaults to <code class="highlighter-rouge">0</code> (no change).</li>
|
|
<li><strong>volume</strong> (<em>Optional</em>): Change the volume of the output in percentage. Example values: <code class="highlighter-rouge">-20</code>, <code class="highlighter-rouge">70</code>. Defaults to <code class="highlighter-rouge">0</code> (no change).</li>
|
|
<li><strong>pitch</strong> (<em>Optional</em>): Change the pitch of the output. Example values: <code class="highlighter-rouge">high</code>. Defaults to <code class="highlighter-rouge">default</code> (no change).</li>
|
|
<li><strong>contour</strong> (<em>Optional</em>): Change the contour of the output in percentages. This overrides the pitch setting. See the <a href="http://www.w3.org/TR/speech-synthesis/#pitch_contour">W3 SSML specification</a> for what it does. Example value: <code class="highlighter-rouge">(0,0) (100,100)</code>.</li>
|
|
</ul>
|
|
<p>A full configuration sample including optional configuration variables:</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
|
<span class="s">tts</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">microsoft</span>
|
|
<span class="s">api_key</span><span class="pi">:</span> <span class="s">XXXXXXXXX</span>
|
|
<span class="s">language</span><span class="pi">:</span> <span class="s">en-gb</span>
|
|
<span class="s">gender</span><span class="pi">:</span> <span class="s">Male</span>
|
|
<span class="s">type</span><span class="pi">:</span> <span class="s">George, Apollo</span>
|
|
<span class="s">rate</span><span class="pi">:</span> <span class="s">20</span>
|
|
<span class="s">volume</span><span class="pi">:</span> <span class="s">-50</span>
|
|
<span class="s">pitch</span><span class="pi">:</span> <span class="s">high</span>
|
|
<span class="s">contour</span><span class="pi">:</span> <span class="s">(0, 0) (100, 100)</span>
|
|
</code></pre>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
|
<div class="grid">
|
|
<section class="aside-module grid__item one-whole lap-one-half">
|
|
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/tts.microsoft.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
<img src='/images/supported_brands/microsoft.png' />
|
|
</div>
|
|
<div class='section'>
|
|
Introduced in release: 0.57
|
|
</div>
|
|
<div class='section'>
|
|
Source:
|
|
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/tts/microsoft.py'>tts/microsoft.py</a>
|
|
</div>
|
|
<div class='section'>
|
|
This is a platform for
|
|
<a href='/components/tts/'>the Text-to-Speech (TTS) component</a>.
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Text-to-speech</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/tts.amazon_polly/'>Amazon Polly</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/tts.baidu/'>Baidu Text-to-Speech</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/tts.google/'>Google Text-to-Speech</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/tts.marytts/'>MaryTTS</a>
|
|
</li>
|
|
<li>
|
|
Microsoft Text-to-Speech
|
|
</li>
|
|
<li>
|
|
<a href='/components/tts.picotts/'>Pico Text-to-Speech</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/tts.voicerss/'>VoiceRSS</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/tts.yandextts/'>Yandex TTS</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</aside>
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
<div class="grid__item">
|
|
<div class="copyright">
|
|
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
|
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
|
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
|
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
|
<div class="credit">
|
|
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
|
|
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
|
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
|
</div>
|
|
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<script>
|
|
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
|
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
|
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
|
s.parentNode.insertBefore(g,s)}(document,'script'));
|
|
</script>
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
|
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
|
<script type="text/javascript">
|
|
docsearch({
|
|
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
|
indexName: 'home-assistant',
|
|
inputSelector: '#search',
|
|
debug: false // Set debug to true if you want to inspect the dropdown
|
|
});
|
|
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
|
ev.preventDefault();
|
|
document.querySelector('.search-container').style.display = 'none';
|
|
});
|
|
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
|
ev.preventDefault();
|
|
document.querySelector('.search-container').style.display = 'block';
|
|
document.getElementById('toggle').checked = false;
|
|
document.querySelector('.search-container input').focus();
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|