40 lines
20 KiB
HTML
40 lines
20 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.SpeechRecognition - API Reference</title><meta name="description" content="The <code><a href="../../js/html/SpeechRecognition.html">SpeechRecognition</a></code> interface of the Web Speech API is the controller interface for the recognition service; this also handles the <code><a href="../../js/html/SpeechRecognitionEvent.html">SpeechRecognitionEvent</a></code> sent from the recognition service."/></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> SpeechRecognition</h1><h4><small>package <a href="../../js/html/index.html">js.html</a></small></h4><h4><small>extends <a class="type" title="EventTarget is an interface implemented by objects that can receive events and may have listeners for them." href="../../js/html/EventTarget.html">EventTarget</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/SpeechRecognition.html">SpeechRecognition</a></code> interface of the Web Speech API is the controller interface for the recognition service; this also handles the <code><a href="../../js/html/SpeechRecognitionEvent.html">SpeechRecognitionEvent</a></code> sent from the recognition service.</p>
|
|
<p>Documentation <a href="https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition">SpeechRecognition</a> by <a href="https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition$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/SpeechRecognition">https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition</a></p></div></div></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3><p><code><a href="#new"><span class="identifier">new</span></a> ()</code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="continuous"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#continuous"><span class="identifier">continuous</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>Controls whether continuous results are returned for each recognition, or only a single result. Defaults to single (<code>false</code>.)</p></div></div><div class="field "><a name="grammars"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#grammars"><span class="identifier">grammars</span></a>:<a class="type" title="The SpeechGrammarList interface of the Web Speech API represents a list of SpeechGrammar objects containing words or patterns of words that we want the recognition service to recognize." href="../../js/html/SpeechGrammarList.html">SpeechGrammarList</a></code></p></h3><div class="doc"><p>Returns and sets a collection of <code><a href="../../js/html/SpeechGrammar.html">SpeechGrammar</a></code> objects that represent the grammars that will be understood by the current <code><a href="../../js/html/SpeechRecognition.html">SpeechRecognition</a></code>.</p></div></div><div class="field "><a name="interimResults"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#interimResults"><span class="identifier">interimResults</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>Controls whether interim results should be returned (<code>true</code>) or not (<code>false</code>.) Interim results are results that are not yet final (e.g. the <code><a href="../../js/html/SpeechRecognitionResult.html#isFinal">SpeechRecognitionResult.isFinal</a></code> property is <code>false</code>.)</p></div></div><div class="field "><a name="lang"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#lang"><span class="identifier">lang</span></a>:<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><div class="doc"><p>Returns and sets the language of the current <code><a href="../../js/html/SpeechRecognition.html">SpeechRecognition</a></code>. If not specified, this defaults to the HTML <code>lang</code> attribute value, or the user agent's language setting if that isn't set either.</p></div></div><div class="field "><a name="maxAlternatives"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#maxAlternatives"><span class="identifier">maxAlternatives</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></code></p></h3><div class="doc"><p>Sets the maximum number of <code><a href="../../js/html/SpeechRecognitionAlternative.html">SpeechRecognitionAlternative</a></code>s provided per result. The default value is 1.</p></div></div><div class="field "><a name="onaudioend"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#onaudioend"><span class="identifier">onaudioend</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Fired when the user agent has finished capturing audio.</p></div></div><div class="field "><a name="onaudiostart"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#onaudiostart"><span class="identifier">onaudiostart</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Fired when the user agent has started to capture audio.</p></div></div><div class="field "><a name="onend"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#onend"><span class="identifier">onend</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Fired when the speech recognition service has disconnected.</p></div></div><div class="field "><a name="onerror"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#onerror"><span class="identifier">onerror</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Fired when a speech recognition error occurs.</p></div></div><div class="field "><a name="onnomatch"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#onnomatch"><span class="identifier">onnomatch</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Fired when the speech recognition service returns a final result with no significant recognition. This may involve some degree of recognition, which doesn't meet or exceed the <code><a href="../../js/html/SpeechRecognitionAlternative.html#confidence">SpeechRecognitionAlternative.confidence</a></code> threshold.</p></div></div><div class="field "><a name="onresult"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#onresult"><span class="identifier">onresult</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Fired when the speech recognition service returns a result — a word or phrase has been positively recognized and this has been communicated back to the app.</p></div></div><div class="field "><a name="onsoundend"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#onsoundend"><span class="identifier">onsoundend</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Fired when any sound — recognisable speech or not — has stopped being detected.</p></div></div><div class="field "><a name="onsoundstart"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#onsoundstart"><span class="identifier">onsoundstart</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Fired when any sound — recognisable speech or not — has been detected.</p></div></div><div class="field "><a name="onspeechend"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#onspeechend"><span class="identifier">onspeechend</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Fired when speech recognised by the speech recognition service has stopped being detected.</p></div></div><div class="field "><a name="onspeechstart"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#onspeechstart"><span class="identifier">onspeechstart</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Fired when sound that is recognised by the speech recognition service as speech has been detected.</p></div></div><div class="field "><a name="onstart"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#onstart"><span class="identifier">onstart</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Fired when the speech recognition service has begun listening to incoming audio with intent to recognize grammars associated with the current <code><a href="../../js/html/SpeechRecognition.html">SpeechRecognition</a></code>.</p></div></div><div class="field "><a name="serviceURI"></a><h3><p><code><a href="../../js/html/SpeechRecognition.html#serviceURI"><span class="identifier">serviceURI</span></a>:<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><div class="doc"><p>Specifies the location of the speech recognition service used by the current <code><a href="../../js/html/SpeechRecognition.html">SpeechRecognition</a></code> to handle the actual recognition. The default is the user agent's default speech service.</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="abort"></a><h3><p><code><a href="#abort"><span class="identifier">abort</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p>Stops the speech recognition service from listening to incoming audio, and doesn't attempt to return a <code><a href="../../js/html/SpeechRecognitionResult.html">SpeechRecognitionResult</a></code>.</p></div></div><div class="field "><a name="start"></a><h3><p><code><a href="#start"><span class="identifier">start</span></a> (<span style="white-space:nowrap">?stream:<a class="type" title="The MediaStream interface represents a stream of media content." href="../../js/html/MediaStream.html">MediaStream</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="stop"></a><h3><p><code><a href="#stop"><span class="identifier">stop</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p>Stops the speech recognition service from listening to incoming audio, and attempts to return a <code><a href="../../js/html/SpeechRecognitionResult.html">SpeechRecognitionResult</a></code> using the audio captured so far.</p></div></div></div> <div class="inherited-fields well"><h3 class="section">Inherited Variables</h3><div class="fields"><div style="display:none"></div></div><h3 class="section">Inherited Methods</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="EventTarget is an interface implemented by objects that can receive events and may have listeners for them." href="../../js/html/EventTarget.html">EventTarget</a></h4><div style="display:none"><div class="field "><a name="addEventListener"></a><h3><p><code><a href="#addEventListener"><span class="identifier">addEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p><p><code><a href="#addEventListener"><span class="identifier">addEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This method is called whenever an event occurs of the type for which the EventListener interface was registered." href="../../js/html/EventListener.html">EventListener</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false,</span> <span style="white-space:nowrap">?wantsUntrusted:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="dispatchEvent"></a><h3><p><code><a href="#dispatchEvent"><span class="identifier">dispatchEvent</span></a> (<span style="white-space:nowrap">event:<a class="type" title="The Event interface represents any event which takes place in the DOM; some are user-generated (such as mouse or keyboard events), while others are generated by APIs (such as events that indicate an animation has finished running, a video has been paused, and so forth)." href="../../js/html/Event.html">Event</a></span>):<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 class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="removeEventListener"></a><h3><p><code><a href="#removeEventListener"><span class="identifier">removeEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p><p><code><a href="#removeEventListener"><span class="identifier">removeEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This method is called whenever an event occurs of the type for which the EventListener interface was registered." href="../../js/html/EventListener.html">EventListener</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></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">© 2017 <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> |