Clarify definition of continuous and of interim/final result.
authorGlen Shires <gshires@google.com>
Fri, 07 Sep 2012 00:44:15 -0700
changeset 25 7b70520efdb8
parent 24 2c33c874a025
child 26 d25fea0d029c
Clarify definition of continuous and of interim/final result.
speechapi.html
--- a/speechapi.html	Wed Sep 05 09:14:27 2012 -0700
+++ b/speechapi.html	Fri Sep 07 00:44:15 2012 -0700
@@ -518,6 +518,8 @@
     <h3 id="speechreco-section"><span class=secno>5.1 </span>The Speech Recognition Interface</h3>
 
     <p>The speech recognition interface is the scripted web <acronym title="Application Programming Interface">API</acronym> for controlling a given recognition.</p>
+    The term "final result" indicates a SpeechRecognitionResult in which the final attribute is true.
+    The term "interim result" indicates a SpeechRecognitionResult in which the final attribute is false.
 
     <div class="block">
       <div class="blockTitleDiv">
@@ -631,10 +633,11 @@
       This default value is computed and used when the input request opens a connection to the recognition service.</dd>
 
       <dt><dfn id="dfn-continuous">continuous</dfn> attribute</dt>
-      <dd>When the continuous attribute is set to false the service <em class="rfc2119" title="must">must</em> only return a single simple recognition response as a result of starting recognition.
-      This represents a request/response single turn pattern of interaction.
-      When the continuous attribute is set to true the service <em class="rfc2119" title="must">must</em> return a set of recognitions representing more a dictation of multiple recognitions in response to a single starting of recognition.
-      The user agent default value <em class="rfc2119" title="should">should</em> be false.</dd>
+      <dd>When the continuous attribute is set to false, the user agent <em class="rfc2119" title="must">must</em> return no more than one final result in response to starting recognition,
+      for example a single turn pattern of interaction.
+      When the continuous attribute is set to true, the user agent <em class="rfc2119" title="must">must</em> return zero or more final results representing multiple consecutive recognitions in response to starting recognition,
+      for example a dictation.
+      The default value <em class="rfc2119" title="must">must</em> be false.  Note, this attribute setting does not affect interim results.</dd>
 
       <dt><dfn id="dfn-maxalternatives">maxAlternatives</dfn> attribute</dt>
       <dd>This attribute will set the maximum number of <a href="#speechreco-alternative">SpeechRecognitionAlternative</a>s per result.
@@ -689,18 +692,18 @@
       <dd>Fired when the user agent has started to capture audio.</dd>
 
       <dt><dfn id="dfn-onsoundstart">soundstart</dfn> event</dt>
-      <dd>Some sound, possibly speech, has been detected.
+      <dd>Fired when some sound, possibly speech, has been detected.
       This <em class="rfc2119" title="must">must</em> be fired with low latency, e.g. by using a client-side energy detector.</dd>
 
       <dt><dfn id="dfn-onspeechstart">speechstart</dfn> event</dt>
-      <dd>The speech that will be used for speech recognition has started.</dd>
+      <dd>Fired when the speech that will be used for speech recognition has started.</dd>
 
       <dt><dfn id="dfn-onspeechend">speechend</dfn> event</dt>
-      <dd>The speech that will be used for speech recognition has ended.
+      <dd>Fired when the speech that will be used for speech recognition has ended.
       speechstart <em class="rfc2119" title="must">must</em> always have been fire before speechend.</dd>
 
       <dt><dfn id="dfn-onsoundend">soundend</dfn> event</dt>
-      <dd>Some sound is no longer detected.
+      <dd>Fired when some sound is no longer detected.
       This <em class="rfc2119" title="must">must</em> be fired with low latency, e.g. by using a client-side energy detector.
       soundstart <em class="rfc2119" title="must">must</em> always have been fired before soundend.</dd>