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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Powered by Google App Engine
This is Rietveld 408576698