chrome/common/extensions/docs/experimental.speechInput.html - Issue 10642015: Basic setup for generating app docs

Unified Diff: chrome/common/extensions/docs/experimental.speechInput.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 8 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

« no previous file with comments | « chrome/common/extensions/docs/experimental.socket.html ('k') | chrome/common/extensions/docs/experimental.storage.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: chrome/common/extensions/docs/experimental.speechInput.html

diff --git a/chrome/common/extensions/docs/experimental.speechInput.html b/chrome/common/extensions/docs/experimental.speechInput.html

deleted file mode 100644

index 858d820d98d4b147bba2a1784eab11777585a6c7..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/experimental.speechInput.html

+++ /dev/null

@@ -1,1059 +0,0 @@

-<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

- 1) The <head> information in this page is significant, should be uniform

- across api docs and should be edited only with knowledge of the

- templating mechanism.

- 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

- browser, it will be re-generated from the template, json schema and

- authored overview content.

- 4) The <body>.innerHTML is also generated by an offline step so that this

- page may easily be indexed by search engines.

---><html xmlns="http://www.w3.org/1999/xhtml"><head>

- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

- <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">

- </script>

- <script type="text/javascript" src="../../../../third_party/json_minify/minify-sans-regexp.js">

- </script>

- <script type="text/javascript" src="js/api_page_generator.js"></script>

- <script type="text/javascript" src="js/bootstrap.js"></script>

- <script type="text/javascript" src="js/sidebar.js"></script>

- <meta name="description" content="Documentation for the chrome.experimental.speechInput module, which is part of the Google Chrome extension APIs."><title>Speech Input API - Google Chrome Extensions - Google Code</title></head>

- <body> <div id="devModeWarning" class="displayModeWarning">

- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.

- </div>

- <div id="branchWarning" class="displayModeWarning">

- <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

- It may not work with the stable release of Chrome.</span>

- <select id="branchChooser">

- <option>Choose a different version...

- </option><option value="">Stable

- </option><option value="beta">Beta

- </option><option value="dev">Dev

- </option><option value="trunk">Trunk

- </option></select>

- </div>

- <div id="unofficialWarning" class="displayModeWarning">

- <span>WARNING: This is unofficial documentation. It may not work with the

- current release of Chrome.</span>

- <button id="goToOfficialDocs">Go to the official docs</button>

- </div>

- <div id="gc-container" class="labs">

-

- <!-- In particular, sub-templates that recurse, must be used by allowing

- jstemplate to make a copy of the template in this section which

- are not operated on by way of the jsskip="true" -->

-

- <a id="top"></a>

- <div id="skipto">

- <a href="#gc-pagecontent">Skip to page content</a>

- <a href="#gc-toc">Skip to main navigation</a>

- </div>

-

- <table id="header" width="100%" cellspacing="0" border="0">

- <tbody><tr>

- <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>

- <td valign="middle" width="100%" style="padding-left:0.6em;">

- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">

- <div id="gsc-search-box">

- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">

- <input type="hidden" name="ie" value="UTF-8">

- <input type="text" name="q" value="" size="55">

- <input class="gsc-search-button" type="submit" name="sa" value="Search">

- <br>

- <span class="greytext">e.g. "page action" or "tabs"</span>

- </div>

- </form>

- <script type="text/javascript" src="https://www.google.com/jsapi"></script>

- <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script>

- </td>

- </tr>

- </tbody></table>

- <div id="codesiteContent" class="">

- <a id="gc-topnav-anchor"></a>

- <div id="gc-topnav">

- <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>

- <ul id="home" class="gc-topnav-tabs">

- <li id="home_link">

- <a href="index.html" title="Google Chrome Extensions home page">Home</a>

- </li>

- <li id="docs_link">

- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>

- </li>

- <li id="faq_link">

- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>

- </li>

- <li id="samples_link">

- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>

- </li>

- <li id="group_link">

- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

