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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 7258007: Move the tts and ttsEngine APIs out of experimental, and give (Closed) Base URL: svn://chrome-svn/chrome/trunk/src/
Patch Set: '' Created 9 years, 5 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
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/experimental.ttsEngine.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
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.tts - Google Chrome Extensions - Google Code</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="idle.html">Idle</a></li>
203 <li><a href="i18n.html">Internationalization</a></li>
204 <li><a href="messaging.html">Message Passing</a></li>
205 <li><a href="npapi.html">NPAPI Plugins</a></li>
206 </ul>
207 </li>
208 <li>Finishing
209 <ul>
210 <li><a href="hosting.html">Hosting</a></li>
211 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
212 </ul>
213 </li>
214 </ul>
215 </li>
216 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
217 <li><h2><a href="tutorials.html">Tutorials</a></h2>
218 <ul>
219 <li><a href="tut_debugging.html">Debugging</a></li>
220 <li><a href="tut_analytics.html">Google Analytics</a></li>
221 <li><a href="tut_oauth.html">OAuth</a></li>
222 </ul>
223 </li>
224 <li><h2>Reference</h2>
225 <ul>
226 <li>Formats
227 <ul>
228 <li><a href="manifest.html">Manifest Files</a></li>
229 <li><a href="match_patterns.html">Match Patterns</a></li>
230 </ul>
231 </li>
232 <li><a href="permission_warnings.html">Permission Warnings</a></li >
233 <li><a href="api_index.html">chrome.* APIs</a></li>
234 <li><a href="api_other.html">Other APIs</a></li>
235 </ul>
236 </li>
237 <li><h2><a href="samples.html">Samples</a></h2></li>
238 <div class="line"> </div>
239 <li><h2>More</h2>
240 <ul>
241 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
242 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
243 <li><a href="themes.html">Themes</a></li>
244 </ul>
245 </li>
246 </ul>
247 </div>
248 <script>
249 initToggles();
250 </script>
251
252 <div class="g-unit" id="gc-pagecontent">
253 <div id="pageTitle">
254 <h1 class="page_title">chrome.experimental.tts</h1>
255 </div>
256 <!-- TABLE OF CONTENTS -->
257 <div id="toc">
258 <h2>Contents</h2>
259 <ol>
260 <li>
261 <a href="#overview">Overview</a>
262 <ol>
263 <li style="display: none; ">
264 <a>h3Name</a>
265 </li>
266 </ol>
267 </li><li>
268 <a href="#generating_speech">Generating speech</a>
269 <ol>
270 <li style="display: none; ">
271 <a>h3Name</a>
272 </li>
273 </ol>
274 </li><li>
275 <a href="#events">Listening to events</a>
276 <ol>
277 <li style="display: none; ">
278 <a>h3Name</a>
279 </li>
280 </ol>
281 </li><li>
282 <a href="#ssml">SSML markup</a>
283 <ol>
284 <li style="display: none; ">
285 <a>h3Name</a>
286 </li>
287 </ol>
288 </li><li>
289 <a href="#choosing_voice">Choosing a voice</a>
290 <ol>
291 <li style="display: none; ">
292 <a>h3Name</a>
293 </li>
294 </ol>
295 </li>
296 <li>
297 <a href="#apiReference">API reference: chrome.experimental.tts</ a>
298 <ol>
299 <li style="display: none; ">
300 <a href="#properties">Properties</a>
301 <ol>
302 <li>
303 <a href="#property-anchor">propertyName</a>
304 </li>
305 </ol>
306 </li>
307 <li>
308 <a href="#global-methods">Methods</a>
309 <ol>
310 <li>
311 <a href="#method-getVoices">getVoices</a>
312 </li><li>
313 <a href="#method-isSpeaking">isSpeaking</a>
314 </li><li>
315 <a href="#method-speak">speak</a>
316 </li><li>
317 <a href="#method-stop">stop</a>
318 </li>
319 </ol>
320 </li>
321 <li style="display: none; ">
322 <a>Events</a>
323 <ol>
324 <li>
325 <a href="#event-anchor">eventName</a>
326 </li>
327 </ol>
328 </li>
329 <li>
330 <a href="#types">Types</a>
331 <ol>
332 <li>
333 <a href="#type-TtsEvent">TtsEvent</a>
334 </li><li>
335 <a href="#type-TtsVoice">TtsVoice</a>
336 </li>
337 </ol>
338 </li>
339 </ol>
340 </li>
341 </ol>
342 </div>
343 <!-- /TABLE OF CONTENTS -->
344
345 <!-- Standard content lead-in for experimental API pages -->
346 <p id="classSummary">
347 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
348 </p>
349
350 <!-- STATIC CONTENT PLACEHOLDER -->
351 <div id="static"><p id="classSummary">
352 Use the <code>chrome.experimental.tts</code> module to play synthesized
353 text-to-speech (TTS) from your extension or packaged app.
354 See also the related
355 <a href="experimental.ttsEngine.html">experimental.ttsEngine</a>
356 module, which allows an extension to implement a speech engine.
357 </p>
358
359 <p class="note"><b>Give us feedback:</b> If you have suggestions,
360 especially changes that should be made before stabilizing the first
361 version of this API, please send your ideas to the
362 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions">chro mium-extensions</a>
363 group.</p>
364
365 <h2 id="overview">Overview</h2>
366
367 <p>To enable this experimental API, visit
368 <b>chrome://flags</b> and enable <b>Experimental Extension APIs</b>.
369
370 </p><p>Chrome provides native support for speech on Windows (using SAPI
371 5), Mac OS X, and Chrome OS, using speech synthesis capabilities
372 provided by the operating system. On all platforms, the user can
373 install extensions that register themselves as alternative speech
374 engines.</p>
375
376 <h2 id="generating_speech">Generating speech</h2>
377
378 <p>Call <code>speak()</code> from your extension or
379 packaged app to speak. For example:</p>
380
381 <pre>chrome.experimental.tts.speak('Hello, world.');</pre>
382
383 <p>To stop speaking immediately, just call <code>stop()</code>:
384
385 </p><pre>chrome.experimental.tts.stop();</pre>
386
387 <p>You can provide options that control various properties of the speech,
388 such as its rate, pitch, and more. For example:</p>
389
390 <pre>chrome.experimental.tts.speak('Hello, world.', {'rate': 2.0});</pre>
391
392 <p>It's also a good idea to specify the language so that a synthesizer
393 supporting that language (and regional dialect, if applicable) is chosen.</p>
394
395 <pre>chrome.experimental.tts.speak(
396 'Hello, world.', {'lang': 'en-US', 'rate': 2.0});</pre>
397
398 <p>By default, each call to <code>speak()</code> interrupts any
399 ongoing speech and speaks immediately. To determine if a call would be
400 interrupting anything, you can call <code>isSpeaking()</code>. In
401 addition, you can use the <code>enqueue</code> option to cause this
402 utterance to be added to a queue of utterances that will be spoken
403 when the current utterance has finished.</p>
404
405 <pre>chrome.experimental.tts.speak(
406 'Speak this first.');
407 chrome.experimental.tts.speak(
408 'Speak this next, when the first sentence is done.', {'enqueue': true});
409 </pre>
410
411 <p>A complete description of all options can be found in the
412 <a href="#method-speak">speak() method documentation</a> below.
413 Not all speech engines will support all options.</p>
414
415 <p>To catch errors and make sure you're calling <code>speak()</code>
416 correctly, pass a callback function that takes no arguments. Inside
417 the callback, check
418 <a href="extension.html#property-lastError">chrome.extension.lastError</a>
419 to see if there were any errors.</p>
420
421 <pre>chrome.experimental.tts.speak(
422 utterance,
423 options,
424 function() {
425 if (chrome.extension.lastError) {
426 console.log('Error: ' + chrome.extension.lastError.message);
427 }
428 });</pre>
429
430 <p>The callback returns right away, before the engine has started
431 generating speech. The purpose of the callback is to alert you to
432 syntax errors in your use of the TTS API, not to catch all possible
433 errors that might occur in the process of synthesizing and outputting
434 speech. To catch these errors too, you need to use an event listener,
435 described below.</p>
436
437 <h2 id="events">Listening to events</h2>
438
439 <p>To get more real-time information about the status of synthesized speech,
440 pass an event listener in the options to <code>speak()</code>, like this:</p>
441
442 <pre>chrome.experimental.tts.speak(
443 utterance,
444 {
445 onEvent: function(event) {
446 console.log('Event ' + event.type ' at position ' + event.charIndex);
447 if (event.type == 'error') {
448 console.log('Error: ' + event.errorMessage);
449 }
450 }
451 },
452 callback);</pre>
453
454 <p>Each event includes an event type, the character index of the current
455 speech relative to the utterance, and for error events, an optional
456 error message. The event types are:</p>
457
458 <ul>
459 <li><code>'start'</code>: The engine has started speaking the utterance.
460 </li><li><code>'word'</code>: A word boundary was reached. Use
461 <code>event.charIndex</code> to determine the current speech
462 position.
463 </li><li><code>'sentence'</code>: A sentence boundary was reached. Use
464 <code>event.charIndex</code> to determine the current speech
465 position.
466 </li><li><code>'marker'</code>: An SSML marker was reached. Use
467 <code>event.charIndex</code> to determine the current speech
468 position.
469 </li><li><code>'end'</code>: The engine has finished speaking the utterance.
470 </li><li><code>'interrupted'</code>: This utterance was interrupted by another
471 call to <code>speak()</code> or <code>stop()</code> and did not
472 finish.
473 </li><li><code>'cancelled'</code>: This utterance was queued, but then
474 cancelled by another call to <code>speak()</code> or
475 <code>stop()</code> and never began to speak at all.
476 </li><li><code>'error'</code>: An engine-specific error occurred and
477 this utterance cannot be spoken.
478 Check <code>event.errorMessage</code> for details.
479 </li></ul>
480
481 <p>Four of the event types—<code>'end'</code>, <code>'interrupted'</code>,
482 <code>'cancelled'</code>, and <code>'error'</code>—are <i>final</i>.
483 After one of those events is received, this utterance will no longer
484 speak and no new events from this utterance will be received.</p>
485
486 <p>Some voices may not support all event types, and some voices may not
487 send any events at all. If you do not want to use a voice unless it sends
488 certain events, pass the events you require in the
489 <code>requiredEventTypes</code> member of the options object, or use
490 <code>getVoices()</code> to choose a voice that meets your requirements.
491 Both are documented below.</p>
492
493 <h2 id="ssml">SSML markup</h2>
494
495 <p>Utterances used in this API may include markup using the
496 <a href="http://www.w3.org/TR/speech-synthesis">Speech Synthesis Markup
497 Language (SSML)</a>. If you use SSML, the first argument to
498 <code>speak()</code> should be a complete SSML document with an XML
499 header and a top-level <code>&lt;speak&gt;</code> tag, not a document
500 fragment.</p>
501
502 <p>For example:</p>
503
504 <pre>chrome.experimental.tts.speak(
505 '&lt;?xml version="1.0"?&gt;' +
506 '&lt;speak&gt;' +
507 ' The &lt;emphasis&gt;second&lt;/emphasis&gt; ' +
508 ' word of this sentence was emphasized.' +
509 '&lt;/speak&gt;');</pre>
510
511 <p>Not all speech engines will support all SSML tags, and some may not support
512 SSML at all, but all engines are required to ignore any SSML they don't
513 support and to still speak the underlying text.</p>
514
515 <h2 id="choosing_voice">Choosing a voice</h2>
516
517 <p>By default, Chrome chooses the most appropriate voice for each
518 utterance you want to speak, based on the language and gender. On most
519 Windows, Mac OS X, and Chrome OS systems, speech synthesis provided by
520 the operating system should be able to speak any text in at least one
521 language. Some users may have a variety of voices available, though,
522 from their operating system and from speech engines implemented by other
523 Chrome extensions. In those cases, you can implement custom code to choose
524 the appropriate voice, or to present the user with a list of choices.</p>
525
526 <p>To get a list of all voices, call <code>getVoices()</code> and pass it
527 a function that receives an array of <code>TtsVoice</code> objects as its
528 argument:</p>
529
530 <pre>chrome.experimental.tts.getVoices(
531 function(voices) {
532 for (var i = 0; i &lt; voices.length; i++) {
533 console.log('Voice ' + i + ':');
534 console.log(' name: ' + voices[i].voiceName);
535 console.log(' lang: ' + voices[i].lang);
536 console.log(' gender: ' + voices[i].gender);
537 console.log(' extension id: ' + voices[i].extensionId);
538 console.log(' event types: ' + voices[i].eventTypes);
539 }
540 });</pre>
541 </div>
542
543 <!-- API PAGE -->
544 <div class="apiPage">
545 <a name="apiReference"></a>
546 <h2>API reference: chrome.experimental.tts</h2>
547
548 <!-- PROPERTIES -->
549 <div class="apiGroup" style="display: none; ">
550 <a name="properties"></a>
551 <h3 id="properties">Properties</h3>
552
553 <div>
554 <a></a>
555 <h4>getLastError</h4>
556 <div class="summary">
557 <!-- Note: intentionally longer 80 columns -->
558 <span>chrome.extension</span><span>lastError</span>
559 </div>
560 <div>
561 </div>
562 </div>
563
564 </div> <!-- /apiGroup -->
565
566 <!-- METHODS -->
567 <div id="methodsTemplate" class="apiGroup">
568 <a name="global-methods"></a>
569 <h3>Methods</h3>
570
571 <!-- iterates over all functions -->
572 <div class="apiItem">
573 <a name="method-getVoices"></a> <!-- method-anchor -->
574 <h4>getVoices</h4>
575
576 <div class="summary"><span style="display: none; ">void</span>
577 <!-- Note: intentionally longer 80 columns -->
578 <span>chrome.experimental.tts.getVoices</span>(<span class="op tional"><span style="display: none; ">, </span><span>function</span>
579 <var><span>callback</span></var></span>)</div>
580
581 <div class="description">
582 <p class="todo" style="display: none; ">Undocumented.</p>
583 <p>Get an array of all available voices.</p>
584
585 <!-- PARAMETERS -->
586 <h4>Parameters</h4>
587 <dl>
588 <div>
589 <div>
590 <dt>
591 <var>callback</var>
592 <em>
593
594 <!-- TYPE -->
595 <div style="display:inline">
596 (
597 <span class="optional">optional</span>
598 <span class="enum" style="display: none; ">enumerated</span>
599 <span id="typeTemplate">
600 <span style="display: none; ">
601 <a> Type</a>
602 </span>
603 <span>
604 <span style="display: none; ">
605 array of <span><span></span></span>
606 </span>
607 <span>function</span>
608 <span style="display: none; "></span>
609 </span>
610 </span>
611 )
612 </div>
613
614 </em>
615 </dt>
616 <dd class="todo">
617 Undocumented.
618 </dd>
619 <dd style="display: none; ">
620 Description of this parameter from the json schema.
621 </dd>
622 <dd style="display: none; ">
623 This parameter was added in version
624 <b><span></span></b>.
625 You must omit this parameter in earlier versions,
626 and you may omit it in any version. If you require this
627 parameter, the manifest key
628 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
629 can ensure that your extension won't be run in an earlier browser ve rsion.
630 </dd>
631
632 <!-- OBJECT PROPERTIES -->
633 <dd style="display: none; ">
634 <dl>
635 <div>
636 <div>
637 </div>
638 </div>
639 </dl>
640 </dd>
641
642 <!-- OBJECT METHODS -->
643 <dd style="display: none; ">
644 <div></div>
645 </dd>
646
647 <!-- OBJECT EVENT FIELDS -->
648 <dd style="display: none; ">
649 <div></div>
650 </dd>
651
652 <!-- FUNCTION PARAMETERS -->
653 <dd style="display: none; ">
654 <div></div>
655 </dd>
656
657 </div>
658 </div>
659 </dl>
660
661 <!-- RETURNS -->
662 <h4 style="display: none; ">Returns</h4>
663 <dl>
664 <div style="display: none; ">
665 <div>
666 </div>
667 </div>
668 </dl>
669
670 <!-- CALLBACK -->
671 <div>
672 <div>
673 <h4>Callback function</h4>
674 <p style="display: none; ">
675 The callback <em>parameter</em> should specify a function
676 that looks like this:
677 </p>
678 <p>
679 If you specify the <em>callback</em> parameter, it should
680 specify a function that looks like this:
681 </p>
682
683 <!-- Note: intentionally longer 80 columns -->
684 <pre>function(<span>array of TtsVoice voices</span>) <span cla ss="subdued">{...}</span>;</pre>
685 <dl>
686 <div>
687 <div>
688 <dt>
689 <var>voices</var>
690 <em>
691
692 <!-- TYPE -->
693 <div style="display:inline">
694 (
695 <span class="optional" style="display: none; ">optional</spa n>
696 <span class="enum" style="display: none; ">enumerated</span>
697 <span id="typeTemplate">
698 <span style="display: none; ">
699 <a> Type</a>
700 </span>
701 <span>
702 <span>
703 array of <span><span>
704 <span>
705 <a href="experimental.tts.html#type-TtsVoice">TtsVoice</ a>
706 </span>
707 <span style="display: none; ">
708 <span>
709 array of <span><span></span></span>
710 </span>
711 <span>paramType</span>
712 <span></span>
713 </span>
714 </span></span>
715 </span>
716 <span style="display: none; ">paramType</span>
717 <span style="display: none; "></span>
718 </span>
719 </span>
720 )
721 </div>
722
723 </em>
724 </dt>
725 <dd class="todo" style="display: none; ">
726 Undocumented.
727 </dd>
728 <dd>Array of <a href="experimental.tts.html#type-TtsVoice">TtsVoice</a > objects representing the available voices for speech synthesis.</dd>
729 <dd style="display: none; ">
730 This parameter was added in version
731 <b><span></span></b>.
732 You must omit this parameter in earlier versions,
733 and you may omit it in any version. If you require this
734 parameter, the manifest key
735 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
736 can ensure that your extension won't be run in an earlier browser ve rsion.
737 </dd>
738
739 <!-- OBJECT PROPERTIES -->
740 <dd style="display: none; ">
741 <dl>
742 <div>
743 <div>
744 </div>
745 </div>
746 </dl>
747 </dd>
748
749 <!-- OBJECT METHODS -->
750 <dd style="display: none; ">
751 <div></div>
752 </dd>
753
754 <!-- OBJECT EVENT FIELDS -->
755 <dd style="display: none; ">
756 <div></div>
757 </dd>
758
759 <!-- FUNCTION PARAMETERS -->
760 <dd style="display: none; ">
761 <div></div>
762 </dd>
763
764 </div>
765 </div>
766 </dl>
767 </div>
768 </div>
769
770 <!-- MIN_VERSION -->
771 <p style="display: none; ">
772 This function was added in version <b><span></span></b>.
773 If you require this function, the manifest key
774 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
775 can ensure that your extension won't be run in an earlier brow ser version.
776 </p>
777 </div> <!-- /description -->
778
779 </div><div class="apiItem">
780 <a name="method-isSpeaking"></a> <!-- method-anchor -->
781 <h4>isSpeaking</h4>
782
783 <div class="summary"><span style="display: none; ">void</span>
784 <!-- Note: intentionally longer 80 columns -->
785 <span>chrome.experimental.tts.isSpeaking</span>(<span class="o ptional"><span style="display: none; ">, </span><span>function</span>
786 <var><span>callback</span></var></span>)</div>
787
788 <div class="description">
789 <p class="todo" style="display: none; ">Undocumented.</p>
790 <p>Check if the engine is currently speaking.</p>
791
792 <!-- PARAMETERS -->
793 <h4>Parameters</h4>
794 <dl>
795 <div>
796 <div>
797 <dt>
798 <var>callback</var>
799 <em>
800
801 <!-- TYPE -->
802 <div style="display:inline">
803 (
804 <span class="optional">optional</span>
805 <span class="enum" style="display: none; ">enumerated</span>
806 <span id="typeTemplate">
807 <span style="display: none; ">
808 <a> Type</a>
809 </span>
810 <span>
811 <span style="display: none; ">
812 array of <span><span></span></span>
813 </span>
814 <span>function</span>
815 <span style="display: none; "></span>
816 </span>
817 </span>
818 )
819 </div>
820
821 </em>
822 </dt>
823 <dd class="todo">
824 Undocumented.
825 </dd>
826 <dd style="display: none; ">
827 Description of this parameter from the json schema.
828 </dd>
829 <dd style="display: none; ">
830 This parameter was added in version
831 <b><span></span></b>.
832 You must omit this parameter in earlier versions,
833 and you may omit it in any version. If you require this
834 parameter, the manifest key
835 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
836 can ensure that your extension won't be run in an earlier browser ve rsion.
837 </dd>
838
839 <!-- OBJECT PROPERTIES -->
840 <dd style="display: none; ">
841 <dl>
842 <div>
843 <div>
844 </div>
845 </div>
846 </dl>
847 </dd>
848
849 <!-- OBJECT METHODS -->
850 <dd style="display: none; ">
851 <div></div>
852 </dd>
853
854 <!-- OBJECT EVENT FIELDS -->
855 <dd style="display: none; ">
856 <div></div>
857 </dd>
858
859 <!-- FUNCTION PARAMETERS -->
860 <dd style="display: none; ">
861 <div></div>
862 </dd>
863
864 </div>
865 </div>
866 </dl>
867
868 <!-- RETURNS -->
869 <h4 style="display: none; ">Returns</h4>
870 <dl>
871 <div style="display: none; ">
872 <div>
873 </div>
874 </div>
875 </dl>
876
877 <!-- CALLBACK -->
878 <div>
879 <div>
880 <h4>Callback function</h4>
881 <p style="display: none; ">
882 The callback <em>parameter</em> should specify a function
883 that looks like this:
884 </p>
885 <p>
886 If you specify the <em>callback</em> parameter, it should
887 specify a function that looks like this:
888 </p>
889
890 <!-- Note: intentionally longer 80 columns -->
891 <pre>function(<span>boolean speaking</span>) <span class="subd ued">{...}</span>;</pre>
892 <dl>
893 <div>
894 <div>
895 <dt>
896 <var>speaking</var>
897 <em>
898
899 <!-- TYPE -->
900 <div style="display:inline">
901 (
902 <span class="optional" style="display: none; ">optional</spa n>
903 <span class="enum" style="display: none; ">enumerated</span>
904 <span id="typeTemplate">
905 <span style="display: none; ">
906 <a> Type</a>
907 </span>
908 <span>
909 <span style="display: none; ">
910 array of <span><span></span></span>
911 </span>
912 <span>boolean</span>
913 <span style="display: none; "></span>
914 </span>
915 </span>
916 )
917 </div>
918
919 </em>
920 </dt>
921 <dd class="todo" style="display: none; ">
922 Undocumented.
923 </dd>
924 <dd>True if speaking, false otherwise.</dd>
925 <dd style="display: none; ">
926 This parameter was added in version
927 <b><span></span></b>.
928 You must omit this parameter in earlier versions,
929 and you may omit it in any version. If you require this
930 parameter, the manifest key
931 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
932 can ensure that your extension won't be run in an earlier browser ve rsion.
933 </dd>
934
935 <!-- OBJECT PROPERTIES -->
936 <dd style="display: none; ">
937 <dl>
938 <div>
939 <div>
940 </div>
941 </div>
942 </dl>
943 </dd>
944
945 <!-- OBJECT METHODS -->
946 <dd style="display: none; ">
947 <div></div>
948 </dd>
949
950 <!-- OBJECT EVENT FIELDS -->
951 <dd style="display: none; ">
952 <div></div>
953 </dd>
954
955 <!-- FUNCTION PARAMETERS -->
956 <dd style="display: none; ">
957 <div></div>
958 </dd>
959
960 </div>
961 </div>
962 </dl>
963 </div>
964 </div>
965
966 <!-- MIN_VERSION -->
967 <p style="display: none; ">
968 This function was added in version <b><span></span></b>.
969 If you require this function, the manifest key
970 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
971 can ensure that your extension won't be run in an earlier brow ser version.
972 </p>
973 </div> <!-- /description -->
974
975 </div><div class="apiItem">
976 <a name="method-speak"></a> <!-- method-anchor -->
977 <h4>speak</h4>
978
979 <div class="summary"><span style="display: none; ">void</span>
980 <!-- Note: intentionally longer 80 columns -->
981 <span>chrome.experimental.tts.speak</span>(<span class="null"> <span style="display: none; ">, </span><span>string</span>
982 <var><span>utterance</span></var></span><span class="optio nal"><span>, </span><span>object</span>
983 <var><span>options</span></var></span><span class="optiona l"><span>, </span><span>function</span>
984 <var><span>callback</span></var></span>)</div>
985
986 <div class="description">
987 <p class="todo" style="display: none; ">Undocumented.</p>
988 <p>Speak text using a text-to-speech engine.</p>
989
990 <!-- PARAMETERS -->
991 <h4>Parameters</h4>
992 <dl>
993 <div>
994 <div>
995 <dt>
996 <var>utterance</var>
997 <em>
998
999 <!-- TYPE -->
1000 <div style="display:inline">
1001 (
1002 <span class="optional" style="display: none; ">optional</spa n>
1003 <span class="enum" style="display: none; ">enumerated</span>
1004 <span id="typeTemplate">
1005 <span style="display: none; ">
1006 <a> Type</a>
1007 </span>
1008 <span>
1009 <span style="display: none; ">
1010 array of <span><span></span></span>
1011 </span>
1012 <span>string</span>
1013 <span style="display: none; "></span>
1014 </span>
1015 </span>
1016 )
1017 </div>
1018
1019 </em>
1020 </dt>
1021 <dd class="todo" style="display: none; ">
1022 Undocumented.
1023 </dd>
1024 <dd>The text to speak, either plain text or a complete, well-formed SS ML document. Speech engines that do not support SSML will strip away the tags an d speak the text. The maximum length of the text is 32,768 characters.</dd>
1025 <dd style="display: none; ">
1026 This parameter was added in version
1027 <b><span></span></b>.
1028 You must omit this parameter in earlier versions,
1029 and you may omit it in any version. If you require this
1030 parameter, the manifest key
1031 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1032 can ensure that your extension won't be run in an earlier browser ve rsion.
1033 </dd>
1034
1035 <!-- OBJECT PROPERTIES -->
1036 <dd style="display: none; ">
1037 <dl>
1038 <div>
1039 <div>
1040 </div>
1041 </div>
1042 </dl>
1043 </dd>
1044
1045 <!-- OBJECT METHODS -->
1046 <dd style="display: none; ">
1047 <div></div>
1048 </dd>
1049
1050 <!-- OBJECT EVENT FIELDS -->
1051 <dd style="display: none; ">
1052 <div></div>
1053 </dd>
1054
1055 <!-- FUNCTION PARAMETERS -->
1056 <dd style="display: none; ">
1057 <div></div>
1058 </dd>
1059
1060 </div>
1061 </div><div>
1062 <div>
1063 <dt>
1064 <var>options</var>
1065 <em>
1066
1067 <!-- TYPE -->
1068 <div style="display:inline">
1069 (
1070 <span class="optional">optional</span>
1071 <span class="enum" style="display: none; ">enumerated</span>
1072 <span id="typeTemplate">
1073 <span style="display: none; ">
1074 <a> Type</a>
1075 </span>
1076 <span>
1077 <span style="display: none; ">
1078 array of <span><span></span></span>
1079 </span>
1080 <span>object</span>
1081 <span style="display: none; "></span>
1082 </span>
1083 </span>
1084 )
1085 </div>
1086
1087 </em>
1088 </dt>
1089 <dd class="todo" style="display: none; ">
1090 Undocumented.
1091 </dd>
1092 <dd>The speech options.</dd>
1093 <dd style="display: none; ">
1094 This parameter was added in version
1095 <b><span></span></b>.
1096 You must omit this parameter in earlier versions,
1097 and you may omit it in any version. If you require this
1098 parameter, the manifest key
1099 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1100 can ensure that your extension won't be run in an earlier browser ve rsion.
1101 </dd>
1102
1103 <!-- OBJECT PROPERTIES -->
1104 <dd>
1105 <dl>
1106 <div>
1107 <div>
1108 <dt>
1109 <var>enqueue</var>
1110 <em>
1111
1112 <!-- TYPE -->
1113 <div style="display:inline">
1114 (
1115 <span class="optional">optional</span>
1116 <span class="enum" style="display: none; ">enumerated</span>
1117 <span id="typeTemplate">
1118 <span style="display: none; ">
1119 <a> Type</a>
1120 </span>
1121 <span>
1122 <span style="display: none; ">
1123 array of <span><span></span></span>
1124 </span>
1125 <span>boolean</span>
1126 <span style="display: none; "></span>
1127 </span>
1128 </span>
1129 )
1130 </div>
1131
1132 </em>
1133 </dt>
1134 <dd class="todo" style="display: none; ">
1135 Undocumented.
1136 </dd>
1137 <dd>If true, enqueues this utterance if TTS is already in progress. If false (the default), interrupts any current speech and flushes the speech queue before speaking this new utterance.</dd>
1138 <dd style="display: none; ">
1139 This parameter was added in version
1140 <b><span></span></b>.
1141 You must omit this parameter in earlier versions,
1142 and you may omit it in any version. If you require this
1143 parameter, the manifest key
1144 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1145 can ensure that your extension won't be run in an earlier browser ve rsion.
1146 </dd>
1147
1148 <!-- OBJECT PROPERTIES -->
1149 <dd style="display: none; ">
1150 <dl>
1151 <div>
1152 <div>
1153 </div>
1154 </div>
1155 </dl>
1156 </dd>
1157
1158 <!-- OBJECT METHODS -->
1159 <dd style="display: none; ">
1160 <div></div>
1161 </dd>
1162
1163 <!-- OBJECT EVENT FIELDS -->
1164 <dd style="display: none; ">
1165 <div></div>
1166 </dd>
1167
1168 <!-- FUNCTION PARAMETERS -->
1169 <dd style="display: none; ">
1170 <div></div>
1171 </dd>
1172
1173 </div>
1174 </div><div>
1175 <div>
1176 <dt>
1177 <var>voiceName</var>
1178 <em>
1179
1180 <!-- TYPE -->
1181 <div style="display:inline">
1182 (
1183 <span class="optional">optional</span>
1184 <span class="enum" style="display: none; ">enumerated</span>
1185 <span id="typeTemplate">
1186 <span style="display: none; ">
1187 <a> Type</a>
1188 </span>
1189 <span>
1190 <span style="display: none; ">
1191 array of <span><span></span></span>
1192 </span>
1193 <span>string</span>
1194 <span style="display: none; "></span>
1195 </span>
1196 </span>
1197 )
1198 </div>
1199
1200 </em>
1201 </dt>
1202 <dd class="todo" style="display: none; ">
1203 Undocumented.
1204 </dd>
1205 <dd>The name of the voice to use for synthesis. If empty, uses any ava ilable voice.</dd>
1206 <dd style="display: none; ">
1207 This parameter was added in version
1208 <b><span></span></b>.
1209 You must omit this parameter in earlier versions,
1210 and you may omit it in any version. If you require this
1211 parameter, the manifest key
1212 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1213 can ensure that your extension won't be run in an earlier browser ve rsion.
1214 </dd>
1215
1216 <!-- OBJECT PROPERTIES -->
1217 <dd style="display: none; ">
1218 <dl>
1219 <div>
1220 <div>
1221 </div>
1222 </div>
1223 </dl>
1224 </dd>
1225
1226 <!-- OBJECT METHODS -->
1227 <dd style="display: none; ">
1228 <div></div>
1229 </dd>
1230
1231 <!-- OBJECT EVENT FIELDS -->
1232 <dd style="display: none; ">
1233 <div></div>
1234 </dd>
1235
1236 <!-- FUNCTION PARAMETERS -->
1237 <dd style="display: none; ">
1238 <div></div>
1239 </dd>
1240
1241 </div>
1242 </div><div>
1243 <div>
1244 <dt>
1245 <var>extensionId</var>
1246 <em>
1247
1248 <!-- TYPE -->
1249 <div style="display:inline">
1250 (
1251 <span class="optional">optional</span>
1252 <span class="enum" style="display: none; ">enumerated</span>
1253 <span id="typeTemplate">
1254 <span style="display: none; ">
1255 <a> Type</a>
1256 </span>
1257 <span>
1258 <span style="display: none; ">
1259 array of <span><span></span></span>
1260 </span>
1261 <span>string</span>
1262 <span style="display: none; "></span>
1263 </span>
1264 </span>
1265 )
1266 </div>
1267
1268 </em>
1269 </dt>
1270 <dd class="todo" style="display: none; ">
1271 Undocumented.
1272 </dd>
1273 <dd>The extension ID of the speech engine to use, if known.</dd>
1274 <dd style="display: none; ">
1275 This parameter was added in version
1276 <b><span></span></b>.
1277 You must omit this parameter in earlier versions,
1278 and you may omit it in any version. If you require this
1279 parameter, the manifest key
1280 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1281 can ensure that your extension won't be run in an earlier browser ve rsion.
1282 </dd>
1283
1284 <!-- OBJECT PROPERTIES -->
1285 <dd style="display: none; ">
1286 <dl>
1287 <div>
1288 <div>
1289 </div>
1290 </div>
1291 </dl>
1292 </dd>
1293
1294 <!-- OBJECT METHODS -->
1295 <dd style="display: none; ">
1296 <div></div>
1297 </dd>
1298
1299 <!-- OBJECT EVENT FIELDS -->
1300 <dd style="display: none; ">
1301 <div></div>
1302 </dd>
1303
1304 <!-- FUNCTION PARAMETERS -->
1305 <dd style="display: none; ">
1306 <div></div>
1307 </dd>
1308
1309 </div>
1310 </div><div>
1311 <div>
1312 <dt>
1313 <var>lang</var>
1314 <em>
1315
1316 <!-- TYPE -->
1317 <div style="display:inline">
1318 (
1319 <span class="optional">optional</span>
1320 <span class="enum" style="display: none; ">enumerated</span>
1321 <span id="typeTemplate">
1322 <span style="display: none; ">
1323 <a> Type</a>
1324 </span>
1325 <span>
1326 <span style="display: none; ">
1327 array of <span><span></span></span>
1328 </span>
1329 <span>string</span>
1330 <span style="display: none; "></span>
1331 </span>
1332 </span>
1333 )
1334 </div>
1335
1336 </em>
1337 </dt>
1338 <dd class="todo" style="display: none; ">
1339 Undocumented.
1340 </dd>
1341 <dd>The language to be used for synthesis, in the form <em>language</e m>-<em>region</em>. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'.</dd>
1342 <dd style="display: none; ">
1343 This parameter was added in version
1344 <b><span></span></b>.
1345 You must omit this parameter in earlier versions,
1346 and you may omit it in any version. If you require this
1347 parameter, the manifest key
1348 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1349 can ensure that your extension won't be run in an earlier browser ve rsion.
1350 </dd>
1351
1352 <!-- OBJECT PROPERTIES -->
1353 <dd style="display: none; ">
1354 <dl>
1355 <div>
1356 <div>
1357 </div>
1358 </div>
1359 </dl>
1360 </dd>
1361
1362 <!-- OBJECT METHODS -->
1363 <dd style="display: none; ">
1364 <div></div>
1365 </dd>
1366
1367 <!-- OBJECT EVENT FIELDS -->
1368 <dd style="display: none; ">
1369 <div></div>
1370 </dd>
1371
1372 <!-- FUNCTION PARAMETERS -->
1373 <dd style="display: none; ">
1374 <div></div>
1375 </dd>
1376
1377 </div>
1378 </div><div>
1379 <div>
1380 <dt>
1381 <var>gender</var>
1382 <em>
1383
1384 <!-- TYPE -->
1385 <div style="display:inline">
1386 (
1387 <span class="optional">optional</span>
1388 <span class="enum">enumerated</span>
1389 <span id="typeTemplate">
1390 <span style="display: none; ">
1391 <a> Type</a>
1392 </span>
1393 <span>
1394 <span style="display: none; ">
1395 array of <span><span></span></span>
1396 </span>
1397 <span>string</span>
1398 <span>["male", "female"]</span>
1399 </span>
1400 </span>
1401 )
1402 </div>
1403
1404 </em>
1405 </dt>
1406 <dd class="todo" style="display: none; ">
1407 Undocumented.
1408 </dd>
1409 <dd>Gender of voice for synthesized speech.</dd>
1410 <dd style="display: none; ">
1411 This parameter was added in version
1412 <b><span></span></b>.
1413 You must omit this parameter in earlier versions,
1414 and you may omit it in any version. If you require this
1415 parameter, the manifest key
1416 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1417 can ensure that your extension won't be run in an earlier browser ve rsion.
1418 </dd>
1419
1420 <!-- OBJECT PROPERTIES -->
1421 <dd style="display: none; ">
1422 <dl>
1423 <div>
1424 <div>
1425 </div>
1426 </div>
1427 </dl>
1428 </dd>
1429
1430 <!-- OBJECT METHODS -->
1431 <dd style="display: none; ">
1432 <div></div>
1433 </dd>
1434
1435 <!-- OBJECT EVENT FIELDS -->
1436 <dd style="display: none; ">
1437 <div></div>
1438 </dd>
1439
1440 <!-- FUNCTION PARAMETERS -->
1441 <dd style="display: none; ">
1442 <div></div>
1443 </dd>
1444
1445 </div>
1446 </div><div>
1447 <div>
1448 <dt>
1449 <var>rate</var>
1450 <em>
1451
1452 <!-- TYPE -->
1453 <div style="display:inline">
1454 (
1455 <span class="optional">optional</span>
1456 <span class="enum" style="display: none; ">enumerated</span>
1457 <span id="typeTemplate">
1458 <span style="display: none; ">
1459 <a> Type</a>
1460 </span>
1461 <span>
1462 <span style="display: none; ">
1463 array of <span><span></span></span>
1464 </span>
1465 <span>number</span>
1466 <span style="display: none; "></span>
1467 </span>
1468 </span>
1469 )
1470 </div>
1471
1472 </em>
1473 </dt>
1474 <dd class="todo" style="display: none; ">
1475 Undocumented.
1476 </dd>
1477 <dd>Speaking rate relative to the default rate for this voice. 1.0 is the default rate, normally around 180 to 220 words per minute. 2.0 is twice as f ast, and 0.5 is half as fast. Values below 0.1 or above 10.0 are strictly disall owed, but many voices will constrain the minimum and maximum rates further—for e xample a particular voice may not actually speak faster than 3 times normal even if you specify a value larger than 3.0.</dd>
1478 <dd style="display: none; ">
1479 This parameter was added in version
1480 <b><span></span></b>.
1481 You must omit this parameter in earlier versions,
1482 and you may omit it in any version. If you require this
1483 parameter, the manifest key
1484 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1485 can ensure that your extension won't be run in an earlier browser ve rsion.
1486 </dd>
1487
1488 <!-- OBJECT PROPERTIES -->
1489 <dd style="display: none; ">
1490 <dl>
1491 <div>
1492 <div>
1493 </div>
1494 </div>
1495 </dl>
1496 </dd>
1497
1498 <!-- OBJECT METHODS -->
1499 <dd style="display: none; ">
1500 <div></div>
1501 </dd>
1502
1503 <!-- OBJECT EVENT FIELDS -->
1504 <dd style="display: none; ">
1505 <div></div>
1506 </dd>
1507
1508 <!-- FUNCTION PARAMETERS -->
1509 <dd style="display: none; ">
1510 <div></div>
1511 </dd>
1512
1513 </div>
1514 </div><div>
1515 <div>
1516 <dt>
1517 <var>pitch</var>
1518 <em>
1519
1520 <!-- TYPE -->
1521 <div style="display:inline">
1522 (
1523 <span class="optional">optional</span>
1524 <span class="enum" style="display: none; ">enumerated</span>
1525 <span id="typeTemplate">
1526 <span style="display: none; ">
1527 <a> Type</a>
1528 </span>
1529 <span>
1530 <span style="display: none; ">
1531 array of <span><span></span></span>
1532 </span>
1533 <span>number</span>
1534 <span style="display: none; "></span>
1535 </span>
1536 </span>
1537 )
1538 </div>
1539
1540 </em>
1541 </dt>
1542 <dd class="todo" style="display: none; ">
1543 Undocumented.
1544 </dd>
1545 <dd>Speaking pitch between 0 and 2 inclusive, with 0 being lowest and 2 being highest. 1.0 corresponds to a voice's default pitch.</dd>
1546 <dd style="display: none; ">
1547 This parameter was added in version
1548 <b><span></span></b>.
1549 You must omit this parameter in earlier versions,
1550 and you may omit it in any version. If you require this
1551 parameter, the manifest key
1552 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1553 can ensure that your extension won't be run in an earlier browser ve rsion.
1554 </dd>
1555
1556 <!-- OBJECT PROPERTIES -->
1557 <dd style="display: none; ">
1558 <dl>
1559 <div>
1560 <div>
1561 </div>
1562 </div>
1563 </dl>
1564 </dd>
1565
1566 <!-- OBJECT METHODS -->
1567 <dd style="display: none; ">
1568 <div></div>
1569 </dd>
1570
1571 <!-- OBJECT EVENT FIELDS -->
1572 <dd style="display: none; ">
1573 <div></div>
1574 </dd>
1575
1576 <!-- FUNCTION PARAMETERS -->
1577 <dd style="display: none; ">
1578 <div></div>
1579 </dd>
1580
1581 </div>
1582 </div><div>
1583 <div>
1584 <dt>
1585 <var>volume</var>
1586 <em>
1587
1588 <!-- TYPE -->
1589 <div style="display:inline">
1590 (
1591 <span class="optional">optional</span>
1592 <span class="enum" style="display: none; ">enumerated</span>
1593 <span id="typeTemplate">
1594 <span style="display: none; ">
1595 <a> Type</a>
1596 </span>
1597 <span>
1598 <span style="display: none; ">
1599 array of <span><span></span></span>
1600 </span>
1601 <span>number</span>
1602 <span style="display: none; "></span>
1603 </span>
1604 </span>
1605 )
1606 </div>
1607
1608 </em>
1609 </dt>
1610 <dd class="todo" style="display: none; ">
1611 Undocumented.
1612 </dd>
1613 <dd>Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1 being highest, with a default of 1.0.</dd>
1614 <dd style="display: none; ">
1615 This parameter was added in version
1616 <b><span></span></b>.
1617 You must omit this parameter in earlier versions,
1618 and you may omit it in any version. If you require this
1619 parameter, the manifest key
1620 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1621 can ensure that your extension won't be run in an earlier browser ve rsion.
1622 </dd>
1623
1624 <!-- OBJECT PROPERTIES -->
1625 <dd style="display: none; ">
1626 <dl>
1627 <div>
1628 <div>
1629 </div>
1630 </div>
1631 </dl>
1632 </dd>
1633
1634 <!-- OBJECT METHODS -->
1635 <dd style="display: none; ">
1636 <div></div>
1637 </dd>
1638
1639 <!-- OBJECT EVENT FIELDS -->
1640 <dd style="display: none; ">
1641 <div></div>
1642 </dd>
1643
1644 <!-- FUNCTION PARAMETERS -->
1645 <dd style="display: none; ">
1646 <div></div>
1647 </dd>
1648
1649 </div>
1650 </div><div>
1651 <div>
1652 <dt>
1653 <var>requiredEventTypes</var>
1654 <em>
1655
1656 <!-- TYPE -->
1657 <div style="display:inline">
1658 (
1659 <span class="optional">optional</span>
1660 <span class="enum" style="display: none; ">enumerated</span>
1661 <span id="typeTemplate">
1662 <span style="display: none; ">
1663 <a> Type</a>
1664 </span>
1665 <span>
1666 <span>
1667 array of <span><span>
1668 <span style="display: none; ">
1669 <a> Type</a>
1670 </span>
1671 <span>
1672 <span style="display: none; ">
1673 array of <span><span></span></span>
1674 </span>
1675 <span>string</span>
1676 <span style="display: none; "></span>
1677 </span>
1678 </span></span>
1679 </span>
1680 <span style="display: none; ">paramType</span>
1681 <span style="display: none; "></span>
1682 </span>
1683 </span>
1684 )
1685 </div>
1686
1687 </em>
1688 </dt>
1689 <dd class="todo" style="display: none; ">
1690 Undocumented.
1691 </dd>
1692 <dd>The TTS event types the voice must support.</dd>
1693 <dd style="display: none; ">
1694 This parameter was added in version
1695 <b><span></span></b>.
1696 You must omit this parameter in earlier versions,
1697 and you may omit it in any version. If you require this
1698 parameter, the manifest key
1699 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1700 can ensure that your extension won't be run in an earlier browser ve rsion.
1701 </dd>
1702
1703 <!-- OBJECT PROPERTIES -->
1704 <dd style="display: none; ">
1705 <dl>
1706 <div>
1707 <div>
1708 </div>
1709 </div>
1710 </dl>
1711 </dd>
1712
1713 <!-- OBJECT METHODS -->
1714 <dd style="display: none; ">
1715 <div></div>
1716 </dd>
1717
1718 <!-- OBJECT EVENT FIELDS -->
1719 <dd style="display: none; ">
1720 <div></div>
1721 </dd>
1722
1723 <!-- FUNCTION PARAMETERS -->
1724 <dd style="display: none; ">
1725 <div></div>
1726 </dd>
1727
1728 </div>
1729 </div><div>
1730 <div>
1731 <dt>
1732 <var>desiredEventTypes</var>
1733 <em>
1734
1735 <!-- TYPE -->
1736 <div style="display:inline">
1737 (
1738 <span class="optional">optional</span>
1739 <span class="enum" style="display: none; ">enumerated</span>
1740 <span id="typeTemplate">
1741 <span style="display: none; ">
1742 <a> Type</a>
1743 </span>
1744 <span>
1745 <span>
1746 array of <span><span>
1747 <span style="display: none; ">
1748 <a> Type</a>
1749 </span>
1750 <span>
1751 <span style="display: none; ">
1752 array of <span><span></span></span>
1753 </span>
1754 <span>string</span>
1755 <span style="display: none; "></span>
1756 </span>
1757 </span></span>
1758 </span>
1759 <span style="display: none; ">paramType</span>
1760 <span style="display: none; "></span>
1761 </span>
1762 </span>
1763 )
1764 </div>
1765
1766 </em>
1767 </dt>
1768 <dd class="todo" style="display: none; ">
1769 Undocumented.
1770 </dd>
1771 <dd>The TTS event types that you are interested in listening to. If mi ssing, all event types may be sent.</dd>
1772 <dd style="display: none; ">
1773 This parameter was added in version
1774 <b><span></span></b>.
1775 You must omit this parameter in earlier versions,
1776 and you may omit it in any version. If you require this
1777 parameter, the manifest key
1778 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1779 can ensure that your extension won't be run in an earlier browser ve rsion.
1780 </dd>
1781
1782 <!-- OBJECT PROPERTIES -->
1783 <dd style="display: none; ">
1784 <dl>
1785 <div>
1786 <div>
1787 </div>
1788 </div>
1789 </dl>
1790 </dd>
1791
1792 <!-- OBJECT METHODS -->
1793 <dd style="display: none; ">
1794 <div></div>
1795 </dd>
1796
1797 <!-- OBJECT EVENT FIELDS -->
1798 <dd style="display: none; ">
1799 <div></div>
1800 </dd>
1801
1802 <!-- FUNCTION PARAMETERS -->
1803 <dd style="display: none; ">
1804 <div></div>
1805 </dd>
1806
1807 </div>
1808 </div><div>
1809 <div>
1810 <dt>
1811 <var>onEvent</var>
1812 <em>
1813
1814 <!-- TYPE -->
1815 <div style="display:inline">
1816 (
1817 <span class="optional">optional</span>
1818 <span class="enum" style="display: none; ">enumerated</span>
1819 <span id="typeTemplate">
1820 <span style="display: none; ">
1821 <a> Type</a>
1822 </span>
1823 <span>
1824 <span style="display: none; ">
1825 array of <span><span></span></span>
1826 </span>
1827 <span>function</span>
1828 <span style="display: none; "></span>
1829 </span>
1830 </span>
1831 )
1832 </div>
1833
1834 </em>
1835 </dt>
1836 <dd class="todo" style="display: none; ">
1837 Undocumented.
1838 </dd>
1839 <dd>This function is called with events that occur in the process of s peaking the utterance.</dd>
1840 <dd style="display: none; ">
1841 This parameter was added in version
1842 <b><span></span></b>.
1843 You must omit this parameter in earlier versions,
1844 and you may omit it in any version. If you require this
1845 parameter, the manifest key
1846 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1847 can ensure that your extension won't be run in an earlier browser ve rsion.
1848 </dd>
1849
1850 <!-- OBJECT PROPERTIES -->
1851 <dd style="display: none; ">
1852 <dl>
1853 <div>
1854 <div>
1855 </div>
1856 </div>
1857 </dl>
1858 </dd>
1859
1860 <!-- OBJECT METHODS -->
1861 <dd style="display: none; ">
1862 <div></div>
1863 </dd>
1864
1865 <!-- OBJECT EVENT FIELDS -->
1866 <dd style="display: none; ">
1867 <div></div>
1868 </dd>
1869
1870 <!-- FUNCTION PARAMETERS -->
1871 <dd>
1872 <div>
1873 <h5>Parameters</h5>
1874 <dl>
1875 <div>
1876 <div>
1877 <dt>
1878 <var>event</var>
1879 <em>
1880
1881 <!-- TYPE -->
1882 <div style="display:inline">
1883 (
1884 <span class="optional" style="display: none; ">optional</spa n>
1885 <span class="enum" style="display: none; ">enumerated</span>
1886 <span id="typeTemplate">
1887 <span>
1888 <a href="experimental.tts.html#type-TtsEvent">TtsEvent</ a>
1889 </span>
1890 <span style="display: none; ">
1891 <span>
1892 array of <span><span></span></span>
1893 </span>
1894 <span>paramType</span>
1895 <span></span>
1896 </span>
1897 </span>
1898 )
1899 </div>
1900
1901 </em>
1902 </dt>
1903 <dd class="todo" style="display: none; ">
1904 Undocumented.
1905 </dd>
1906 <dd>The update event from the text-to-speech engine indicating the sta tus of this utterance.</dd>
1907 <dd style="display: none; ">
1908 This parameter was added in version
1909 <b><span></span></b>.
1910 You must omit this parameter in earlier versions,
1911 and you may omit it in any version. If you require this
1912 parameter, the manifest key
1913 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1914 can ensure that your extension won't be run in an earlier browser ve rsion.
1915 </dd>
1916
1917 <!-- OBJECT PROPERTIES -->
1918 <dd style="display: none; ">
1919 <dl>
1920 <div>
1921 <div>
1922 </div>
1923 </div>
1924 </dl>
1925 </dd>
1926
1927 <!-- OBJECT METHODS -->
1928 <dd style="display: none; ">
1929 <div></div>
1930 </dd>
1931
1932 <!-- OBJECT EVENT FIELDS -->
1933 <dd style="display: none; ">
1934 <div></div>
1935 </dd>
1936
1937 <!-- FUNCTION PARAMETERS -->
1938 <dd style="display: none; ">
1939 <div></div>
1940 </dd>
1941
1942 </div>
1943 </div>
1944 </dl>
1945 </div>
1946 </dd>
1947
1948 </div>
1949 </div>
1950 </dl>
1951 </dd>
1952
1953 <!-- OBJECT METHODS -->
1954 <dd style="display: none; ">
1955 <div></div>
1956 </dd>
1957
1958 <!-- OBJECT EVENT FIELDS -->
1959 <dd style="display: none; ">
1960 <div></div>
1961 </dd>
1962
1963 <!-- FUNCTION PARAMETERS -->
1964 <dd style="display: none; ">
1965 <div></div>
1966 </dd>
1967
1968 </div>
1969 </div><div>
1970 <div>
1971 <dt>
1972 <var>callback</var>
1973 <em>
1974
1975 <!-- TYPE -->
1976 <div style="display:inline">
1977 (
1978 <span class="optional">optional</span>
1979 <span class="enum" style="display: none; ">enumerated</span>
1980 <span id="typeTemplate">
1981 <span style="display: none; ">
1982 <a> Type</a>
1983 </span>
1984 <span>
1985 <span style="display: none; ">
1986 array of <span><span></span></span>
1987 </span>
1988 <span>function</span>
1989 <span style="display: none; "></span>
1990 </span>
1991 </span>
1992 )
1993 </div>
1994
1995 </em>
1996 </dt>
1997 <dd class="todo" style="display: none; ">
1998 Undocumented.
1999 </dd>
2000 <dd>Called right away, before speech finishes. Check chrome.extension. lastError to make sure there were no errors. Use options.onEvent to get more det ailed feedback.</dd>
2001 <dd style="display: none; ">
2002 This parameter was added in version
2003 <b><span></span></b>.
2004 You must omit this parameter in earlier versions,
2005 and you may omit it in any version. If you require this
2006 parameter, the manifest key
2007 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2008 can ensure that your extension won't be run in an earlier browser ve rsion.
2009 </dd>
2010
2011 <!-- OBJECT PROPERTIES -->
2012 <dd style="display: none; ">
2013 <dl>
2014 <div>
2015 <div>
2016 </div>
2017 </div>
2018 </dl>
2019 </dd>
2020
2021 <!-- OBJECT METHODS -->
2022 <dd style="display: none; ">
2023 <div></div>
2024 </dd>
2025
2026 <!-- OBJECT EVENT FIELDS -->
2027 <dd style="display: none; ">
2028 <div></div>
2029 </dd>
2030
2031 <!-- FUNCTION PARAMETERS -->
2032 <dd style="display: none; ">
2033 <div></div>
2034 </dd>
2035
2036 </div>
2037 </div>
2038 </dl>
2039
2040 <!-- RETURNS -->
2041 <h4 style="display: none; ">Returns</h4>
2042 <dl>
2043 <div style="display: none; ">
2044 <div>
2045 </div>
2046 </div>
2047 </dl>
2048
2049 <!-- CALLBACK -->
2050 <div>
2051 <div>
2052 <h4>Callback function</h4>
2053 <p style="display: none; ">
2054 The callback <em>parameter</em> should specify a function
2055 that looks like this:
2056 </p>
2057 <p>
2058 If you specify the <em>callback</em> parameter, it should
2059 specify a function that looks like this:
2060 </p>
2061
2062 <!-- Note: intentionally longer 80 columns -->
2063 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
2064 <dl>
2065 <div style="display: none; ">
2066 <div>
2067 </div>
2068 </div>
2069 </dl>
2070 </div>
2071 </div>
2072
2073 <!-- MIN_VERSION -->
2074 <p style="display: none; ">
2075 This function was added in version <b><span></span></b>.
2076 If you require this function, the manifest key
2077 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
2078 can ensure that your extension won't be run in an earlier brow ser version.
2079 </p>
2080 </div> <!-- /description -->
2081
2082 </div><div class="apiItem">
2083 <a name="method-stop"></a> <!-- method-anchor -->
2084 <h4>stop</h4>
2085
2086 <div class="summary"><span style="display: none; ">void</span>
2087 <!-- Note: intentionally longer 80 columns -->
2088 <span>chrome.experimental.tts.stop</span>(<span style="display : none; "><span>, </span><span></span>
2089 <var><span></span></var></span>)</div>
2090
2091 <div class="description">
2092 <p class="todo" style="display: none; ">Undocumented.</p>
2093 <p>Stop any current speech.</p>
2094
2095 <!-- PARAMETERS -->
2096 <h4 style="display: none; ">Parameters</h4>
2097 <dl>
2098 <div style="display: none; ">
2099 <div>
2100 </div>
2101 </div>
2102 </dl>
2103
2104 <!-- RETURNS -->
2105 <h4 style="display: none; ">Returns</h4>
2106 <dl>
2107 <div style="display: none; ">
2108 <div>
2109 </div>
2110 </div>
2111 </dl>
2112
2113 <!-- CALLBACK -->
2114 <div style="display: none; ">
2115 <div>
2116 <h4>Callback function</h4>
2117 <p>
2118 The callback <em>parameter</em> should specify a function
2119 that looks like this:
2120 </p>
2121 <p>
2122 If you specify the <em>callback</em> parameter, it should
2123 specify a function that looks like this:
2124 </p>
2125
2126 <!-- Note: intentionally longer 80 columns -->
2127 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
2128 <dl>
2129 <div>
2130 <div>
2131 </div>
2132 </div>
2133 </dl>
2134 </div>
2135 </div>
2136
2137 <!-- MIN_VERSION -->
2138 <p style="display: none; ">
2139 This function was added in version <b><span></span></b>.
2140 If you require this function, the manifest key
2141 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
2142 can ensure that your extension won't be run in an earlier brow ser version.
2143 </p>
2144 </div> <!-- /description -->
2145
2146 </div> <!-- /apiItem -->
2147
2148 </div> <!-- /apiGroup -->
2149
2150 <!-- EVENTS -->
2151 <div id="eventsTemplate" class="apiGroup" style="display: none; ">
2152 <a></a>
2153 <h3>Events</h3>
2154 <!-- iterates over all events -->
2155 <div class="apiItem">
2156 <a></a>
2157 <h4>event name</h4>
2158
2159 <div class="summary">
2160 <!-- Note: intentionally longer 80 columns -->
2161 <span class="subdued">chrome.bookmarks</span><span>onEvent</span ><span class="subdued">.addListener</span>(function(<span>Type param1, Type para m2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_p aram2</span>));
2162 </div>
2163
2164 <div class="description">
2165 <p class="todo">Undocumented.</p>
2166 <p>
2167 A description from the json schema def of the event goes here.
2168 </p>
2169
2170 <!-- LISTENER PARAMETERS -->
2171 <div>
2172 <h4>Listener parameters</h4>
2173 <dl>
2174 <div>
2175 <div>
2176 </div>
2177 </div>
2178 </dl>
2179 </div>
2180
2181 <!-- EXTRA PARAMETERS -->
2182 <div>
2183 <h4>Extra parameters to addListener</h4>
2184 <dl>
2185 <div>
2186 <div>
2187 </div>
2188 </div>
2189 </dl>
2190 </div>
2191
2192 <!-- LISTENER RETURN VALUE -->
2193 <h4>Listener returns</h4>
2194 <dl>
2195 <div>
2196 <div>
2197 </div>
2198 </div>
2199 </dl>
2200
2201 </div> <!-- /description -->
2202 </div> <!-- /apiItem -->
2203
2204 </div> <!-- /apiGroup -->
2205
2206 <!-- TYPES -->
2207 <div class="apiGroup">
2208 <a name="types"></a>
2209 <h3 id="types">Types</h3>
2210
2211 <!-- iterates over all types -->
2212 <div class="apiItem">
2213 <a name="type-TtsEvent"></a>
2214 <h4>TtsEvent</h4>
2215
2216 <div>
2217 <dt>
2218 <var style="display: none; ">paramName</var>
2219 <em>
2220
2221 <!-- TYPE -->
2222 <div style="display:inline">
2223 (
2224 <span class="optional" style="display: none; ">optional</spa n>
2225 <span class="enum" style="display: none; ">enumerated</span>
2226 <span id="typeTemplate">
2227 <span style="display: none; ">
2228 <a> Type</a>
2229 </span>
2230 <span>
2231 <span style="display: none; ">
2232 array of <span><span></span></span>
2233 </span>
2234 <span>object</span>
2235 <span style="display: none; "></span>
2236 </span>
2237 </span>
2238 )
2239 </div>
2240
2241 </em>
2242 </dt>
2243 <dd class="todo" style="display: none; ">
2244 Undocumented.
2245 </dd>
2246 <dd>An event from the TTS engine to communicate the status of an utter ance.</dd>
2247 <dd style="display: none; ">
2248 This parameter was added in version
2249 <b><span></span></b>.
2250 You must omit this parameter in earlier versions,
2251 and you may omit it in any version. If you require this
2252 parameter, the manifest key
2253 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2254 can ensure that your extension won't be run in an earlier browser ve rsion.
2255 </dd>
2256
2257 <!-- OBJECT PROPERTIES -->
2258 <dd>
2259 <dl>
2260 <div>
2261 <div>
2262 <dt>
2263 <var>type</var>
2264 <em>
2265
2266 <!-- TYPE -->
2267 <div style="display:inline">
2268 (
2269 <span class="optional" style="display: none; ">optional</spa n>
2270 <span class="enum">enumerated</span>
2271 <span id="typeTemplate">
2272 <span style="display: none; ">
2273 <a> Type</a>
2274 </span>
2275 <span>
2276 <span style="display: none; ">
2277 array of <span><span></span></span>
2278 </span>
2279 <span>string</span>
2280 <span>["start", "end", "word", "sentence", "marker", "in terrupted", "cancelled", "error"]</span>
2281 </span>
2282 </span>
2283 )
2284 </div>
2285
2286 </em>
2287 </dt>
2288 <dd class="todo" style="display: none; ">
2289 Undocumented.
2290 </dd>
2291 <dd>The type can be 'start' as soon as speech has started, 'word' when a word boundary is reached, 'sentence' when a sentence boundary is reached, 'ma rker' when an SSML mark element is reached, 'end' when the end of the utterance is reached, 'interrupted' when the utterance is stopped or interrupted before re aching the end, 'cancelled' when it's removed from the queue before ever being s ynthesized, or 'error' when any other error occurs.</dd>
2292 <dd style="display: none; ">
2293 This parameter was added in version
2294 <b><span></span></b>.
2295 You must omit this parameter in earlier versions,
2296 and you may omit it in any version. If you require this
2297 parameter, the manifest key
2298 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2299 can ensure that your extension won't be run in an earlier browser ve rsion.
2300 </dd>
2301
2302 <!-- OBJECT PROPERTIES -->
2303 <dd style="display: none; ">
2304 <dl>
2305 <div>
2306 <div>
2307 </div>
2308 </div>
2309 </dl>
2310 </dd>
2311
2312 <!-- OBJECT METHODS -->
2313 <dd style="display: none; ">
2314 <div></div>
2315 </dd>
2316
2317 <!-- OBJECT EVENT FIELDS -->
2318 <dd style="display: none; ">
2319 <div></div>
2320 </dd>
2321
2322 <!-- FUNCTION PARAMETERS -->
2323 <dd style="display: none; ">
2324 <div></div>
2325 </dd>
2326
2327 </div>
2328 </div><div>
2329 <div>
2330 <dt>
2331 <var>charIndex</var>
2332 <em>
2333
2334 <!-- TYPE -->
2335 <div style="display:inline">
2336 (
2337 <span class="optional">optional</span>
2338 <span class="enum" style="display: none; ">enumerated</span>
2339 <span id="typeTemplate">
2340 <span style="display: none; ">
2341 <a> Type</a>
2342 </span>
2343 <span>
2344 <span style="display: none; ">
2345 array of <span><span></span></span>
2346 </span>
2347 <span>number</span>
2348 <span style="display: none; "></span>
2349 </span>
2350 </span>
2351 )
2352 </div>
2353
2354 </em>
2355 </dt>
2356 <dd class="todo" style="display: none; ">
2357 Undocumented.
2358 </dd>
2359 <dd>The index of the current character in the utterance.</dd>
2360 <dd style="display: none; ">
2361 This parameter was added in version
2362 <b><span></span></b>.
2363 You must omit this parameter in earlier versions,
2364 and you may omit it in any version. If you require this
2365 parameter, the manifest key
2366 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2367 can ensure that your extension won't be run in an earlier browser ve rsion.
2368 </dd>
2369
2370 <!-- OBJECT PROPERTIES -->
2371 <dd style="display: none; ">
2372 <dl>
2373 <div>
2374 <div>
2375 </div>
2376 </div>
2377 </dl>
2378 </dd>
2379
2380 <!-- OBJECT METHODS -->
2381 <dd style="display: none; ">
2382 <div></div>
2383 </dd>
2384
2385 <!-- OBJECT EVENT FIELDS -->
2386 <dd style="display: none; ">
2387 <div></div>
2388 </dd>
2389
2390 <!-- FUNCTION PARAMETERS -->
2391 <dd style="display: none; ">
2392 <div></div>
2393 </dd>
2394
2395 </div>
2396 </div><div>
2397 <div>
2398 <dt>
2399 <var>errorMessage</var>
2400 <em>
2401
2402 <!-- TYPE -->
2403 <div style="display:inline">
2404 (
2405 <span class="optional">optional</span>
2406 <span class="enum" style="display: none; ">enumerated</span>
2407 <span id="typeTemplate">
2408 <span style="display: none; ">
2409 <a> Type</a>
2410 </span>
2411 <span>
2412 <span style="display: none; ">
2413 array of <span><span></span></span>
2414 </span>
2415 <span>string</span>
2416 <span style="display: none; "></span>
2417 </span>
2418 </span>
2419 )
2420 </div>
2421
2422 </em>
2423 </dt>
2424 <dd class="todo" style="display: none; ">
2425 Undocumented.
2426 </dd>
2427 <dd>The error description, if the event type is 'error'.</dd>
2428 <dd style="display: none; ">
2429 This parameter was added in version
2430 <b><span></span></b>.
2431 You must omit this parameter in earlier versions,
2432 and you may omit it in any version. If you require this
2433 parameter, the manifest key
2434 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2435 can ensure that your extension won't be run in an earlier browser ve rsion.
2436 </dd>
2437
2438 <!-- OBJECT PROPERTIES -->
2439 <dd style="display: none; ">
2440 <dl>
2441 <div>
2442 <div>
2443 </div>
2444 </div>
2445 </dl>
2446 </dd>
2447
2448 <!-- OBJECT METHODS -->
2449 <dd style="display: none; ">
2450 <div></div>
2451 </dd>
2452
2453 <!-- OBJECT EVENT FIELDS -->
2454 <dd style="display: none; ">
2455 <div></div>
2456 </dd>
2457
2458 <!-- FUNCTION PARAMETERS -->
2459 <dd style="display: none; ">
2460 <div></div>
2461 </dd>
2462
2463 </div>
2464 </div>
2465 </dl>
2466 </dd>
2467
2468 <!-- OBJECT METHODS -->
2469 <dd style="display: none; ">
2470 <div></div>
2471 </dd>
2472
2473 <!-- OBJECT EVENT FIELDS -->
2474 <dd style="display: none; ">
2475 <div></div>
2476 </dd>
2477
2478 <!-- FUNCTION PARAMETERS -->
2479 <dd style="display: none; ">
2480 <div></div>
2481 </dd>
2482
2483 </div>
2484
2485 </div><div class="apiItem">
2486 <a name="type-TtsVoice"></a>
2487 <h4>TtsVoice</h4>
2488
2489 <div>
2490 <dt>
2491 <var style="display: none; ">paramName</var>
2492 <em>
2493
2494 <!-- TYPE -->
2495 <div style="display:inline">
2496 (
2497 <span class="optional" style="display: none; ">optional</spa n>
2498 <span class="enum" style="display: none; ">enumerated</span>
2499 <span id="typeTemplate">
2500 <span style="display: none; ">
2501 <a> Type</a>
2502 </span>
2503 <span>
2504 <span style="display: none; ">
2505 array of <span><span></span></span>
2506 </span>
2507 <span>object</span>
2508 <span style="display: none; "></span>
2509 </span>
2510 </span>
2511 )
2512 </div>
2513
2514 </em>
2515 </dt>
2516 <dd class="todo" style="display: none; ">
2517 Undocumented.
2518 </dd>
2519 <dd>A description of a voice available for speech synthesis.</dd>
2520 <dd style="display: none; ">
2521 This parameter was added in version
2522 <b><span></span></b>.
2523 You must omit this parameter in earlier versions,
2524 and you may omit it in any version. If you require this
2525 parameter, the manifest key
2526 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2527 can ensure that your extension won't be run in an earlier browser ve rsion.
2528 </dd>
2529
2530 <!-- OBJECT PROPERTIES -->
2531 <dd>
2532 <dl>
2533 <div>
2534 <div>
2535 <dt>
2536 <var>voiceName</var>
2537 <em>
2538
2539 <!-- TYPE -->
2540 <div style="display:inline">
2541 (
2542 <span class="optional">optional</span>
2543 <span class="enum" style="display: none; ">enumerated</span>
2544 <span id="typeTemplate">
2545 <span style="display: none; ">
2546 <a> Type</a>
2547 </span>
2548 <span>
2549 <span style="display: none; ">
2550 array of <span><span></span></span>
2551 </span>
2552 <span>string</span>
2553 <span style="display: none; "></span>
2554 </span>
2555 </span>
2556 )
2557 </div>
2558
2559 </em>
2560 </dt>
2561 <dd class="todo" style="display: none; ">
2562 Undocumented.
2563 </dd>
2564 <dd>The name of the voice.</dd>
2565 <dd style="display: none; ">
2566 This parameter was added in version
2567 <b><span></span></b>.
2568 You must omit this parameter in earlier versions,
2569 and you may omit it in any version. If you require this
2570 parameter, the manifest key
2571 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2572 can ensure that your extension won't be run in an earlier browser ve rsion.
2573 </dd>
2574
2575 <!-- OBJECT PROPERTIES -->
2576 <dd style="display: none; ">
2577 <dl>
2578 <div>
2579 <div>
2580 </div>
2581 </div>
2582 </dl>
2583 </dd>
2584
2585 <!-- OBJECT METHODS -->
2586 <dd style="display: none; ">
2587 <div></div>
2588 </dd>
2589
2590 <!-- OBJECT EVENT FIELDS -->
2591 <dd style="display: none; ">
2592 <div></div>
2593 </dd>
2594
2595 <!-- FUNCTION PARAMETERS -->
2596 <dd style="display: none; ">
2597 <div></div>
2598 </dd>
2599
2600 </div>
2601 </div><div>
2602 <div>
2603 <dt>
2604 <var>lang</var>
2605 <em>
2606
2607 <!-- TYPE -->
2608 <div style="display:inline">
2609 (
2610 <span class="optional">optional</span>
2611 <span class="enum" style="display: none; ">enumerated</span>
2612 <span id="typeTemplate">
2613 <span style="display: none; ">
2614 <a> Type</a>
2615 </span>
2616 <span>
2617 <span style="display: none; ">
2618 array of <span><span></span></span>
2619 </span>
2620 <span>string</span>
2621 <span style="display: none; "></span>
2622 </span>
2623 </span>
2624 )
2625 </div>
2626
2627 </em>
2628 </dt>
2629 <dd class="todo" style="display: none; ">
2630 Undocumented.
2631 </dd>
2632 <dd>The language that this voice supports, in the form <em>language</e m>-<em>region</em>. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'.</dd>
2633 <dd style="display: none; ">
2634 This parameter was added in version
2635 <b><span></span></b>.
2636 You must omit this parameter in earlier versions,
2637 and you may omit it in any version. If you require this
2638 parameter, the manifest key
2639 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2640 can ensure that your extension won't be run in an earlier browser ve rsion.
2641 </dd>
2642
2643 <!-- OBJECT PROPERTIES -->
2644 <dd style="display: none; ">
2645 <dl>
2646 <div>
2647 <div>
2648 </div>
2649 </div>
2650 </dl>
2651 </dd>
2652
2653 <!-- OBJECT METHODS -->
2654 <dd style="display: none; ">
2655 <div></div>
2656 </dd>
2657
2658 <!-- OBJECT EVENT FIELDS -->
2659 <dd style="display: none; ">
2660 <div></div>
2661 </dd>
2662
2663 <!-- FUNCTION PARAMETERS -->
2664 <dd style="display: none; ">
2665 <div></div>
2666 </dd>
2667
2668 </div>
2669 </div><div>
2670 <div>
2671 <dt>
2672 <var>gender</var>
2673 <em>
2674
2675 <!-- TYPE -->
2676 <div style="display:inline">
2677 (
2678 <span class="optional">optional</span>
2679 <span class="enum">enumerated</span>
2680 <span id="typeTemplate">
2681 <span style="display: none; ">
2682 <a> Type</a>
2683 </span>
2684 <span>
2685 <span style="display: none; ">
2686 array of <span><span></span></span>
2687 </span>
2688 <span>string</span>
2689 <span>["male", "female"]</span>
2690 </span>
2691 </span>
2692 )
2693 </div>
2694
2695 </em>
2696 </dt>
2697 <dd class="todo" style="display: none; ">
2698 Undocumented.
2699 </dd>
2700 <dd>This voice's gender.</dd>
2701 <dd style="display: none; ">
2702 This parameter was added in version
2703 <b><span></span></b>.
2704 You must omit this parameter in earlier versions,
2705 and you may omit it in any version. If you require this
2706 parameter, the manifest key
2707 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2708 can ensure that your extension won't be run in an earlier browser ve rsion.
2709 </dd>
2710
2711 <!-- OBJECT PROPERTIES -->
2712 <dd style="display: none; ">
2713 <dl>
2714 <div>
2715 <div>
2716 </div>
2717 </div>
2718 </dl>
2719 </dd>
2720
2721 <!-- OBJECT METHODS -->
2722 <dd style="display: none; ">
2723 <div></div>
2724 </dd>
2725
2726 <!-- OBJECT EVENT FIELDS -->
2727 <dd style="display: none; ">
2728 <div></div>
2729 </dd>
2730
2731 <!-- FUNCTION PARAMETERS -->
2732 <dd style="display: none; ">
2733 <div></div>
2734 </dd>
2735
2736 </div>
2737 </div><div>
2738 <div>
2739 <dt>
2740 <var>extensionId</var>
2741 <em>
2742
2743 <!-- TYPE -->
2744 <div style="display:inline">
2745 (
2746 <span class="optional">optional</span>
2747 <span class="enum" style="display: none; ">enumerated</span>
2748 <span id="typeTemplate">
2749 <span style="display: none; ">
2750 <a> Type</a>
2751 </span>
2752 <span>
2753 <span style="display: none; ">
2754 array of <span><span></span></span>
2755 </span>
2756 <span>string</span>
2757 <span style="display: none; "></span>
2758 </span>
2759 </span>
2760 )
2761 </div>
2762
2763 </em>
2764 </dt>
2765 <dd class="todo" style="display: none; ">
2766 Undocumented.
2767 </dd>
2768 <dd>The ID of the extension providing this voice.</dd>
2769 <dd style="display: none; ">
2770 This parameter was added in version
2771 <b><span></span></b>.
2772 You must omit this parameter in earlier versions,
2773 and you may omit it in any version. If you require this
2774 parameter, the manifest key
2775 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2776 can ensure that your extension won't be run in an earlier browser ve rsion.
2777 </dd>
2778
2779 <!-- OBJECT PROPERTIES -->
2780 <dd style="display: none; ">
2781 <dl>
2782 <div>
2783 <div>
2784 </div>
2785 </div>
2786 </dl>
2787 </dd>
2788
2789 <!-- OBJECT METHODS -->
2790 <dd style="display: none; ">
2791 <div></div>
2792 </dd>
2793
2794 <!-- OBJECT EVENT FIELDS -->
2795 <dd style="display: none; ">
2796 <div></div>
2797 </dd>
2798
2799 <!-- FUNCTION PARAMETERS -->
2800 <dd style="display: none; ">
2801 <div></div>
2802 </dd>
2803
2804 </div>
2805 </div><div>
2806 <div>
2807 <dt>
2808 <var>eventTypes</var>
2809 <em>
2810
2811 <!-- TYPE -->
2812 <div style="display:inline">
2813 (
2814 <span class="optional">optional</span>
2815 <span class="enum" style="display: none; ">enumerated</span>
2816 <span id="typeTemplate">
2817 <span style="display: none; ">
2818 <a> Type</a>
2819 </span>
2820 <span>
2821 <span>
2822 array of <span><span>
2823 <span style="display: none; ">
2824 <a> Type</a>
2825 </span>
2826 <span>
2827 <span style="display: none; ">
2828 array of <span><span></span></span>
2829 </span>
2830 <span>string</span>
2831 <span style="display: none; "></span>
2832 </span>
2833 </span></span>
2834 </span>
2835 <span style="display: none; ">paramType</span>
2836 <span style="display: none; "></span>
2837 </span>
2838 </span>
2839 )
2840 </div>
2841
2842 </em>
2843 </dt>
2844 <dd class="todo" style="display: none; ">
2845 Undocumented.
2846 </dd>
2847 <dd>All of the callback event types that this voice is capable of send ing.</dd>
2848 <dd style="display: none; ">
2849 This parameter was added in version
2850 <b><span></span></b>.
2851 You must omit this parameter in earlier versions,
2852 and you may omit it in any version. If you require this
2853 parameter, the manifest key
2854 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2855 can ensure that your extension won't be run in an earlier browser ve rsion.
2856 </dd>
2857
2858 <!-- OBJECT PROPERTIES -->
2859 <dd style="display: none; ">
2860 <dl>
2861 <div>
2862 <div>
2863 </div>
2864 </div>
2865 </dl>
2866 </dd>
2867
2868 <!-- OBJECT METHODS -->
2869 <dd style="display: none; ">
2870 <div></div>
2871 </dd>
2872
2873 <!-- OBJECT EVENT FIELDS -->
2874 <dd style="display: none; ">
2875 <div></div>
2876 </dd>
2877
2878 <!-- FUNCTION PARAMETERS -->
2879 <dd style="display: none; ">
2880 <div></div>
2881 </dd>
2882
2883 </div>
2884 </div>
2885 </dl>
2886 </dd>
2887
2888 <!-- OBJECT METHODS -->
2889 <dd style="display: none; ">
2890 <div></div>
2891 </dd>
2892
2893 <!-- OBJECT EVENT FIELDS -->
2894 <dd style="display: none; ">
2895 <div></div>
2896 </dd>
2897
2898 <!-- FUNCTION PARAMETERS -->
2899 <dd style="display: none; ">
2900 <div></div>
2901 </dd>
2902
2903 </div>
2904
2905 </div> <!-- /apiItem -->
2906
2907 </div> <!-- /apiGroup -->
2908
2909 </div> <!-- /apiPage -->
2910 </div> <!-- /gc-pagecontent -->
2911 </div> <!-- /g-section -->
2912 </div> <!-- /codesiteContent -->
2913 <div id="gc-footer" --="">
2914 <div class="text">
2915 <p>
2916 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
2917 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
2918 Attribution 3.0 License</a>, and code samples are licensed under the
2919 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
2920 </p>
2921 <p>
2922 ©2011 Google
2923 </p>
2924
2925 <!-- begin analytics -->
2926 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>
2927 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>
2928
2929 <script type="text/javascript">
2930 // chrome doc tracking
2931 try {
2932 var engdocs = _gat._getTracker("YT-10763712-2");
2933 engdocs._trackPageview();
2934 } catch(err) {}
2935
2936 // code.google.com site-wide tracking
2937 try {
2938 _uacct="UA-18071-1";
2939 _uanchor=1;
2940 _uff=0;
2941 urchinTracker();
2942 }
2943 catch(e) {/* urchinTracker not available. */}
2944 </script>
2945 <!-- end analytics -->
2946 </div>
2947 </div> <!-- /gc-footer -->
2948 </div> <!-- /gc-container -->
2949 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/experimental.ttsEngine.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698