2025-01-15 19:42:35 +01:00

40 lines
9.0 KiB
HTML

<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../jquery-1.9.1.min.js"></script><script src="../../bootstrap/js/bootstrap.min.js"></script><script src="../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../styles.css" rel="stylesheet"/><link href="../../haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "../../",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="../../nav.js"></script><script type="text/javascript" src="../../index.js"></script><link rel="icon" href="../../favicon.ico" type="image/x-icon"></link><title>js.html.SpeechSynthesis - API Reference</title><meta name="description" content="The &lt;code&gt;&lt;a href="../../js/html/SpeechSynthesis.html"&gt;SpeechSynthesis&lt;/a&gt;&lt;/code&gt; interface of the Web Speech API is the controller interface for the speech service; this can be used to retrieve information about the synthesis voices available on the device, start and pause speech, and other commands besides."/></head><body><style>
a, code .type {
color: #24afc4;
}
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
background: #24afc4;
color: #ffffff;
text-shadow: 0 0 0 transparent;
}
.navbar .container {
width: 940px ;
}
@media (max-width: 767px) {
.navbar .container {
width: auto;
}
}
@media (max-width: 979px) and (min-width: 768px) {
.navbar .container {
width: 724px;
}
}
@media (min-width: 1200px) {
.navbar .container {
width: 1170px;
}
}
.navbar .container img {
margin: 5px 0 0 4px;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="../../">API Reference</a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> SpeechSynthesis</h1><h4><small>package <a href="../../js/html/index.html">js.html</a></small></h4> <p class="availability"><hr/><em>Available on HTML5</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p>The <code><a href="../../js/html/SpeechSynthesis.html">SpeechSynthesis</a></code> interface of the Web Speech API is the controller interface for the speech service; this can be used to retrieve information about the synthesis voices available on the device, start and pause speech, and other commands besides.</p>
<p>Documentation <a href="https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis">SpeechSynthesis</a> by <a href="https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis$history">Mozilla Contributors</a>, licensed under <a href="https://creativecommons.org/licenses/by-sa/2.5/">CC-BY-SA 2.5</a>.</p><p class="javadoc">See:</p><div class="indent inline-content"><p><a href="https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis">https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis</a></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="paused"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/SpeechSynthesis.html#paused"><span class="identifier">paused</span></a>:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p>A <code>Boolean</code> that returns <code>true</code> if the <code><a href="../../js/html/SpeechSynthesis.html">SpeechSynthesis</a></code> object is in a paused state.</p></div></div><div class="field "><a name="pending"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/SpeechSynthesis.html#pending"><span class="identifier">pending</span></a>:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p>A <code>Boolean</code> that returns <code>true</code> if the utterance queue contains as-yet-unspoken utterances.</p></div></div><div class="field "><a name="speaking"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/SpeechSynthesis.html#speaking"><span class="identifier">speaking</span></a>:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p>A <code>Boolean</code> that returns <code>true</code> if an utterance is currently in the process of being spoken — even if <code><a href="../../js/html/SpeechSynthesis.html">SpeechSynthesis</a></code> is in a paused state.</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="cancel"></a><h3><p><code><a href="#cancel"><span class="identifier">cancel</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p>Removes all utterances from the utterance queue.</p></div></div><div class="field "><a name="getVoices"></a><h3><p><code><a href="#getVoices"><span class="identifier">getVoices</span></a> ():<a class="type" title="An Array is a storage for values." href="../../Array.html">Array</a>&lt;<a class="type" title="The SpeechSynthesisVoice interface of the Web Speech API represents a voice that the system supports." href="../../js/html/SpeechSynthesisVoice.html">SpeechSynthesisVoice</a>&gt;</code></p></h3><div class="doc"><p>Returns a list of <code><a href="../../js/html/SpeechSynthesisVoice.html">SpeechSynthesisVoice</a></code> objects representing all the available voices on the current device.</p></div></div><div class="field "><a name="pause"></a><h3><p><code><a href="#pause"><span class="identifier">pause</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p>Puts the <code><a href="../../js/html/SpeechSynthesis.html">SpeechSynthesis</a></code> object into a paused state.</p></div></div><div class="field "><a name="resume"></a><h3><p><code><a href="#resume"><span class="identifier">resume</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p>Puts the <code><a href="../../js/html/SpeechSynthesis.html">SpeechSynthesis</a></code> object into a non-paused state: resumes it if it was already paused.</p></div></div><div class="field "><a name="speak"></a><h3><p><code><a href="#speak"><span class="identifier">speak</span></a> (<span style="white-space:nowrap">utterance:<a class="type" title="The SpeechSynthesisUtterance interface of the Web Speech API represents a speech request." href="../../js/html/SpeechSynthesisUtterance.html">SpeechSynthesisUtterance</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p>Adds an <code><a href="../../js/html/SpeechSynthesisUtterance.html">SpeechSynthesisUtterance</a></code> to the utterance queue; it will be spoken when any other utterances queued before it have been spoken.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">&copy; 2017 &nbsp;<a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>