- </li>

- <li id="so_link">

- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>

- </li>

- </ul>

- </div>

- <div class="g-section g-tpl-170">

-

- <div class="g-unit g-first" id="gc-toc">

- <ul>

- <li><a href="getstarted.html">Getting Started</a></li>

- <li><a href="overview.html">Overview</a></li>

- <li><a href="whats_new.html">What's New?</a></li>

- <li><h2><a href="devguide.html">Developer's Guide</a></h2>

- <ul>

- <li>Browser UI

- <ul>

- <li><a href="browserAction.html">Browser Actions</a></li>

- <li><a href="contextMenus.html">Context Menus</a></li>

- <li><a href="notifications.html">Desktop Notifications</a></li>

- <li><a href="omnibox.html">Omnibox</a></li>

- <li><a href="options.html">Options Pages</a></li>

- <li><a href="override.html">Override Pages</a></li>

- <li><a href="pageAction.html">Page Actions</a></li>

- </ul>

- </li>

- <li>Browser Interaction

- <ul>

- <li><a href="bookmarks.html">Bookmarks</a></li>

- <li><a href="cookies.html">Cookies</a></li>

- <li><a href="devtools.html">Developer Tools</a></li>

- <li><a href="events.html">Events</a></li>

- <li><a href="history.html">History</a></li>

- <li><a href="management.html">Management</a></li>

- <li><a href="tabs.html">Tabs</a></li>

- <li><a href="windows.html">Windows</a></li>

- </ul>

- </li>

- <li>Implementation

- <ul>

- <li><a href="a11y.html">Accessibility</a></li>

- <li><a href="background_pages.html">Background Pages</a></li>

- <li><a href="content_scripts.html">Content Scripts</a></li>

- <li><a href="xhr.html">Cross-Origin XHR</a></li>

- <li><a href="i18n.html">Internationalization</a></li>

- <li><a href="messaging.html">Message Passing</a></li>

- <li><a href="permissions.html">Optional Permissions</a></li>

- <li><a href="npapi.html">NPAPI Plugins</a></li>

- </ul>

- </li>

- <li>Finishing

- <ul>

- <li><a href="hosting.html">Hosting</a></li>

- <li><a href="external_extensions.html">Other Deployment Options</a></li>

- </ul>

- </li>

- </ul>

- </li>

- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

- <li><h2><a href="tutorials.html">Tutorials</a></h2>

- <ul>

- <li><a href="tut_debugging.html">Debugging</a></li>

- <li><a href="tut_analytics.html">Google Analytics</a></li>

- <li><a href="tut_oauth.html">OAuth</a></li>

- </ul>

- </li>

- <li><h2>Reference</h2>

- <ul>

- <li>Formats

- <ul>

- <li><a href="manifest.html">Manifest Files</a></li>

- <li><a href="match_patterns.html">Match Patterns</a></li>

- </ul>

- </li>

- <li><a href="permission_warnings.html">Permission Warnings</a></li>

- <li><a href="api_index.html">chrome.* APIs</a></li>

- <li><a href="api_other.html">Other APIs</a></li>

- </ul>

- </li>

- <li><h2><a href="samples.html">Samples</a></h2></li>

- <div class="line"> </div>

- <li><h2>More</h2>

- <ul>

- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>

- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>

- <li><a href="themes.html">Themes</a></li>

- </ul>

- </li>

- </ul>

- </div>

- <script>

- initToggles();

- </script>

- <div class="g-unit" id="gc-pagecontent">

- <div id="pageTitle">

- <h1 class="page_title">Speech Input API</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#manifest">Manifest</a>

- <ol>

- </ol>

- </li><li>

- <a href="#howToStart">How to start speech recognition</a>

- <ol>

- </ol>

- </li><li>

- <a href="#howToGetResults">How to get speech recognition results</a>

- <ol>

- </ol>

- </li><li>

- <a href="#howToStop">How to stop recording</a>

