Adding static documentation to the speech input extension API.

chrome/common/extensions/docs/static/experimental.speechInput.html

Index: chrome/common/extensions/docs/static/experimental.speechInput.html
diff --git a/chrome/common/extensions/docs/static/experimental.speechInput.html b/chrome/common/extensions/docs/static/experimental.speechInput.html
new file mode 100644
index 0000000000000000000000000000000000000000..fe46185242c38629be920bdd6d2eac3d983f21c8
--- /dev/null
+++ b/chrome/common/extensions/docs/static/experimental.speechInput.html
@@ -0,0 +1,110 @@
+<div id="pageData-name" class="pageData">Speech Input API</div>
+
+<!-- BEGIN AUTHORED CONTENT -->
+<p id="classSummary">
+The <code>chrome.experimental.speechInput</code> module provides
+one-shot speech recognition to Chrome extensions.
+This module is still experimental. For information on how to use experimental
+APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.
+</p>
+
+<h2 id="manifest">Manifest</h2>
+<p>You must declare the "experimental" permission in the <a
+  href="manifest.html">extension manifest</a> to use the speechInput
+API.
+For example:</p>
+<pre>{
+  "name": "My extension",
+  ...
+  <b>"permissions": [
+    "experimental"
+  ]</b>,
+  ...
+}</pre>
+
+<h2 id="howToStart">How to start speech recognition</h2>
+<p>To start recognizing speech an extension must call the <code>start</code>
+method. If provided, <code>callback</code> will be called once recording has
+successfully started. In case of error <code>chrome.extension.lastError</code>
+will be set.</p>
+
+<p>This API provides exclusive access to the default recording device to the
+first extension requesting it. Consequently, any calls to <code>start</code>
+when the device is being used by other extension or web page will fail and set

[Satish, 2011/11/14 10:22:44]

other -> another

[Leandro Graciá Gil, 2011/11/14 11:25:02]

Done.

+<code>chrome.extension.lastError</code>. The message <code>requestDenied</code>
+will be set if another extension in the same profile is making use of the API,
+otherwise <code>noRecordingDeviceFound</code>, <code>recordingDeviceInUse</code>
+or <code>unableToStart</code> will be set depending on the situation.</p>
+
+<p>To check if recording is currently active use call the <code>isRecording</code>

[Satish, 2011/11/14 10:22:44]

use call -> call

[Leandro Graciá Gil, 2011/11/14 11:25:02]

Done.

+method. Please note that it only checks for audio recording within Chrome.</p>
+
+
+<h2 id="howToGetResults">How to get speech recognition results</h2>
+<p>Listen to the <code>onResult</code> event to receive speech recognition
+results.</p>
+
+<pre>
+var callback = function(result) { ... };
+
+chrome.experimental.speechInput.onResult.addListener(callback);
+</pre>
+
+<p>The <code>result</code> object contains an array of recognition hypotheses

[Satish, 2011/11/14 10:22:44]

can you also document in detail this array item (i.e. a single result) ? Right
now the only info available about it is in the final example showing
.utterance.. we should ideally document all fields

[Leandro Graciá Gil, 2011/11/14 11:25:02]

Done.

+sorted by decreasing likelihood.</p>
+
+<p>Recording automatically stops when results are received. It is safe to call
+<code>start</code> again from the results callback.</p>
+
+<p>To handle errors during speech recognition listen for the
+<code>onError</code> event.</p>
+
+<pre>
+var callback = function(error) { ... };
+
+chrome.experimental.speechInput.onError.addListener(callback);
+</pre>
+
+</p>Recording will automatically stop in case on error.
+It is safe to call <code>start</code> again from the error callback.</p>
+
+
+<h2 id="howToStop">How to stop recording</h2>
+<p>To stop speech recognition call the <code>stop</code> method. If provided,
+<code>callback</code> will be called once recording has successfully
+stopped. In case of error <code>chrome.extension.lastError</code> will be set.
+</p>
+
+
+<h2 id="otherFeatures">Other features</h2>
+<ul><li>
+<code>onSoundStart</code> - Event generated when start of sound is detected
+(from previously being silent).
+</li><li>
+<code>onSoundEnd</code> - Event generated when end of sound is detected (a
+continued period of silence).
+</li></ul>
+
+
+<h2 id="examples">Examples</h2>
+<p>The following example illustrates how to show a javascript alert with the
+most likely recognition result.</p>
+<pre>
+function checkStart() {
+  if (chrome.extension.lastError) {
+    alert("Couldn't start speech input: " + chrome.extension.lastError.message);
+  }
+}
+
+function recognitionFailed(error) {
+  alert("Speech input failed: " + error.code);
+}
+
+function recognitionSucceeded(result) {
+  alert(result.hypotheses[0].utterance);
+}
+
+chrome.experimental.speechInput.onError.addListener(recognitionFailed);
+chrome.experimental.speechInput.onResult.addListener(recognitionSucceded);
+chrome.experimental.speechInput.start({ "language": "en" }, checkStart);
+</pre>