Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1)

Side by Side Diff: chrome/common/extensions/docs/experimental.speechInput.html

Issue 8100005: Adding the automatically generated files for the experimental extension speech input API. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 9 years, 2 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 unified diff | Download patch | Annotate | Revision Log
OLDNEW
(Empty)
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the
4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and
7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script>
16 <script type="text/javascript" src="js/api_page_generator.js"></script>
17 <script type="text/javascript" src="js/bootstrap.js"></script>
18 <script type="text/javascript" src="js/sidebar.js"></script>
19 <title>chrome.experimental.speechInput - Google Chrome Extensions - Google Cod e</title></head>
20 <body> <div id="gc-container" class="labs">
21 <div id="devModeWarning">
22 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.
23 </div>
24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
25 <!-- In particular, sub-templates that recurse, must be used by allowing
26 jstemplate to make a copy of the template in this section which
27 are not operated on by way of the jsskip="true" -->
28 <div style="display:none">
29
30 <!-- VALUE -->
31 <div id="valueTemplate">
32 <dt>
33 <var>paramName</var>
34 <em>
35
36 <!-- TYPE -->
37 <div style="display:inline">
38 (
39 <span class="optional">optional</span>
40 <span class="enum">enumerated</span>
41 <span id="typeTemplate">
42 <span>
43 <a> Type</a>
44 </span>
45 <span>
46 <span>
47 array of <span><span></span></span>
48 </span>
49 <span>paramType</span>
50 <span></span>
51 </span>
52 </span>
53 )
54 </div>
55
56 </em>
57 </dt>
58 <dd class="todo">
59 Undocumented.
60 </dd>
61 <dd>
62 Description of this parameter from the json schema.
63 </dd>
64 <dd>
65 This parameter was added in version
66 <b><span></span></b>.
67 You must omit this parameter in earlier versions,
68 and you may omit it in any version. If you require this
69 parameter, the manifest key
70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
71 can ensure that your extension won't be run in an earlier browser ve rsion.
72 </dd>
73
74 <!-- OBJECT PROPERTIES -->
75 <dd>
76 <dl>
77 <div>
78 <div>
79 </div>
80 </div>
81 </dl>
82 </dd>
83
84 <!-- OBJECT METHODS -->
85 <dd>
86 <div></div>
87 </dd>
88
89 <!-- OBJECT EVENT FIELDS -->
90 <dd>
91 <div></div>
92 </dd>
93
94 <!-- FUNCTION PARAMETERS -->
95 <dd>
96 <div></div>
97 </dd>
98
99 </div> <!-- /VALUE -->
100
101 <div id="functionParametersTemplate">
102 <h5>Parameters</h5>
103 <dl>
104 <div>
105 <div>
106 </div>
107 </div>
108 </dl>
109 </div>
110 </div> <!-- /SUBTEMPLATES -->
111
112 <a id="top"></a>
113 <div id="skipto">
114 <a href="#gc-pagecontent">Skip to page content</a>
115 <a href="#gc-toc">Skip to main navigation</a>
116 </div>
117 <!-- API HEADER -->
118 <table id="header" width="100%" cellspacing="0" border="0">
119 <tbody><tr>
120 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
121 <td valign="middle" width="100%" style="padding-left:0.6em;">
122 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
123 <div id="gsc-search-box">
124 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
125 <input type="hidden" name="ie" value="UTF-8">
126 <input type="text" name="q" value="" size="55">
127 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
128 <br>
129 <span class="greytext">e.g. "page action" or "tabs"</span>
130 </div>
131 </form>
132
133 <script type="text/javascript" src="http://www.google.com/jsapi"></scr ipt>
134 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
135 <script type="text/javascript" src="http://www.google.com/coop/cse/t13 n?form=cse&amp;t13n_langs=en"></script>
136 <script type="text/javascript" src="http://www.google.com/coop/cse/bra nd?form=cse&amp;lang=en"></script>
137 </td>
138 </tr>
139 </tbody></table>
140
141 <div id="codesiteContent" class="">
142
143 <a id="gc-topnav-anchor"></a>
144 <div id="gc-topnav">
145 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
146 <ul id="home" class="gc-topnav-tabs">
147 <li id="home_link">
148 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
149 </li>
150 <li id="docs_link">
151 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
152 </li>
153 <li id="faq_link">
154 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
155 </li>
156 <li id="samples_link">
157 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
158 </li>
159 <li id="group_link">
160 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
161 </li>
162 </ul>
163 </div> <!-- end gc-topnav -->
164
165 <div class="g-section g-tpl-170">
166 <!-- SIDENAV -->
167 <div class="g-unit g-first" id="gc-toc">
168 <ul>
169 <li><a href="getstarted.html">Getting Started</a></li>
170 <li><a href="overview.html">Overview</a></li>
171 <li><a href="whats_new.html">What's New?</a></li>
172 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
173 <ul>
174 <li>Browser UI
175 <ul>
176 <li><a href="browserAction.html">Browser Actions</a></li>
177 <li><a href="contextMenus.html">Context Menus</a></li>
178 <li><a href="notifications.html">Desktop Notifications</a></li >
179 <li><a href="omnibox.html">Omnibox</a></li>
180 <li><a href="options.html">Options Pages</a></li>
181 <li><a href="override.html">Override Pages</a></li>
182 <li><a href="pageAction.html">Page Actions</a></li>
183 </ul>
184 </li>
185 <li>Browser Interaction
186 <ul>
187 <li><a href="bookmarks.html">Bookmarks</a></li>
188 <li><a href="cookies.html">Cookies</a></li>
189 <li><a href="events.html">Events</a></li>
190 <li><a href="history.html">History</a></li>
191 <li><a href="management.html">Management</a></li>
192 <li><a href="tabs.html">Tabs</a></li>
193 <li><a href="windows.html">Windows</a></li>
194 </ul>
195 </li>
196 <li>Implementation
197 <ul>
198 <li><a href="a11y.html">Accessibility</a></li>
199 <li><a href="background_pages.html">Background Pages</a></li>
200 <li><a href="content_scripts.html">Content Scripts</a></li>
201 <li><a href="xhr.html">Cross-Origin XHR</a></li>
202 <li><a href="i18n.html">Internationalization</a></li>
203 <li><a href="messaging.html">Message Passing</a></li>
204 <li><a href="npapi.html">NPAPI Plugins</a></li>
205 </ul>
206 </li>
207 <li>Finishing
208 <ul>
209 <li><a href="hosting.html">Hosting</a></li>
210 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
211 </ul>
212 </li>
213 </ul>
214 </li>
215 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
216 <li><h2><a href="tutorials.html">Tutorials</a></h2>
217 <ul>
218 <li><a href="tut_debugging.html">Debugging</a></li>
219 <li><a href="tut_analytics.html">Google Analytics</a></li>
220 <li><a href="tut_oauth.html">OAuth</a></li>
221 </ul>
222 </li>
223 <li><h2>Reference</h2>
224 <ul>
225 <li>Formats
226 <ul>
227 <li><a href="manifest.html">Manifest Files</a></li>
228 <li><a href="match_patterns.html">Match Patterns</a></li>
229 </ul>
230 </li>
231 <li><a href="permission_warnings.html">Permission Warnings</a></li >
232 <li><a href="api_index.html">chrome.* APIs</a></li>
233 <li><a href="api_other.html">Other APIs</a></li>
234 </ul>
235 </li>
236 <li><h2><a href="samples.html">Samples</a></h2></li>
237 <div class="line"> </div>
238 <li><h2>More</h2>
239 <ul>
240 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
241 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
242 <li><a href="themes.html">Themes</a></li>
243 </ul>
244 </li>
245 </ul>
246 </div>
247 <script>
248 initToggles();
249 </script>
250
251 <div class="g-unit" id="gc-pagecontent">
252 <div id="pageTitle">
253 <h1 class="page_title">chrome.experimental.speechInput</h1>
254 </div>
255 <!-- TABLE OF CONTENTS -->
256 <div id="toc">
257 <h2>Contents</h2>
258 <ol>
259 <li style="display: none; ">
260 <a>h2Name</a>
261 <ol>
262 <li>
263 <a>h3Name</a>
264 </li>
265 </ol>
266 </li>
267 <li>
268 <a href="#apiReference">API reference: chrome.experimental.speec hInput</a>
269 <ol>
270 <li style="display: none; ">
271 <a href="#properties">Properties</a>
272 <ol>
273 <li>
274 <a href="#property-anchor">propertyName</a>
275 </li>
276 </ol>
277 </li>
278 <li>
279 <a href="#global-methods">Methods</a>
280 <ol>
281 <li>
282 <a href="#method-isRecording">isRecording</a>
283 </li><li>
284 <a href="#method-start">start</a>
285 </li><li>
286 <a href="#method-stop">stop</a>
287 </li>
288 </ol>
289 </li>
290 <li>
291 <a href="#global-events">Events</a>
292 <ol>
293 <li>
294 <a href="#event-onError">onError</a>
295 </li><li>
296 <a href="#event-onResult">onResult</a>
297 </li><li>
298 <a href="#event-onSoundEnd">onSoundEnd</a>
299 </li><li>
300 <a href="#event-onSoundStart">onSoundStart</a>
301 </li>
302 </ol>
303 </li>
304 <li>
305 <a href="#types">Types</a>
306 <ol>
307 <li>
308 <a href="#type-StartOptions">StartOptions</a>
309 </li><li>
310 <a href="#type-Error">Error</a>
311 </li><li>
312 <a href="#type-ResultHypothesis">ResultHypothesis</a>
313 </li><li>
314 <a href="#type-SpeechResultEvent">SpeechResultEvent</a>
315 </li>
316 </ol>
317 </li>
318 </ol>
319 </li>
320 </ol>
321 </div>
322 <!-- /TABLE OF CONTENTS -->
323
324 <!-- Standard content lead-in for experimental API pages -->
325 <p id="classSummary">
326 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
327 </p>
328
329 <!-- STATIC CONTENT PLACEHOLDER -->
330 <div id="static"></div>
331
332 <!-- API PAGE -->
333 <div class="apiPage">
334 <a name="apiReference"></a>
335 <h2>API reference: chrome.experimental.speechInput</h2>
336
337 <!-- PROPERTIES -->
338 <div class="apiGroup" style="display: none; ">
339 <a name="properties"></a>
340 <h3 id="properties">Properties</h3>
341
342 <div>
343 <a></a>
344 <h4>getLastError</h4>
345 <div class="summary">
346 <!-- Note: intentionally longer 80 columns -->
347 <span>chrome.extension</span><span>lastError</span>
348 </div>
349 <div>
350 </div>
351 </div>
352
353 </div> <!-- /apiGroup -->
354
355 <!-- METHODS -->
356 <div id="methodsTemplate" class="apiGroup">
357 <a name="global-methods"></a>
358 <h3>Methods</h3>
359
360 <!-- iterates over all functions -->
361 <div class="apiItem">
362 <a name="method-isRecording"></a> <!-- method-anchor -->
363 <h4>isRecording</h4>
364
365 <div class="summary"><span style="display: none; ">void</span>
366 <!-- Note: intentionally longer 80 columns -->
367 <span>chrome.experimental.speechInput.isRecording</span>(<span class="optional"><span style="display: none; ">, </span><span>function</span>
368 <var><span>callback</span></var></span>)</div>
369
370 <div class="description">
371 <p class="todo" style="display: none; ">Undocumented.</p>
372 <p>Determine if the API is currently recording audio as part of a speech recognition session.</p>
373
374 <!-- PARAMETERS -->
375 <h4>Parameters</h4>
376 <dl>
377 <div>
378 <div>
379 <dt>
380 <var>callback</var>
381 <em>
382
383 <!-- TYPE -->
384 <div style="display:inline">
385 (
386 <span class="optional">optional</span>
387 <span class="enum" style="display: none; ">enumerated</span>
388 <span id="typeTemplate">
389 <span style="display: none; ">
390 <a> Type</a>
391 </span>
392 <span>
393 <span style="display: none; ">
394 array of <span><span></span></span>
395 </span>
396 <span>function</span>
397 <span style="display: none; "></span>
398 </span>
399 </span>
400 )
401 </div>
402
403 </em>
404 </dt>
405 <dd class="todo">
406 Undocumented.
407 </dd>
408 <dd style="display: none; ">
409 Description of this parameter from the json schema.
410 </dd>
411 <dd style="display: none; ">
412 This parameter was added in version
413 <b><span></span></b>.
414 You must omit this parameter in earlier versions,
415 and you may omit it in any version. If you require this
416 parameter, the manifest key
417 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
418 can ensure that your extension won't be run in an earlier browser ve rsion.
419 </dd>
420
421 <!-- OBJECT PROPERTIES -->
422 <dd style="display: none; ">
423 <dl>
424 <div>
425 <div>
426 </div>
427 </div>
428 </dl>
429 </dd>
430
431 <!-- OBJECT METHODS -->
432 <dd style="display: none; ">
433 <div></div>
434 </dd>
435
436 <!-- OBJECT EVENT FIELDS -->
437 <dd style="display: none; ">
438 <div></div>
439 </dd>
440
441 <!-- FUNCTION PARAMETERS -->
442 <dd style="display: none; ">
443 <div></div>
444 </dd>
445
446 </div>
447 </div>
448 </dl>
449
450 <!-- RETURNS -->
451 <h4 style="display: none; ">Returns</h4>
452 <dl>
453 <div style="display: none; ">
454 <div>
455 </div>
456 </div>
457 </dl>
458
459 <!-- CALLBACK -->
460 <div>
461 <div>
462 <h4>Callback function</h4>
463 <p style="display: none; ">
464 The callback <em>parameter</em> should specify a function
465 that looks like this:
466 </p>
467 <p>
468 If you specify the <em>callback</em> parameter, it should
469 specify a function that looks like this:
470 </p>
471
472 <!-- Note: intentionally longer 80 columns -->
473 <pre>function(<span>boolean result</span>) <span class="subdue d">{...}</span>;</pre>
474 <dl>
475 <div>
476 <div>
477 <dt>
478 <var>result</var>
479 <em>
480
481 <!-- TYPE -->
482 <div style="display:inline">
483 (
484 <span class="optional" style="display: none; ">optional</spa n>
485 <span class="enum" style="display: none; ">enumerated</span>
486 <span id="typeTemplate">
487 <span style="display: none; ">
488 <a> Type</a>
489 </span>
490 <span>
491 <span style="display: none; ">
492 array of <span><span></span></span>
493 </span>
494 <span>boolean</span>
495 <span style="display: none; "></span>
496 </span>
497 </span>
498 )
499 </div>
500
501 </em>
502 </dt>
503 <dd class="todo" style="display: none; ">
504 Undocumented.
505 </dd>
506 <dd>Flag set to true if the API is currently recording for speech reco gnition.</dd>
507 <dd style="display: none; ">
508 This parameter was added in version
509 <b><span></span></b>.
510 You must omit this parameter in earlier versions,
511 and you may omit it in any version. If you require this
512 parameter, the manifest key
513 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
514 can ensure that your extension won't be run in an earlier browser ve rsion.
515 </dd>
516
517 <!-- OBJECT PROPERTIES -->
518 <dd style="display: none; ">
519 <dl>
520 <div>
521 <div>
522 </div>
523 </div>
524 </dl>
525 </dd>
526
527 <!-- OBJECT METHODS -->
528 <dd style="display: none; ">
529 <div></div>
530 </dd>
531
532 <!-- OBJECT EVENT FIELDS -->
533 <dd style="display: none; ">
534 <div></div>
535 </dd>
536
537 <!-- FUNCTION PARAMETERS -->
538 <dd style="display: none; ">
539 <div></div>
540 </dd>
541
542 </div>
543 </div>
544 </dl>
545 </div>
546 </div>
547
548 <!-- MIN_VERSION -->
549 <p style="display: none; ">
550 This function was added in version <b><span></span></b>.
551 If you require this function, the manifest key
552 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
553 can ensure that your extension won't be run in an earlier brow ser version.
554 </p>
555 </div> <!-- /description -->
556
557 </div><div class="apiItem">
558 <a name="method-start"></a> <!-- method-anchor -->
559 <h4>start</h4>
560
561 <div class="summary"><span style="display: none; ">void</span>
562 <!-- Note: intentionally longer 80 columns -->
563 <span>chrome.experimental.speechInput.start</span>(<span class ="optional"><span style="display: none; ">, </span><span>StartOptions</span>
564 <var><span>options</span></var></span><span class="optiona l"><span>, </span><span>function</span>
565 <var><span>callback</span></var></span>)</div>
566
567 <div class="description">
568 <p class="todo" style="display: none; ">Undocumented.</p>
569 <p>Request to start recording as a new speech recognition sessio n.</p>
570
571 <!-- PARAMETERS -->
572 <h4>Parameters</h4>
573 <dl>
574 <div>
575 <div>
576 <dt>
577 <var>options</var>
578 <em>
579
580 <!-- TYPE -->
581 <div style="display:inline">
582 (
583 <span class="optional">optional</span>
584 <span class="enum" style="display: none; ">enumerated</span>
585 <span id="typeTemplate">
586 <span>
587 <a href="experimental.speechInput.html#type-StartOptions ">StartOptions</a>
588 </span>
589 <span style="display: none; ">
590 <span>
591 array of <span><span></span></span>
592 </span>
593 <span>paramType</span>
594 <span></span>
595 </span>
596 </span>
597 )
598 </div>
599
600 </em>
601 </dt>
602 <dd class="todo" style="display: none; ">
603 Undocumented.
604 </dd>
605 <dd>Options used for this speech recognition session.</dd>
606 <dd style="display: none; ">
607 This parameter was added in version
608 <b><span></span></b>.
609 You must omit this parameter in earlier versions,
610 and you may omit it in any version. If you require this
611 parameter, the manifest key
612 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
613 can ensure that your extension won't be run in an earlier browser ve rsion.
614 </dd>
615
616 <!-- OBJECT PROPERTIES -->
617 <dd style="display: none; ">
618 <dl>
619 <div>
620 <div>
621 </div>
622 </div>
623 </dl>
624 </dd>
625
626 <!-- OBJECT METHODS -->
627 <dd style="display: none; ">
628 <div></div>
629 </dd>
630
631 <!-- OBJECT EVENT FIELDS -->
632 <dd style="display: none; ">
633 <div></div>
634 </dd>
635
636 <!-- FUNCTION PARAMETERS -->
637 <dd style="display: none; ">
638 <div></div>
639 </dd>
640
641 </div>
642 </div><div>
643 <div>
644 <dt>
645 <var>callback</var>
646 <em>
647
648 <!-- TYPE -->
649 <div style="display:inline">
650 (
651 <span class="optional">optional</span>
652 <span class="enum" style="display: none; ">enumerated</span>
653 <span id="typeTemplate">
654 <span style="display: none; ">
655 <a> Type</a>
656 </span>
657 <span>
658 <span style="display: none; ">
659 array of <span><span></span></span>
660 </span>
661 <span>function</span>
662 <span style="display: none; "></span>
663 </span>
664 </span>
665 )
666 </div>
667
668 </em>
669 </dt>
670 <dd class="todo" style="display: none; ">
671 Undocumented.
672 </dd>
673 <dd>Called when the speech recognition session has successfully starte d recording.</dd>
674 <dd style="display: none; ">
675 This parameter was added in version
676 <b><span></span></b>.
677 You must omit this parameter in earlier versions,
678 and you may omit it in any version. If you require this
679 parameter, the manifest key
680 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
681 can ensure that your extension won't be run in an earlier browser ve rsion.
682 </dd>
683
684 <!-- OBJECT PROPERTIES -->
685 <dd style="display: none; ">
686 <dl>
687 <div>
688 <div>
689 </div>
690 </div>
691 </dl>
692 </dd>
693
694 <!-- OBJECT METHODS -->
695 <dd style="display: none; ">
696 <div></div>
697 </dd>
698
699 <!-- OBJECT EVENT FIELDS -->
700 <dd style="display: none; ">
701 <div></div>
702 </dd>
703
704 <!-- FUNCTION PARAMETERS -->
705 <dd style="display: none; ">
706 <div></div>
707 </dd>
708
709 </div>
710 </div>
711 </dl>
712
713 <!-- RETURNS -->
714 <h4 style="display: none; ">Returns</h4>
715 <dl>
716 <div style="display: none; ">
717 <div>
718 </div>
719 </div>
720 </dl>
721
722 <!-- CALLBACK -->
723 <div>
724 <div>
725 <h4>Callback function</h4>
726 <p style="display: none; ">
727 The callback <em>parameter</em> should specify a function
728 that looks like this:
729 </p>
730 <p>
731 If you specify the <em>callback</em> parameter, it should
732 specify a function that looks like this:
733 </p>
734
735 <!-- Note: intentionally longer 80 columns -->
736 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
737 <dl>
738 <div style="display: none; ">
739 <div>
740 </div>
741 </div>
742 </dl>
743 </div>
744 </div>
745
746 <!-- MIN_VERSION -->
747 <p style="display: none; ">
748 This function was added in version <b><span></span></b>.
749 If you require this function, the manifest key
750 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
751 can ensure that your extension won't be run in an earlier brow ser version.
752 </p>
753 </div> <!-- /description -->
754
755 </div><div class="apiItem">
756 <a name="method-stop"></a> <!-- method-anchor -->
757 <h4>stop</h4>
758
759 <div class="summary"><span style="display: none; ">void</span>
760 <!-- Note: intentionally longer 80 columns -->
761 <span>chrome.experimental.speechInput.stop</span>(<span class= "optional"><span style="display: none; ">, </span><span>function</span>
762 <var><span>callback</span></var></span>)</div>
763
764 <div class="description">
765 <p class="todo" style="display: none; ">Undocumented.</p>
766 <p>Request to stop an ongoing speech recognition session.</p>
767
768 <!-- PARAMETERS -->
769 <h4>Parameters</h4>
770 <dl>
771 <div>
772 <div>
773 <dt>
774 <var>callback</var>
775 <em>
776
777 <!-- TYPE -->
778 <div style="display:inline">
779 (
780 <span class="optional">optional</span>
781 <span class="enum" style="display: none; ">enumerated</span>
782 <span id="typeTemplate">
783 <span style="display: none; ">
784 <a> Type</a>
785 </span>
786 <span>
787 <span style="display: none; ">
788 array of <span><span></span></span>
789 </span>
790 <span>function</span>
791 <span style="display: none; "></span>
792 </span>
793 </span>
794 )
795 </div>
796
797 </em>
798 </dt>
799 <dd class="todo" style="display: none; ">
800 Undocumented.
801 </dd>
802 <dd>Called when the audio recording has stopped and any pending recogn ition results have been completed.</dd>
803 <dd style="display: none; ">
804 This parameter was added in version
805 <b><span></span></b>.
806 You must omit this parameter in earlier versions,
807 and you may omit it in any version. If you require this
808 parameter, the manifest key
809 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
810 can ensure that your extension won't be run in an earlier browser ve rsion.
811 </dd>
812
813 <!-- OBJECT PROPERTIES -->
814 <dd style="display: none; ">
815 <dl>
816 <div>
817 <div>
818 </div>
819 </div>
820 </dl>
821 </dd>
822
823 <!-- OBJECT METHODS -->
824 <dd style="display: none; ">
825 <div></div>
826 </dd>
827
828 <!-- OBJECT EVENT FIELDS -->
829 <dd style="display: none; ">
830 <div></div>
831 </dd>
832
833 <!-- FUNCTION PARAMETERS -->
834 <dd style="display: none; ">
835 <div></div>
836 </dd>
837
838 </div>
839 </div>
840 </dl>
841
842 <!-- RETURNS -->
843 <h4 style="display: none; ">Returns</h4>
844 <dl>
845 <div style="display: none; ">
846 <div>
847 </div>
848 </div>
849 </dl>
850
851 <!-- CALLBACK -->
852 <div>
853 <div>
854 <h4>Callback function</h4>
855 <p style="display: none; ">
856 The callback <em>parameter</em> should specify a function
857 that looks like this:
858 </p>
859 <p>
860 If you specify the <em>callback</em> parameter, it should
861 specify a function that looks like this:
862 </p>
863
864 <!-- Note: intentionally longer 80 columns -->
865 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
866 <dl>
867 <div style="display: none; ">
868 <div>
869 </div>
870 </div>
871 </dl>
872 </div>
873 </div>
874
875 <!-- MIN_VERSION -->
876 <p style="display: none; ">
877 This function was added in version <b><span></span></b>.
878 If you require this function, the manifest key
879 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
880 can ensure that your extension won't be run in an earlier brow ser version.
881 </p>
882 </div> <!-- /description -->
883
884 </div> <!-- /apiItem -->
885
886 </div> <!-- /apiGroup -->
887
888 <!-- EVENTS -->
889 <div id="eventsTemplate" class="apiGroup">
890 <a name="global-events"></a>
891 <h3>Events</h3>
892 <!-- iterates over all events -->
893 <div class="apiItem">
894 <a name="event-onError"></a>
895 <h4>onError</h4>
896
897 <div class="summary">
898 <!-- Note: intentionally longer 80 columns -->
899 <span class="subdued">chrome.experimental.speechInput.</span><sp an>onError</span><span class="subdued">.addListener</span>(function(<span>Error error</span>) <span class="subdued">{...}</span><span></span>);
900 </div>
901
902 <div class="description">
903 <p class="todo" style="display: none; ">Undocumented.</p>
904 <p>Called in case of an error in speech recognition.</p>
905
906 <!-- LISTENER PARAMETERS -->
907 <div>
908 <h4>Listener parameters</h4>
909 <dl>
910 <div>
911 <div>
912 <dt>
913 <var>error</var>
914 <em>
915
916 <!-- TYPE -->
917 <div style="display:inline">
918 (
919 <span class="optional" style="display: none; ">optional</spa n>
920 <span class="enum" style="display: none; ">enumerated</span>
921 <span id="typeTemplate">
922 <span>
923 <a href="experimental.speechInput.html#type-Error">Error </a>
924 </span>
925 <span style="display: none; ">
926 <span>
927 array of <span><span></span></span>
928 </span>
929 <span>paramType</span>
930 <span></span>
931 </span>
932 </span>
933 )
934 </div>
935
936 </em>
937 </dt>
938 <dd class="todo" style="display: none; ">
939 Undocumented.
940 </dd>
941 <dd>Error being reported.</dd>
942 <dd style="display: none; ">
943 This parameter was added in version
944 <b><span></span></b>.
945 You must omit this parameter in earlier versions,
946 and you may omit it in any version. If you require this
947 parameter, the manifest key
948 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
949 can ensure that your extension won't be run in an earlier browser ve rsion.
950 </dd>
951
952 <!-- OBJECT PROPERTIES -->
953 <dd style="display: none; ">
954 <dl>
955 <div>
956 <div>
957 </div>
958 </div>
959 </dl>
960 </dd>
961
962 <!-- OBJECT METHODS -->
963 <dd style="display: none; ">
964 <div></div>
965 </dd>
966
967 <!-- OBJECT EVENT FIELDS -->
968 <dd style="display: none; ">
969 <div></div>
970 </dd>
971
972 <!-- FUNCTION PARAMETERS -->
973 <dd style="display: none; ">
974 <div></div>
975 </dd>
976
977 </div>
978 </div>
979 </dl>
980 </div>
981
982 <!-- EXTRA PARAMETERS -->
983 <div style="display: none; ">
984 <h4>Extra parameters to addListener</h4>
985 <dl>
986 <div>
987 <div>
988 </div>
989 </div>
990 </dl>
991 </div>
992
993 <!-- LISTENER RETURN VALUE -->
994 <h4 style="display: none; ">Listener returns</h4>
995 <dl>
996 <div style="display: none; ">
997 <div>
998 </div>
999 </div>
1000 </dl>
1001
1002 </div> <!-- /description -->
1003 </div><div class="apiItem">
1004 <a name="event-onResult"></a>
1005 <h4>onResult</h4>
1006
1007 <div class="summary">
1008 <!-- Note: intentionally longer 80 columns -->
1009 <span class="subdued">chrome.experimental.speechInput.</span><sp an>onResult</span><span class="subdued">.addListener</span>(function(<span>Speec hResultEvent event</span>) <span class="subdued">{...}</span><span></span>);
1010 </div>
1011
1012 <div class="description">
1013 <p class="todo" style="display: none; ">Undocumented.</p>
1014 <p>Called when speech recognition results are available.</p>
1015
1016 <!-- LISTENER PARAMETERS -->
1017 <div>
1018 <h4>Listener parameters</h4>
1019 <dl>
1020 <div>
1021 <div>
1022 <dt>
1023 <var>event</var>
1024 <em>
1025
1026 <!-- TYPE -->
1027 <div style="display:inline">
1028 (
1029 <span class="optional" style="display: none; ">optional</spa n>
1030 <span class="enum" style="display: none; ">enumerated</span>
1031 <span id="typeTemplate">
1032 <span>
1033 <a href="experimental.speechInput.html#type-SpeechResult Event">SpeechResultEvent</a>
1034 </span>
1035 <span style="display: none; ">
1036 <span>
1037 array of <span><span></span></span>
1038 </span>
1039 <span>paramType</span>
1040 <span></span>
1041 </span>
1042 </span>
1043 )
1044 </div>
1045
1046 </em>
1047 </dt>
1048 <dd class="todo" style="display: none; ">
1049 Undocumented.
1050 </dd>
1051 <dd>Object containing the speech recognition results.</dd>
1052 <dd style="display: none; ">
1053 This parameter was added in version
1054 <b><span></span></b>.
1055 You must omit this parameter in earlier versions,
1056 and you may omit it in any version. If you require this
1057 parameter, the manifest key
1058 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1059 can ensure that your extension won't be run in an earlier browser ve rsion.
1060 </dd>
1061
1062 <!-- OBJECT PROPERTIES -->
1063 <dd style="display: none; ">
1064 <dl>
1065 <div>
1066 <div>
1067 </div>
1068 </div>
1069 </dl>
1070 </dd>
1071
1072 <!-- OBJECT METHODS -->
1073 <dd style="display: none; ">
1074 <div></div>
1075 </dd>
1076
1077 <!-- OBJECT EVENT FIELDS -->
1078 <dd style="display: none; ">
1079 <div></div>
1080 </dd>
1081
1082 <!-- FUNCTION PARAMETERS -->
1083 <dd style="display: none; ">
1084 <div></div>
1085 </dd>
1086
1087 </div>
1088 </div>
1089 </dl>
1090 </div>
1091
1092 <!-- EXTRA PARAMETERS -->
1093 <div style="display: none; ">
1094 <h4>Extra parameters to addListener</h4>
1095 <dl>
1096 <div>
1097 <div>
1098 </div>
1099 </div>
1100 </dl>
1101 </div>
1102
1103 <!-- LISTENER RETURN VALUE -->
1104 <h4 style="display: none; ">Listener returns</h4>
1105 <dl>
1106 <div style="display: none; ">
1107 <div>
1108 </div>
1109 </div>
1110 </dl>
1111
1112 </div> <!-- /description -->
1113 </div><div class="apiItem">
1114 <a name="event-onSoundEnd"></a>
1115 <h4>onSoundEnd</h4>
1116
1117 <div class="summary">
1118 <!-- Note: intentionally longer 80 columns -->
1119 <span class="subdued">chrome.experimental.speechInput.</span><sp an>onSoundEnd</span><span class="subdued">.addListener</span>(function(<span></s pan>) <span class="subdued">{...}</span><span></span>);
1120 </div>
1121
1122 <div class="description">
1123 <p class="todo" style="display: none; ">Undocumented.</p>
1124 <p>Called when the system detects enough silence to consider the ongoing input has ended.</p>
1125
1126 <!-- LISTENER PARAMETERS -->
1127 <div style="display: none; ">
1128 <h4>Listener parameters</h4>
1129 <dl>
1130 <div>
1131 <div>
1132 </div>
1133 </div>
1134 </dl>
1135 </div>
1136
1137 <!-- EXTRA PARAMETERS -->
1138 <div style="display: none; ">
1139 <h4>Extra parameters to addListener</h4>
1140 <dl>
1141 <div>
1142 <div>
1143 </div>
1144 </div>
1145 </dl>
1146 </div>
1147
1148 <!-- LISTENER RETURN VALUE -->
1149 <h4 style="display: none; ">Listener returns</h4>
1150 <dl>
1151 <div style="display: none; ">
1152 <div>
1153 </div>
1154 </div>
1155 </dl>
1156
1157 </div> <!-- /description -->
1158 </div><div class="apiItem">
1159 <a name="event-onSoundStart"></a>
1160 <h4>onSoundStart</h4>
1161
1162 <div class="summary">
1163 <!-- Note: intentionally longer 80 columns -->
1164 <span class="subdued">chrome.experimental.speechInput.</span><sp an>onSoundStart</span><span class="subdued">.addListener</span>(function(<span>< /span>) <span class="subdued">{...}</span><span></span>);
1165 </div>
1166
1167 <div class="description">
1168 <p class="todo" style="display: none; ">Undocumented.</p>
1169 <p>Called when the system starts detecting sound in the input da ta.</p>
1170
1171 <!-- LISTENER PARAMETERS -->
1172 <div style="display: none; ">
1173 <h4>Listener parameters</h4>
1174 <dl>
1175 <div>
1176 <div>
1177 </div>
1178 </div>
1179 </dl>
1180 </div>
1181
1182 <!-- EXTRA PARAMETERS -->
1183 <div style="display: none; ">
1184 <h4>Extra parameters to addListener</h4>
1185 <dl>
1186 <div>
1187 <div>
1188 </div>
1189 </div>
1190 </dl>
1191 </div>
1192
1193 <!-- LISTENER RETURN VALUE -->
1194 <h4 style="display: none; ">Listener returns</h4>
1195 <dl>
1196 <div style="display: none; ">
1197 <div>
1198 </div>
1199 </div>
1200 </dl>
1201
1202 </div> <!-- /description -->
1203 </div> <!-- /apiItem -->
1204
1205 </div> <!-- /apiGroup -->
1206
1207 <!-- TYPES -->
1208 <div class="apiGroup">
1209 <a name="types"></a>
1210 <h3 id="types">Types</h3>
1211
1212 <!-- iterates over all types -->
1213 <div class="apiItem">
1214 <a name="type-StartOptions"></a>
1215 <h4>StartOptions</h4>
1216
1217 <div>
1218 <dt>
1219 <var style="display: none; ">paramName</var>
1220 <em>
1221
1222 <!-- TYPE -->
1223 <div style="display:inline">
1224 (
1225 <span class="optional" style="display: none; ">optional</spa n>
1226 <span class="enum" style="display: none; ">enumerated</span>
1227 <span id="typeTemplate">
1228 <span style="display: none; ">
1229 <a> Type</a>
1230 </span>
1231 <span>
1232 <span style="display: none; ">
1233 array of <span><span></span></span>
1234 </span>
1235 <span>object</span>
1236 <span style="display: none; "></span>
1237 </span>
1238 </span>
1239 )
1240 </div>
1241
1242 </em>
1243 </dt>
1244 <dd class="todo" style="display: none; ">
1245 Undocumented.
1246 </dd>
1247 <dd>Object describing the options used for speech recognition.</dd>
1248 <dd style="display: none; ">
1249 This parameter was added in version
1250 <b><span></span></b>.
1251 You must omit this parameter in earlier versions,
1252 and you may omit it in any version. If you require this
1253 parameter, the manifest key
1254 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1255 can ensure that your extension won't be run in an earlier browser ve rsion.
1256 </dd>
1257
1258 <!-- OBJECT PROPERTIES -->
1259 <dd>
1260 <dl>
1261 <div>
1262 <div>
1263 <dt>
1264 <var>language</var>
1265 <em>
1266
1267 <!-- TYPE -->
1268 <div style="display:inline">
1269 (
1270 <span class="optional">optional</span>
1271 <span class="enum" style="display: none; ">enumerated</span>
1272 <span id="typeTemplate">
1273 <span style="display: none; ">
1274 <a> Type</a>
1275 </span>
1276 <span>
1277 <span style="display: none; ">
1278 array of <span><span></span></span>
1279 </span>
1280 <span>string</span>
1281 <span style="display: none; "></span>
1282 </span>
1283 </span>
1284 )
1285 </div>
1286
1287 </em>
1288 </dt>
1289 <dd class="todo" style="display: none; ">
1290 Undocumented.
1291 </dd>
1292 <dd>BCP-47 language code of the language to recognize. When set to 'au to' or not defined defaults to user's most preferred content language. Will use 'en-US' if not supported or invalid.</dd>
1293 <dd style="display: none; ">
1294 This parameter was added in version
1295 <b><span></span></b>.
1296 You must omit this parameter in earlier versions,
1297 and you may omit it in any version. If you require this
1298 parameter, the manifest key
1299 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1300 can ensure that your extension won't be run in an earlier browser ve rsion.
1301 </dd>
1302
1303 <!-- OBJECT PROPERTIES -->
1304 <dd style="display: none; ">
1305 <dl>
1306 <div>
1307 <div>
1308 </div>
1309 </div>
1310 </dl>
1311 </dd>
1312
1313 <!-- OBJECT METHODS -->
1314 <dd style="display: none; ">
1315 <div></div>
1316 </dd>
1317
1318 <!-- OBJECT EVENT FIELDS -->
1319 <dd style="display: none; ">
1320 <div></div>
1321 </dd>
1322
1323 <!-- FUNCTION PARAMETERS -->
1324 <dd style="display: none; ">
1325 <div></div>
1326 </dd>
1327
1328 </div>
1329 </div><div>
1330 <div>
1331 <dt>
1332 <var>grammar</var>
1333 <em>
1334
1335 <!-- TYPE -->
1336 <div style="display:inline">
1337 (
1338 <span class="optional">optional</span>
1339 <span class="enum" style="display: none; ">enumerated</span>
1340 <span id="typeTemplate">
1341 <span style="display: none; ">
1342 <a> Type</a>
1343 </span>
1344 <span>
1345 <span style="display: none; ">
1346 array of <span><span></span></span>
1347 </span>
1348 <span>string</span>
1349 <span style="display: none; "></span>
1350 </span>
1351 </span>
1352 )
1353 </div>
1354
1355 </em>
1356 </dt>
1357 <dd class="todo" style="display: none; ">
1358 Undocumented.
1359 </dd>
1360 <dd>Name of the grammar to use. Defaults to 'builtin:search'.</dd>
1361 <dd style="display: none; ">
1362 This parameter was added in version
1363 <b><span></span></b>.
1364 You must omit this parameter in earlier versions,
1365 and you may omit it in any version. If you require this
1366 parameter, the manifest key
1367 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1368 can ensure that your extension won't be run in an earlier browser ve rsion.
1369 </dd>
1370
1371 <!-- OBJECT PROPERTIES -->
1372 <dd style="display: none; ">
1373 <dl>
1374 <div>
1375 <div>
1376 </div>
1377 </div>
1378 </dl>
1379 </dd>
1380
1381 <!-- OBJECT METHODS -->
1382 <dd style="display: none; ">
1383 <div></div>
1384 </dd>
1385
1386 <!-- OBJECT EVENT FIELDS -->
1387 <dd style="display: none; ">
1388 <div></div>
1389 </dd>
1390
1391 <!-- FUNCTION PARAMETERS -->
1392 <dd style="display: none; ">
1393 <div></div>
1394 </dd>
1395
1396 </div>
1397 </div><div>
1398 <div>
1399 <dt>
1400 <var>filterProfanities</var>
1401 <em>
1402
1403 <!-- TYPE -->
1404 <div style="display:inline">
1405 (
1406 <span class="optional">optional</span>
1407 <span class="enum" style="display: none; ">enumerated</span>
1408 <span id="typeTemplate">
1409 <span style="display: none; ">
1410 <a> Type</a>
1411 </span>
1412 <span>
1413 <span style="display: none; ">
1414 array of <span><span></span></span>
1415 </span>
1416 <span>boolean</span>
1417 <span style="display: none; "></span>
1418 </span>
1419 </span>
1420 )
1421 </div>
1422
1423 </em>
1424 </dt>
1425 <dd class="todo" style="display: none; ">
1426 Undocumented.
1427 </dd>
1428 <dd>Enable or disable profanity filtering. Will use the default Chrome filtering settings if not provided.</dd>
1429 <dd style="display: none; ">
1430 This parameter was added in version
1431 <b><span></span></b>.
1432 You must omit this parameter in earlier versions,
1433 and you may omit it in any version. If you require this
1434 parameter, the manifest key
1435 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1436 can ensure that your extension won't be run in an earlier browser ve rsion.
1437 </dd>
1438
1439 <!-- OBJECT PROPERTIES -->
1440 <dd style="display: none; ">
1441 <dl>
1442 <div>
1443 <div>
1444 </div>
1445 </div>
1446 </dl>
1447 </dd>
1448
1449 <!-- OBJECT METHODS -->
1450 <dd style="display: none; ">
1451 <div></div>
1452 </dd>
1453
1454 <!-- OBJECT EVENT FIELDS -->
1455 <dd style="display: none; ">
1456 <div></div>
1457 </dd>
1458
1459 <!-- FUNCTION PARAMETERS -->
1460 <dd style="display: none; ">
1461 <div></div>
1462 </dd>
1463
1464 </div>
1465 </div>
1466 </dl>
1467 </dd>
1468
1469 <!-- OBJECT METHODS -->
1470 <dd style="display: none; ">
1471 <div></div>
1472 </dd>
1473
1474 <!-- OBJECT EVENT FIELDS -->
1475 <dd style="display: none; ">
1476 <div></div>
1477 </dd>
1478
1479 <!-- FUNCTION PARAMETERS -->
1480 <dd style="display: none; ">
1481 <div></div>
1482 </dd>
1483
1484 </div>
1485
1486 </div><div class="apiItem">
1487 <a name="type-Error"></a>
1488 <h4>Error</h4>
1489
1490 <div>
1491 <dt>
1492 <var style="display: none; ">paramName</var>
1493 <em>
1494
1495 <!-- TYPE -->
1496 <div style="display:inline">
1497 (
1498 <span class="optional" style="display: none; ">optional</spa n>
1499 <span class="enum" style="display: none; ">enumerated</span>
1500 <span id="typeTemplate">
1501 <span style="display: none; ">
1502 <a> Type</a>
1503 </span>
1504 <span>
1505 <span style="display: none; ">
1506 array of <span><span></span></span>
1507 </span>
1508 <span>object</span>
1509 <span style="display: none; "></span>
1510 </span>
1511 </span>
1512 )
1513 </div>
1514
1515 </em>
1516 </dt>
1517 <dd class="todo" style="display: none; ">
1518 Undocumented.
1519 </dd>
1520 <dd>Object describing a speech input error.</dd>
1521 <dd style="display: none; ">
1522 This parameter was added in version
1523 <b><span></span></b>.
1524 You must omit this parameter in earlier versions,
1525 and you may omit it in any version. If you require this
1526 parameter, the manifest key
1527 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1528 can ensure that your extension won't be run in an earlier browser ve rsion.
1529 </dd>
1530
1531 <!-- OBJECT PROPERTIES -->
1532 <dd>
1533 <dl>
1534 <div>
1535 <div>
1536 <dt>
1537 <var>code</var>
1538 <em>
1539
1540 <!-- TYPE -->
1541 <div style="display:inline">
1542 (
1543 <span class="optional" style="display: none; ">optional</spa n>
1544 <span class="enum">enumerated</span>
1545 <span id="typeTemplate">
1546 <span style="display: none; ">
1547 <a> Type</a>
1548 </span>
1549 <span>
1550 <span style="display: none; ">
1551 array of <span><span></span></span>
1552 </span>
1553 <span>string</span>
1554 <span>["noDevicesAvailable", "unableToStart", "noSpeechH eard", "noResults", "captureError", "networkError", "internalError", "requestDen ied"]</span>
1555 </span>
1556 </span>
1557 )
1558 </div>
1559
1560 </em>
1561 </dt>
1562 <dd class="todo" style="display: none; ">
1563 Undocumented.
1564 </dd>
1565 <dd>Code identifying the error case.</dd>
1566 <dd style="display: none; ">
1567 This parameter was added in version
1568 <b><span></span></b>.
1569 You must omit this parameter in earlier versions,
1570 and you may omit it in any version. If you require this
1571 parameter, the manifest key
1572 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1573 can ensure that your extension won't be run in an earlier browser ve rsion.
1574 </dd>
1575
1576 <!-- OBJECT PROPERTIES -->
1577 <dd style="display: none; ">
1578 <dl>
1579 <div>
1580 <div>
1581 </div>
1582 </div>
1583 </dl>
1584 </dd>
1585
1586 <!-- OBJECT METHODS -->
1587 <dd style="display: none; ">
1588 <div></div>
1589 </dd>
1590
1591 <!-- OBJECT EVENT FIELDS -->
1592 <dd style="display: none; ">
1593 <div></div>
1594 </dd>
1595
1596 <!-- FUNCTION PARAMETERS -->
1597 <dd style="display: none; ">
1598 <div></div>
1599 </dd>
1600
1601 </div>
1602 </div>
1603 </dl>
1604 </dd>
1605
1606 <!-- OBJECT METHODS -->
1607 <dd style="display: none; ">
1608 <div></div>
1609 </dd>
1610
1611 <!-- OBJECT EVENT FIELDS -->
1612 <dd style="display: none; ">
1613 <div></div>
1614 </dd>
1615
1616 <!-- FUNCTION PARAMETERS -->
1617 <dd style="display: none; ">
1618 <div></div>
1619 </dd>
1620
1621 </div>
1622
1623 </div><div class="apiItem">
1624 <a name="type-ResultHypothesis"></a>
1625 <h4>ResultHypothesis</h4>
1626
1627 <div>
1628 <dt>
1629 <var style="display: none; ">paramName</var>
1630 <em>
1631
1632 <!-- TYPE -->
1633 <div style="display:inline">
1634 (
1635 <span class="optional" style="display: none; ">optional</spa n>
1636 <span class="enum" style="display: none; ">enumerated</span>
1637 <span id="typeTemplate">
1638 <span style="display: none; ">
1639 <a> Type</a>
1640 </span>
1641 <span>
1642 <span style="display: none; ">
1643 array of <span><span></span></span>
1644 </span>
1645 <span>object</span>
1646 <span style="display: none; "></span>
1647 </span>
1648 </span>
1649 )
1650 </div>
1651
1652 </em>
1653 </dt>
1654 <dd class="todo" style="display: none; ">
1655 Undocumented.
1656 </dd>
1657 <dd>Object describing a speech recognition hypothesis.</dd>
1658 <dd style="display: none; ">
1659 This parameter was added in version
1660 <b><span></span></b>.
1661 You must omit this parameter in earlier versions,
1662 and you may omit it in any version. If you require this
1663 parameter, the manifest key
1664 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1665 can ensure that your extension won't be run in an earlier browser ve rsion.
1666 </dd>
1667
1668 <!-- OBJECT PROPERTIES -->
1669 <dd>
1670 <dl>
1671 <div>
1672 <div>
1673 <dt>
1674 <var>utterance</var>
1675 <em>
1676
1677 <!-- TYPE -->
1678 <div style="display:inline">
1679 (
1680 <span class="optional" style="display: none; ">optional</spa n>
1681 <span class="enum" style="display: none; ">enumerated</span>
1682 <span id="typeTemplate">
1683 <span style="display: none; ">
1684 <a> Type</a>
1685 </span>
1686 <span>
1687 <span style="display: none; ">
1688 array of <span><span></span></span>
1689 </span>
1690 <span>string</span>
1691 <span style="display: none; "></span>
1692 </span>
1693 </span>
1694 )
1695 </div>
1696
1697 </em>
1698 </dt>
1699 <dd class="todo" style="display: none; ">
1700 Undocumented.
1701 </dd>
1702 <dd>Text of this hypothesis.</dd>
1703 <dd style="display: none; ">
1704 This parameter was added in version
1705 <b><span></span></b>.
1706 You must omit this parameter in earlier versions,
1707 and you may omit it in any version. If you require this
1708 parameter, the manifest key
1709 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1710 can ensure that your extension won't be run in an earlier browser ve rsion.
1711 </dd>
1712
1713 <!-- OBJECT PROPERTIES -->
1714 <dd style="display: none; ">
1715 <dl>
1716 <div>
1717 <div>
1718 </div>
1719 </div>
1720 </dl>
1721 </dd>
1722
1723 <!-- OBJECT METHODS -->
1724 <dd style="display: none; ">
1725 <div></div>
1726 </dd>
1727
1728 <!-- OBJECT EVENT FIELDS -->
1729 <dd style="display: none; ">
1730 <div></div>
1731 </dd>
1732
1733 <!-- FUNCTION PARAMETERS -->
1734 <dd style="display: none; ">
1735 <div></div>
1736 </dd>
1737
1738 </div>
1739 </div><div>
1740 <div>
1741 <dt>
1742 <var>confidence</var>
1743 <em>
1744
1745 <!-- TYPE -->
1746 <div style="display:inline">
1747 (
1748 <span class="optional" style="display: none; ">optional</spa n>
1749 <span class="enum" style="display: none; ">enumerated</span>
1750 <span id="typeTemplate">
1751 <span style="display: none; ">
1752 <a> Type</a>
1753 </span>
1754 <span>
1755 <span style="display: none; ">
1756 array of <span><span></span></span>
1757 </span>
1758 <span>number</span>
1759 <span style="display: none; "></span>
1760 </span>
1761 </span>
1762 )
1763 </div>
1764
1765 </em>
1766 </dt>
1767 <dd class="todo" style="display: none; ">
1768 Undocumented.
1769 </dd>
1770 <dd>Confidence of the hypothesis. Rated from 0 (lowest) to 1 (highest) .</dd>
1771 <dd style="display: none; ">
1772 This parameter was added in version
1773 <b><span></span></b>.
1774 You must omit this parameter in earlier versions,
1775 and you may omit it in any version. If you require this
1776 parameter, the manifest key
1777 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1778 can ensure that your extension won't be run in an earlier browser ve rsion.
1779 </dd>
1780
1781 <!-- OBJECT PROPERTIES -->
1782 <dd style="display: none; ">
1783 <dl>
1784 <div>
1785 <div>
1786 </div>
1787 </div>
1788 </dl>
1789 </dd>
1790
1791 <!-- OBJECT METHODS -->
1792 <dd style="display: none; ">
1793 <div></div>
1794 </dd>
1795
1796 <!-- OBJECT EVENT FIELDS -->
1797 <dd style="display: none; ">
1798 <div></div>
1799 </dd>
1800
1801 <!-- FUNCTION PARAMETERS -->
1802 <dd style="display: none; ">
1803 <div></div>
1804 </dd>
1805
1806 </div>
1807 </div>
1808 </dl>
1809 </dd>
1810
1811 <!-- OBJECT METHODS -->
1812 <dd style="display: none; ">
1813 <div></div>
1814 </dd>
1815
1816 <!-- OBJECT EVENT FIELDS -->
1817 <dd style="display: none; ">
1818 <div></div>
1819 </dd>
1820
1821 <!-- FUNCTION PARAMETERS -->
1822 <dd style="display: none; ">
1823 <div></div>
1824 </dd>
1825
1826 </div>
1827
1828 </div><div class="apiItem">
1829 <a name="type-SpeechResultEvent"></a>
1830 <h4>SpeechResultEvent</h4>
1831
1832 <div>
1833 <dt>
1834 <var style="display: none; ">paramName</var>
1835 <em>
1836
1837 <!-- TYPE -->
1838 <div style="display:inline">
1839 (
1840 <span class="optional" style="display: none; ">optional</spa n>
1841 <span class="enum" style="display: none; ">enumerated</span>
1842 <span id="typeTemplate">
1843 <span style="display: none; ">
1844 <a> Type</a>
1845 </span>
1846 <span>
1847 <span style="display: none; ">
1848 array of <span><span></span></span>
1849 </span>
1850 <span>object</span>
1851 <span style="display: none; "></span>
1852 </span>
1853 </span>
1854 )
1855 </div>
1856
1857 </em>
1858 </dt>
1859 <dd class="todo" style="display: none; ">
1860 Undocumented.
1861 </dd>
1862 <dd>Object containing the recognition results.</dd>
1863 <dd style="display: none; ">
1864 This parameter was added in version
1865 <b><span></span></b>.
1866 You must omit this parameter in earlier versions,
1867 and you may omit it in any version. If you require this
1868 parameter, the manifest key
1869 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1870 can ensure that your extension won't be run in an earlier browser ve rsion.
1871 </dd>
1872
1873 <!-- OBJECT PROPERTIES -->
1874 <dd>
1875 <dl>
1876 <div>
1877 <div>
1878 <dt>
1879 <var>hypotheses</var>
1880 <em>
1881
1882 <!-- TYPE -->
1883 <div style="display:inline">
1884 (
1885 <span class="optional">optional</span>
1886 <span class="enum" style="display: none; ">enumerated</span>
1887 <span id="typeTemplate">
1888 <span style="display: none; ">
1889 <a> Type</a>
1890 </span>
1891 <span>
1892 <span>
1893 array of <span><span>
1894 <span>
1895 <a href="experimental.speechInput.html#type-ResultHypoth esis">ResultHypothesis</a>
1896 </span>
1897 <span style="display: none; ">
1898 <span>
1899 array of <span><span></span></span>
1900 </span>
1901 <span>paramType</span>
1902 <span></span>
1903 </span>
1904 </span></span>
1905 </span>
1906 <span style="display: none; ">paramType</span>
1907 <span style="display: none; "></span>
1908 </span>
1909 </span>
1910 )
1911 </div>
1912
1913 </em>
1914 </dt>
1915 <dd class="todo" style="display: none; ">
1916 Undocumented.
1917 </dd>
1918 <dd>Array of zero or more objects describing the stable candidate hypo theses sorted by decreasing likelihood.</dd>
1919 <dd style="display: none; ">
1920 This parameter was added in version
1921 <b><span></span></b>.
1922 You must omit this parameter in earlier versions,
1923 and you may omit it in any version. If you require this
1924 parameter, the manifest key
1925 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1926 can ensure that your extension won't be run in an earlier browser ve rsion.
1927 </dd>
1928
1929 <!-- OBJECT PROPERTIES -->
1930 <dd style="display: none; ">
1931 <dl>
1932 <div>
1933 <div>
1934 </div>
1935 </div>
1936 </dl>
1937 </dd>
1938
1939 <!-- OBJECT METHODS -->
1940 <dd style="display: none; ">
1941 <div></div>
1942 </dd>
1943
1944 <!-- OBJECT EVENT FIELDS -->
1945 <dd style="display: none; ">
1946 <div></div>
1947 </dd>
1948
1949 <!-- FUNCTION PARAMETERS -->
1950 <dd style="display: none; ">
1951 <div></div>
1952 </dd>
1953
1954 </div>
1955 </div>
1956 </dl>
1957 </dd>
1958
1959 <!-- OBJECT METHODS -->
1960 <dd style="display: none; ">
1961 <div></div>
1962 </dd>
1963
1964 <!-- OBJECT EVENT FIELDS -->
1965 <dd style="display: none; ">
1966 <div></div>
1967 </dd>
1968
1969 <!-- FUNCTION PARAMETERS -->
1970 <dd style="display: none; ">
1971 <div></div>
1972 </dd>
1973
1974 </div>
1975
1976 </div> <!-- /apiItem -->
1977
1978 </div> <!-- /apiGroup -->
1979
1980 </div> <!-- /apiPage -->
1981 </div> <!-- /gc-pagecontent -->
1982 </div> <!-- /g-section -->
1983 </div> <!-- /codesiteContent -->
1984 <div id="gc-footer" --="">
1985 <div class="text">
1986 <p>
1987 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1988 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1989 Attribution 3.0 License</a>, and code samples are licensed under the
1990 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1991 </p>
1992 <p>
1993 ©2011 Google
1994 </p>
1995
1996 <!-- begin analytics -->
1997 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>
1998 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>
1999
2000 <script type="text/javascript">
2001 // chrome doc tracking
2002 try {
2003 var engdocs = _gat._getTracker("YT-10763712-2");
2004 engdocs._trackPageview();
2005 } catch(err) {}
2006
2007 // code.google.com site-wide tracking
2008 try {
2009 _uacct="UA-18071-1";
2010 _uanchor=1;
2011 _uff=0;
2012 urchinTracker();
2013 }
2014 catch(e) {/* urchinTracker not available. */}
2015 </script>
2016 <!-- end analytics -->
2017 </div>
2018 </div> <!-- /gc-footer -->
2019 </div> <!-- /gc-container -->
2020 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698