- <ol>

- </ol>

- </li><li>

- <a href="#otherFeatures">Other features</a>

- <ol>

- </ol>

- </li><li>

- <a href="#examples">Examples</a>

- <ol>

- </ol>

- </li>

- <li>

- <a href="#apiReference">API reference: chrome.experimental.speechInput</a>

- <ol>

- <li>

- <a href="#global-methods">Methods</a>

- <ol>

- <li>

- <a href="#method-isRecording">isRecording</a>

- </li><li>

- <a href="#method-start">start</a>

- </li><li>

- <a href="#method-stop">stop</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#global-events">Events</a>

- <ol>

- <li>

- <a href="#event-onError">onError</a>

- </li><li>

- <a href="#event-onResult">onResult</a>

- </li><li>

- <a href="#event-onSoundEnd">onSoundEnd</a>

- </li><li>

- <a href="#event-onSoundStart">onSoundStart</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#types">Types</a>

- <ol>

- <li>

- <a href="#type-SpeechInputStartOptions">SpeechInputStartOptions</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-SpeechInputError">SpeechInputError</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-SpeechInputResultHypothesis">SpeechInputResultHypothesis</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-SpeechInputResultEvent">SpeechInputResultEvent</a>

- <ol>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

- <div id="static"><div id="pageData-name" class="pageData">Speech Input API</div>

-

-<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 speech input

-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, your callback 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 another extension or web page will fail and set

-<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 whether recording is currently active, call the

-<code>isRecording()</code> 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

-<a href="#type-SpeechInputResultHypothesis">SpeechInputResultHypothesis</a>

-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></p>Recording will automatically stop in case of error.

-It is safe to call <code>start()</code> again from the error callback.<p></p>

-<h2 id="howToStop">How to stop recording</h2>

-<p>To stop speech recognition call the <code>stop()</code> method. If provided,

-the callback function 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("Recognized '" + result.hypotheses[0].utterance + "' with confidence " + result.hypotheses[0].confidence);

-chrome.experimental.speechInput.onError.addListener(recognitionFailed);

-chrome.experimental.speechInput.onResult.addListener(recognitionSucceeded);

-chrome.experimental.speechInput.start({ "language": "en" }, checkStart);

-</pre>

-</div>

-

- <div class="apiPage">

- <a name="apiReference"></a>

- <h2>API reference: chrome.experimental.speechInput</h2>

-

-

-

- <div id="methodsTemplate" class="apiGroup">

- <a name="global-methods"></a>

- <h3>Methods</h3>

-

- <div class="apiItem">

- <a name="method-isRecording"></a>

- <h4>isRecording</h4>

- <div class="summary">

-

- <span>chrome.experimental.speechInput.isRecording</span>(<span class="optional"><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Determine if audio recording is currently in process in Chrome, not limited to this API.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span>boolean result</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>result</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Flag set to true if recording is in process in Chrome, false otherwise.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-start"></a>

- <h4>start</h4>

- <div class="summary">

-

- <span>chrome.experimental.speechInput.start</span>(<span class="optional"><span>SpeechInputStartOptions</span>

- <var><span>options</span></var></span><span class="optional"><span>, </span><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Request to start recording as a new speech recognition session.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>options</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <a href="experimental.speechInput.html#type-SpeechInputStartOptions">SpeechInputStartOptions</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Options used for this speech recognition session.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Called when the speech recognition session has successfully started recording.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-stop"></a>

- <h4>stop</h4>

- <div class="summary">

-

- <span>chrome.experimental.speechInput.stop</span>(<span class="optional"><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Request to stop an ongoing speech recognition session.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Called when the audio recording has stopped and any pending recognition results have been completed.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

- </div>

-

- <div id="eventsTemplate" class="apiGroup">

- <a name="global-events"></a>

- <h3>Events</h3>

-

- <div class="apiItem">

- <a name="event-onError"></a>

- <h4>onError</h4>

- <div class="summary">

-

- <span class="subdued">chrome.experimental.speechInput.</span><span>onError</span><span class="subdued">.addListener</span>(function(<span>SpeechInputError error</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Called in case of an error in speech recognition.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>error</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.speechInput.html#type-SpeechInputError">SpeechInputError</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Error being reported.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div><div class="apiItem">

- <a name="event-onResult"></a>

- <h4>onResult</h4>

- <div class="summary">

-

- <span class="subdued">chrome.experimental.speechInput.</span><span>onResult</span><span class="subdued">.addListener</span>(function(<span>SpeechInputResultEvent event</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Called when speech recognition results are available.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>event</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.speechInput.html#type-SpeechInputResultEvent">SpeechInputResultEvent</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Object containing the speech recognition results.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div><div class="apiItem">

- <a name="event-onSoundEnd"></a>

- <h4>onSoundEnd</h4>

- <div class="summary">

-

- <span class="subdued">chrome.experimental.speechInput.</span><span>onSoundEnd</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Called when the system detects enough silence to consider the ongoing speech has ended.</p>

-

-

-

- <dl>

- </dl>

- </div>

-

- </div><div class="apiItem">

- <a name="event-onSoundStart"></a>

- <h4>onSoundStart</h4>

- <div class="summary">

-

- <span class="subdued">chrome.experimental.speechInput.</span><span>onSoundStart</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Called when the system starts detecting sound in the input data.</p>

-

-

-

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

-

- <div class="apiGroup">

- <a name="types"></a>

- <h3 id="types">Types</h3>

-

- <div class="apiItem">

- <a name="type-SpeechInputStartOptions"></a>

- <h4>SpeechInputStartOptions</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Object describing the options used for speech recognition.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>language</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>BCP-47 language code of the language to recognize. When set to 'auto' or not defined defaults to user's most preferred content language. Will use 'en-US' if not supported or invalid.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>grammar</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Name of the grammar to use. Defaults to 'builtin:dictation'.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>filterProfanities</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Enable or disable profanity filtering. Will use the default Chrome filtering settings if not set.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-SpeechInputError"></a>

- <h4>SpeechInputError</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Object describing a speech input error.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>code</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- <span>["noSpeechHeard", "noResults", "captureError", "networkError"]</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Code identifying the error case.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-SpeechInputResultHypothesis"></a>

- <h4>SpeechInputResultHypothesis</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Object describing a speech recognition hypothesis.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>utterance</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Text of this hypothesis.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>confidence</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>number</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Confidence of the hypothesis. Rated from 0 (lowest) to 1 (highest).</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-SpeechInputResultEvent"></a>

- <h4>SpeechInputResultEvent</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Object containing the recognition results.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>hypotheses</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- array of <span><span>

- <span>

- <a href="experimental.speechInput.html#type-SpeechInputResultHypothesis">SpeechInputResultHypothesis</a>

- </span>

- </span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Array of zero or more objects describing the stable candidate hypotheses sorted by decreasing likelihood.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- <div id="gc-footer" --="">

- <div class="text">

- <p>

- Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,

- the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons

- Attribution 3.0 License</a>, and code samples are licensed under the

- <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.

- </p>

- <p>

- </p>

-

-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>

-<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>

-<script type="text/javascript">

- // chrome doc tracking

- try {

- var engdocs = _gat._getTracker("YT-10763712-2");

- engdocs._trackPageview();

- } catch(err) {}

- // code.google.com site-wide tracking

- try {

- _uacct="UA-18071-1";

- _uanchor=1;

- _uff=0;

- urchinTracker();

- }

- catch(e) {/* urchinTracker not available. */}

-</script>

-

- </div>

- </div>

- </div>

-</body></html>

« no previous file with comments | « chrome/common/extensions/docs/experimental.socket.html ('k') | chrome/common/extensions/docs/experimental.storage.html » ('j') | no next file with comments »