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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 7282048: Update TTS extension API docs to reflect latest changes. Note that this (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/api/extension_api.json ('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
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 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 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 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 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 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
(...skipping 335 matching lines...) Expand 10 before | Expand all | Expand 10 after
346 <p id="classSummary"> 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. 347 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
348 </p> 348 </p>
349 349
350 <!-- STATIC CONTENT PLACEHOLDER --> 350 <!-- STATIC CONTENT PLACEHOLDER -->
351 <div id="static"><p id="classSummary"> 351 <div id="static"><p id="classSummary">
352 Use the <code>chrome.experimental.tts</code> module to play synthesized 352 Use the <code>chrome.experimental.tts</code> module to play synthesized
353 text-to-speech (TTS) from your extension or packaged app. 353 text-to-speech (TTS) from your extension or packaged app.
354 See also the related 354 See also the related
355 <a href="experimental.ttsEngine.html">experimental.ttsEngine</a> 355 <a href="experimental.ttsEngine.html">experimental.ttsEngine</a>
356 module which allows an extension to implement a speech engine. 356 module, which allows an extension to implement a speech engine.
357 </p> 357 </p>
358 358
359 <p class="note"><b>Give us feedback:</b> If you have suggestions, 359 <p class="note"><b>Give us feedback:</b> If you have suggestions,
360 especially changes that should be made before stabilizing the first 360 especially changes that should be made before stabilizing the first
361 version of this API, please send your ideas to the 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> 362 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions">chro mium-extensions</a>
363 group.</p> 363 group.</p>
364 364
365 <h2 id="overview">Overview</h2> 365 <h2 id="overview">Overview</h2>
366 366
(...skipping 21 matching lines...) Expand all
388 such as its rate, pitch, and more. For example:</p> 388 such as its rate, pitch, and more. For example:</p>
389 389
390 <pre>chrome.experimental.tts.speak('Hello, world.', {'rate': 2.0});</pre> 390 <pre>chrome.experimental.tts.speak('Hello, world.', {'rate': 2.0});</pre>
391 391
392 <p>It's also a good idea to specify the language so that a synthesizer 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> 393 supporting that language (and regional dialect, if applicable) is chosen.</p>
394 394
395 <pre>chrome.experimental.tts.speak( 395 <pre>chrome.experimental.tts.speak(
396 'Hello, world.', {'lang': 'en-US', 'rate': 2.0});</pre> 396 'Hello, world.', {'lang': 'en-US', 'rate': 2.0});</pre>
397 397
398 <p>By default, each call to <code>speak()</code> will interrupt any 398 <p>By default, each call to <code>speak()</code> interrupts any
399 ongoing speech and speak immediately. To determine if a call would be 399 ongoing speech and speaks immediately. To determine if a call would be
400 interrupting anything, you can call <code>isSpeaking()</code>, or 400 interrupting anything, you can call <code>isSpeaking()</code>. In
401 you can use the <code>enqueue</code> option to cause this utterance to 401 addition, you can use the <code>enqueue</code> option to cause this
402 be added to a queue of utterances that will be spoken when the current 402 utterance to be added to a queue of utterances that will be spoken
403 utterance has finished. 403 when the current utterance has finished.</p>
404 404
405 </p><pre>chrome.experimental.tts.speak( 405 <pre>chrome.experimental.tts.speak(
406 'Speak this first.'); 406 'Speak this first.');
407 chrome.experimental.tts.speak( 407 chrome.experimental.tts.speak(
408 'Speak this next, when the first sentence is done.', {'enqueue': true}); 408 'Speak this next, when the first sentence is done.', {'enqueue': true});
409 </pre> 409 </pre>
410 410
411 <p>A complete description of all options can be found in the 411 <p>A complete description of all options can be found in the
412 <a href="#method-speak">speak() method documentation</a> below. 412 <a href="#method-speak">speak() method documentation</a> below.
413 Not all speech engines will support all options.</p> 413 Not all speech engines will support all options.</p>
414 414
415 <p>To catch errors and make sure you're calling <code>speak()</code> 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 416 correctly, pass a callback function that takes no arguments. Inside
417 the callback, check 417 the callback, check
418 <a href="extension.html#property-lastError">chrome.extension.lastError</a> 418 <a href="extension.html#property-lastError">chrome.extension.lastError</a>
419 to see if there were any errors.</p> 419 to see if there were any errors.</p>
420 420
421 <pre>chrome.experimental.tts.speak( 421 <pre>chrome.experimental.tts.speak(
422 utterance, 422 utterance,
423 options, 423 options,
424 function() { 424 function() {
425 if (chrome.extension.lastError) { 425 if (chrome.extension.lastError) {
426 console.log('Error: ' + chrome.extension.lastError.message); 426 console.log('Error: ' + chrome.extension.lastError.message);
427 } 427 }
428 });</pre> 428 });</pre>
429 429
430 <p>The callback returns right away, before the speech engine has started 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 syntax 431 generating speech. The purpose of the callback is to alert you to
432 errors in your use of the TTS API, not all possible errors that might occur 432 syntax errors in your use of the TTS API, not to catch all possible
433 in the process of synthesizing and outputting speech. To catch these errors 433 errors that might occur in the process of synthesizing and outputting
434 too, you need to use an event listener, described below. 434 speech. To catch these errors too, you need to use an event listener,
435 described below.</p>
435 436
436 </p><h2 id="events">Listening to events</h2> 437 <h2 id="events">Listening to events</h2>
437 438
438 <p>To get more real-time information about the status of synthesized speech, 439 <p>To get more real-time information about the status of synthesized speech,
439 pass an event listener in the options to <code>speak()</code>, like this:</p> 440 pass an event listener in the options to <code>speak()</code>, like this:</p>
440 441
441 <pre>chrome.experimental.tts.speak( 442 <pre>chrome.experimental.tts.speak(
442 utterance, 443 utterance,
443 { 444 {
444 'onevent': function(event) { 445 onEvent: function(event) {
445 console.log('Event ' + event.type ' at position ' + event.charIndex); 446 console.log('Event ' + event.type ' at position ' + event.charIndex);
446 if (event.type == 'error') { 447 if (event.type == 'error') {
447 console.log('Error: ' + event.errorMessage); 448 console.log('Error: ' + event.errorMessage);
448 } 449 }
449 } 450 }
450 }, 451 },
451 callback);</pre> 452 callback);</pre>
452 453
453 <p>Each event includes an event type, the character index of the current 454 <p>Each event includes an event type, the character index of the current
454 speech relative to the utterance, and for error events, an optional 455 speech relative to the utterance, and for error events, an optional
455 error message. The event types are:</p> 456 error message. The event types are:</p>
456 457
457 <ul> 458 <ul>
458 <li><code>'start'</code>: the engine has started speaking the utterance. 459 <li><code>'start'</code>: The engine has started speaking the utterance.
459 </li><li><code>'word'</code>: a word boundary was reached. Use 460 </li><li><code>'word'</code>: A word boundary was reached. Use
460 <code>event.charIndex</code> to determine the current speech 461 <code>event.charIndex</code> to determine the current speech
461 position. 462 position.
462 </li><li><code>'sentence'</code>: a sentence boundary was reached. Use 463 </li><li><code>'sentence'</code>: A sentence boundary was reached. Use
463 <code>event.charIndex</code> to determine the current speech 464 <code>event.charIndex</code> to determine the current speech
464 position. 465 position.
465 </li><li><code>'marker'</code>: an SSML marker was reached. Use 466 </li><li><code>'marker'</code>: An SSML marker was reached. Use
466 <code>event.charIndex</code> to determine the current speech 467 <code>event.charIndex</code> to determine the current speech
467 position. 468 position.
468 </li><li><code>'end'</code>: the engine has finished speaking the utterance. 469 </li><li><code>'end'</code>: The engine has finished speaking the utterance.
469 </li><li><code>'interrupted'</code>: this utterance was interrupted by another 470 </li><li><code>'interrupted'</code>: This utterance was interrupted by another
470 call to <code>speak()</code> or <code>stop()</code> and did not 471 call to <code>speak()</code> or <code>stop()</code> and did not
471 finish. 472 finish.
472 </li><li><code>'cancelled'</code>: this utterance was queued, but then 473 </li><li><code>'cancelled'</code>: This utterance was queued, but then
473 cancelled by another call to <code>speak()</code> or 474 cancelled by another call to <code>speak()</code> or
474 <code>stop()</code> and never began to speak at all. 475 <code>stop()</code> and never began to speak at all.
475 </li><li><code>'error'</code>: An engine-specific error occurred and 476 </li><li><code>'error'</code>: An engine-specific error occurred and
476 this utterance cannot be spoken. 477 this utterance cannot be spoken.
477 Check <code>event.errorMessage</code> for details. 478 Check <code>event.errorMessage</code> for details.
478 </li></ul> 479 </li></ul>
479 480
480 <p>Four of the event types, <code>'end'</code>, <code>'interrupted'</code>, 481 <p>Four of the event types—<code>'end'</code>, <code>'interrupted'</code>,
481 <code>'cancelled'</code>, and <code>'error'</code>, are <i>final</i>. After 482 <code>'cancelled'</code>, and <code>'error'</code>—are <i>final</i>.
482 one of those events is received, this utterance will no longer speak and 483 After one of those events is received, this utterance will no longer
483 no new events from this utterance will be received.</p> 484 speak and no new events from this utterance will be received.</p>
484 485
485 <p>Some TTS engines may not support all event types, and some may not even 486 <p>Some voices may not support all event types, and some voices may not
486 support any events at all. To require that the speech engine used sends 487 send any events at all. If you do not want to use a voice unless it sends
487 the events you're interested in, you can pass a list of event types in 488 certain events, pass the events you require in the
488 the <code>requiredEventTypes</code> member of the options object, or use 489 <code>requiredEventTypes</code> member of the options object, or use
489 <code>getVoices</code> to choose a voice that has the events you need. 490 <code>getVoices()</code> to choose a voice that meets your requirements.
490 Both are documented below. 491 Both are documented below.</p>
491 492
492 </p><h2 id="ssml">SSML markup</h2> 493 <h2 id="ssml">SSML markup</h2>
493 494
494 <p>Utterances used in this API may include markup using the 495 <p>Utterances used in this API may include markup using the
495 <a href="http://www.w3.org/TR/speech-synthesis">Speech Synthesis Markup 496 <a href="http://www.w3.org/TR/speech-synthesis">Speech Synthesis Markup
496 Language (SSML)</a>. If you use SSML, the first argument to 497 Language (SSML)</a>. If you use SSML, the first argument to
497 <code>speak()</code> should be a complete SSML document with an XML 498 <code>speak()</code> should be a complete SSML document with an XML
498 header and a top-level <code>&lt;speak&gt;</code> tag, not a document 499 header and a top-level <code>&lt;speak&gt;</code> tag, not a document
499 fragment. 500 fragment.</p>
500 501
501 For example: 502 <p>For example:</p>
502 503
503 </p><pre>chrome.experimental.tts.speak( 504 <pre>chrome.experimental.tts.speak(
504 '&lt;?xml version="1.0"?&gt;' + 505 '&lt;?xml version="1.0"?&gt;' +
505 '&lt;speak&gt;' + 506 '&lt;speak&gt;' +
506 ' The &lt;emphasis&gt;second&lt;/emphasis&gt; ' + 507 ' The &lt;emphasis&gt;second&lt;/emphasis&gt; ' +
507 ' word of this sentence was emphasized.' + 508 ' word of this sentence was emphasized.' +
508 '&lt;/speak&gt;');</pre> 509 '&lt;/speak&gt;');</pre>
509 510
510 <p>Not all speech engines will support all SSML tags, and some may not support 511 <p>Not all speech engines will support all SSML tags, and some may not support
511 SSML at all, but all engines are required to ignore any SSML they don't 512 SSML at all, but all engines are required to ignore any SSML they don't
512 support and still speak the underlying text.</p> 513 support and to still speak the underlying text.</p>
513 514
514 <h2 id="choosing_voice">Choosing a voice</h2> 515 <h2 id="choosing_voice">Choosing a voice</h2>
515 516
516 <p>By default, Chrome will choose the most appropriate voice for each 517 <p>By default, Chrome chooses the most appropriate voice for each
517 utterance you want to speak, based on the language and gender. On most 518 utterance you want to speak, based on the language and gender. On most
518 Windows, Mac OS X, and Chrome OS systems, speech synthesis provided by 519 Windows, Mac OS X, and Chrome OS systems, speech synthesis provided by
519 the operating system should be able to speak any text in at least one 520 the operating system should be able to speak any text in at least one
520 language. Some users may have a variety of voices available, though, 521 language. Some users may have a variety of voices available, though,
521 from their operating system and from speech engines implemented by other 522 from their operating system and from speech engines implemented by other
522 Chrome extensions. In those cases, you can implement custom code to choose 523 Chrome extensions. In those cases, you can implement custom code to choose
523 the appropriate voice, or present the user with a list of choices.</p> 524 the appropriate voice, or to present the user with a list of choices.</p>
524 525
525 <p>To get a list of all voices, call <code>getVoices()</code> and pass it 526 <p>To get a list of all voices, call <code>getVoices()</code> and pass it
526 a function that receives an array of <code>TtsVoice</code> objects as its 527 a function that receives an array of <code>TtsVoice</code> objects as its
527 argument:</p> 528 argument:</p>
528 529
529 <pre>chrome.experimental.tts.getVoices( 530 <pre>chrome.experimental.tts.getVoices(
530 function(voices) { 531 function(voices) {
531 for (var i = 0; i &lt; voices.length; i++) { 532 for (var i = 0; i &lt; voices.length; i++) {
532 console.log('Voice ' + i + ':'); 533 console.log('Voice ' + i + ':');
533 console.log(' name: ' + voices[i].voiceName); 534 console.log(' name: ' + voices[i].voiceName);
(...skipping 479 matching lines...) Expand 10 before | Expand all | Expand 10 after
1013 </span> 1014 </span>
1014 </span> 1015 </span>
1015 ) 1016 )
1016 </div> 1017 </div>
1017 1018
1018 </em> 1019 </em>
1019 </dt> 1020 </dt>
1020 <dd class="todo" style="display: none; "> 1021 <dd class="todo" style="display: none; ">
1021 Undocumented. 1022 Undocumented.
1022 </dd> 1023 </dd>
1023 <dd>The text to speak, either plaintext or a complete well-formed SSML document. Speech engines that do not support SSML will strip away the tags and speak the text. The maximum length of the text is 32,768 characters.</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>
1024 <dd style="display: none; "> 1025 <dd style="display: none; ">
1025 This parameter was added in version 1026 This parameter was added in version
1026 <b><span></span></b>. 1027 <b><span></span></b>.
1027 You must omit this parameter in earlier versions, 1028 You must omit this parameter in earlier versions,
1028 and you may omit it in any version. If you require this 1029 and you may omit it in any version. If you require this
1029 parameter, the manifest key 1030 parameter, the manifest key
1030 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1031 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1031 can ensure that your extension won't be run in an earlier browser ve rsion. 1032 can ensure that your extension won't be run in an earlier browser ve rsion.
1032 </dd> 1033 </dd>
1033 1034
(...skipping 228 matching lines...) Expand 10 before | Expand all | Expand 10 after
1262 </span> 1263 </span>
1263 </span> 1264 </span>
1264 ) 1265 )
1265 </div> 1266 </div>
1266 1267
1267 </em> 1268 </em>
1268 </dt> 1269 </dt>
1269 <dd class="todo" style="display: none; "> 1270 <dd class="todo" style="display: none; ">
1270 Undocumented. 1271 Undocumented.
1271 </dd> 1272 </dd>
1272 <dd>The specific extension ID of the speech engine to use, if known.</ dd> 1273 <dd>The extension ID of the speech engine to use, if known.</dd>
1273 <dd style="display: none; "> 1274 <dd style="display: none; ">
1274 This parameter was added in version 1275 This parameter was added in version
1275 <b><span></span></b>. 1276 <b><span></span></b>.
1276 You must omit this parameter in earlier versions, 1277 You must omit this parameter in earlier versions,
1277 and you may omit it in any version. If you require this 1278 and you may omit it in any version. If you require this
1278 parameter, the manifest key 1279 parameter, the manifest key
1279 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1280 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1280 can ensure that your extension won't be run in an earlier browser ve rsion. 1281 can ensure that your extension won't be run in an earlier browser ve rsion.
1281 </dd> 1282 </dd>
1282 1283
(...skipping 47 matching lines...) Expand 10 before | Expand all | Expand 10 after
1330 </span> 1331 </span>
1331 </span> 1332 </span>
1332 ) 1333 )
1333 </div> 1334 </div>
1334 1335
1335 </em> 1336 </em>
1336 </dt> 1337 </dt>
1337 <dd class="todo" style="display: none; "> 1338 <dd class="todo" style="display: none; ">
1338 Undocumented. 1339 Undocumented.
1339 </dd> 1340 </dd>
1340 <dd>The language to be used for synthesis, in the form &lt;language&gt ;-&lt;region&gt;. Examples: 'en', 'en-US', 'en-GB', 'zh-CN', etc.</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>
1341 <dd style="display: none; "> 1342 <dd style="display: none; ">
1342 This parameter was added in version 1343 This parameter was added in version
1343 <b><span></span></b>. 1344 <b><span></span></b>.
1344 You must omit this parameter in earlier versions, 1345 You must omit this parameter in earlier versions,
1345 and you may omit it in any version. If you require this 1346 and you may omit it in any version. If you require this
1346 parameter, the manifest key 1347 parameter, the manifest key
1347 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1348 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1348 can ensure that your extension won't be run in an earlier browser ve rsion. 1349 can ensure that your extension won't be run in an earlier browser ve rsion.
1349 </dd> 1350 </dd>
1350 1351
(...skipping 115 matching lines...) Expand 10 before | Expand all | Expand 10 after
1466 </span> 1467 </span>
1467 </span> 1468 </span>
1468 ) 1469 )
1469 </div> 1470 </div>
1470 1471
1471 </em> 1472 </em>
1472 </dt> 1473 </dt>
1473 <dd class="todo" style="display: none; "> 1474 <dd class="todo" style="display: none; ">
1474 Undocumented. 1475 Undocumented.
1475 </dd> 1476 </dd>
1476 <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 would be twic e as fast, and 0.5 would be half as fast. Values below 0.1 or above 10.0 are str ictly disallowed, but many voices will constrain the minimum and maximum rates f urther - i.e. a particular voice may not actually speak faster than 3 times norm al even if you specify a value larger than 3.0.</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>
1477 <dd style="display: none; "> 1478 <dd style="display: none; ">
1478 This parameter was added in version 1479 This parameter was added in version
1479 <b><span></span></b>. 1480 <b><span></span></b>.
1480 You must omit this parameter in earlier versions, 1481 You must omit this parameter in earlier versions,
1481 and you may omit it in any version. If you require this 1482 and you may omit it in any version. If you require this
1482 parameter, the manifest key 1483 parameter, the manifest key
1483 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1484 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1484 can ensure that your extension won't be run in an earlier browser ve rsion. 1485 can ensure that your extension won't be run in an earlier browser ve rsion.
1485 </dd> 1486 </dd>
1486 1487
(...skipping 47 matching lines...) Expand 10 before | Expand all | Expand 10 after
1534 </span> 1535 </span>
1535 </span> 1536 </span>
1536 ) 1537 )
1537 </div> 1538 </div>
1538 1539
1539 </em> 1540 </em>
1540 </dt> 1541 </dt>
1541 <dd class="todo" style="display: none; "> 1542 <dd class="todo" style="display: none; ">
1542 Undocumented. 1543 Undocumented.
1543 </dd> 1544 </dd>
1544 <dd>Speaking pitch between 0 and 2 inclusive, with 0 being lowest and 1 being highest, with 1.0 being the default pitch of this particular voice.</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>
1545 <dd style="display: none; "> 1546 <dd style="display: none; ">
1546 This parameter was added in version 1547 This parameter was added in version
1547 <b><span></span></b>. 1548 <b><span></span></b>.
1548 You must omit this parameter in earlier versions, 1549 You must omit this parameter in earlier versions,
1549 and you may omit it in any version. If you require this 1550 and you may omit it in any version. If you require this
1550 parameter, the manifest key 1551 parameter, the manifest key
1551 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1552 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1552 can ensure that your extension won't be run in an earlier browser ve rsion. 1553 can ensure that your extension won't be run in an earlier browser ve rsion.
1553 </dd> 1554 </dd>
1554 1555
(...skipping 126 matching lines...) Expand 10 before | Expand all | Expand 10 after
1681 </span> 1682 </span>
1682 </span> 1683 </span>
1683 ) 1684 )
1684 </div> 1685 </div>
1685 1686
1686 </em> 1687 </em>
1687 </dt> 1688 </dt>
1688 <dd class="todo" style="display: none; "> 1689 <dd class="todo" style="display: none; ">
1689 Undocumented. 1690 Undocumented.
1690 </dd> 1691 </dd>
1691 <dd>The TTS event types the voice must support. If missing, this crite ria will not be used to filter voices.</dd> 1692 <dd>The TTS event types the voice must support.</dd>
1692 <dd style="display: none; "> 1693 <dd style="display: none; ">
1693 This parameter was added in version 1694 This parameter was added in version
1694 <b><span></span></b>. 1695 <b><span></span></b>.
1695 You must omit this parameter in earlier versions, 1696 You must omit this parameter in earlier versions,
1696 and you may omit it in any version. If you require this 1697 and you may omit it in any version. If you require this
1697 parameter, the manifest key 1698 parameter, the manifest key
1698 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1699 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1699 can ensure that your extension won't be run in an earlier browser ve rsion. 1700 can ensure that your extension won't be run in an earlier browser ve rsion.
1700 </dd> 1701 </dd>
1701 1702
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after
1760 </span> 1761 </span>
1761 </span> 1762 </span>
1762 ) 1763 )
1763 </div> 1764 </div>
1764 1765
1765 </em> 1766 </em>
1766 </dt> 1767 </dt>
1767 <dd class="todo" style="display: none; "> 1768 <dd class="todo" style="display: none; ">
1768 Undocumented. 1769 Undocumented.
1769 </dd> 1770 </dd>
1770 <dd>The TTS event types that should be sent. If missing, all event typ es will be sent.</dd> 1771 <dd>The TTS event types that you are interested in listening to. If mi ssing, all event types may be sent.</dd>
1771 <dd style="display: none; "> 1772 <dd style="display: none; ">
1772 This parameter was added in version 1773 This parameter was added in version
1773 <b><span></span></b>. 1774 <b><span></span></b>.
1774 You must omit this parameter in earlier versions, 1775 You must omit this parameter in earlier versions,
1775 and you may omit it in any version. If you require this 1776 and you may omit it in any version. If you require this
1776 parameter, the manifest key 1777 parameter, the manifest key
1777 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1778 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1778 can ensure that your extension won't be run in an earlier browser ve rsion. 1779 can ensure that your extension won't be run in an earlier browser ve rsion.
1779 </dd> 1780 </dd>
1780 1781
(...skipping 19 matching lines...) Expand all
1800 1801
1801 <!-- FUNCTION PARAMETERS --> 1802 <!-- FUNCTION PARAMETERS -->
1802 <dd style="display: none; "> 1803 <dd style="display: none; ">
1803 <div></div> 1804 <div></div>
1804 </dd> 1805 </dd>
1805 1806
1806 </div> 1807 </div>
1807 </div><div> 1808 </div><div>
1808 <div> 1809 <div>
1809 <dt> 1810 <dt>
1810 <var>onevent</var> 1811 <var>onEvent</var>
1811 <em> 1812 <em>
1812 1813
1813 <!-- TYPE --> 1814 <!-- TYPE -->
1814 <div style="display:inline"> 1815 <div style="display:inline">
1815 ( 1816 (
1816 <span class="optional">optional</span> 1817 <span class="optional">optional</span>
1817 <span class="enum" style="display: none; ">enumerated</span> 1818 <span class="enum" style="display: none; ">enumerated</span>
1818 <span id="typeTemplate"> 1819 <span id="typeTemplate">
1819 <span style="display: none; "> 1820 <span style="display: none; ">
1820 <a> Type</a> 1821 <a> Type</a>
(...skipping 168 matching lines...) Expand 10 before | Expand all | Expand 10 after
1989 </span> 1990 </span>
1990 </span> 1991 </span>
1991 ) 1992 )
1992 </div> 1993 </div>
1993 1994
1994 </em> 1995 </em>
1995 </dt> 1996 </dt>
1996 <dd class="todo" style="display: none; "> 1997 <dd class="todo" style="display: none; ">
1997 Undocumented. 1998 Undocumented.
1998 </dd> 1999 </dd>
1999 <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> 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>
2000 <dd style="display: none; "> 2001 <dd style="display: none; ">
2001 This parameter was added in version 2002 This parameter was added in version
2002 <b><span></span></b>. 2003 <b><span></span></b>.
2003 You must omit this parameter in earlier versions, 2004 You must omit this parameter in earlier versions,
2004 and you may omit it in any version. If you require this 2005 and you may omit it in any version. If you require this
2005 parameter, the manifest key 2006 parameter, the manifest key
2006 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2007 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2007 can ensure that your extension won't be run in an earlier browser ve rsion. 2008 can ensure that your extension won't be run in an earlier browser ve rsion.
2008 </dd> 2009 </dd>
2009 2010
(...skipping 270 matching lines...) Expand 10 before | Expand all | Expand 10 after
2280 </span> 2281 </span>
2281 </span> 2282 </span>
2282 ) 2283 )
2283 </div> 2284 </div>
2284 2285
2285 </em> 2286 </em>
2286 </dt> 2287 </dt>
2287 <dd class="todo" style="display: none; "> 2288 <dd class="todo" style="display: none; ">
2288 Undocumented. 2289 Undocumented.
2289 </dd> 2290 </dd>
2290 <dd>The message can be 'start' when this utterance is begun to be spok en, 'word' when a word boundary is reached, 'sentence' when a sentence boundary is reached, 'marker' when an SSML mark element is reached, 'end' when the end of the utterance is reached, 'interrupted' when the utterance is stopped or interr upted before reaching the end, 'cancelled' when it's removed from the queue befo re ever being synthesized, and 'error' when any other error occurs. Clients will always receive 'end', 'cancelled', 'interrupted', or 'error', and other events will depend on the engine.</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>
2291 <dd style="display: none; "> 2292 <dd style="display: none; ">
2292 This parameter was added in version 2293 This parameter was added in version
2293 <b><span></span></b>. 2294 <b><span></span></b>.
2294 You must omit this parameter in earlier versions, 2295 You must omit this parameter in earlier versions,
2295 and you may omit it in any version. If you require this 2296 and you may omit it in any version. If you require this
2296 parameter, the manifest key 2297 parameter, the manifest key
2297 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2298 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2298 can ensure that your extension won't be run in an earlier browser ve rsion. 2299 can ensure that your extension won't be run in an earlier browser ve rsion.
2299 </dd> 2300 </dd>
2300 2301
(...skipping 115 matching lines...) Expand 10 before | Expand all | Expand 10 after
2416 </span> 2417 </span>
2417 </span> 2418 </span>
2418 ) 2419 )
2419 </div> 2420 </div>
2420 2421
2421 </em> 2422 </em>
2422 </dt> 2423 </dt>
2423 <dd class="todo" style="display: none; "> 2424 <dd class="todo" style="display: none; ">
2424 Undocumented. 2425 Undocumented.
2425 </dd> 2426 </dd>
2426 <dd>The error message, if the message is 'error'.</dd> 2427 <dd>The error description, if the event type is 'error'.</dd>
2427 <dd style="display: none; "> 2428 <dd style="display: none; ">
2428 This parameter was added in version 2429 This parameter was added in version
2429 <b><span></span></b>. 2430 <b><span></span></b>.
2430 You must omit this parameter in earlier versions, 2431 You must omit this parameter in earlier versions,
2431 and you may omit it in any version. If you require this 2432 and you may omit it in any version. If you require this
2432 parameter, the manifest key 2433 parameter, the manifest key
2433 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2434 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2434 can ensure that your extension won't be run in an earlier browser ve rsion. 2435 can ensure that your extension won't be run in an earlier browser ve rsion.
2435 </dd> 2436 </dd>
2436 2437
(...skipping 184 matching lines...) Expand 10 before | Expand all | Expand 10 after
2621 </span> 2622 </span>
2622 </span> 2623 </span>
2623 ) 2624 )
2624 </div> 2625 </div>
2625 2626
2626 </em> 2627 </em>
2627 </dt> 2628 </dt>
2628 <dd class="todo" style="display: none; "> 2629 <dd class="todo" style="display: none; ">
2629 Undocumented. 2630 Undocumented.
2630 </dd> 2631 </dd>
2631 <dd>The language that this voice supports, in the form &lt;language&gt ;-&lt;region&gt;. Examples: 'en', 'en-US', 'en-GB', 'zh-CN', etc.</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>
2632 <dd style="display: none; "> 2633 <dd style="display: none; ">
2633 This parameter was added in version 2634 This parameter was added in version
2634 <b><span></span></b>. 2635 <b><span></span></b>.
2635 You must omit this parameter in earlier versions, 2636 You must omit this parameter in earlier versions,
2636 and you may omit it in any version. If you require this 2637 and you may omit it in any version. If you require this
2637 parameter, the manifest key 2638 parameter, the manifest key
2638 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 2639 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
2639 can ensure that your extension won't be run in an earlier browser ve rsion. 2640 can ensure that your extension won't be run in an earlier browser ve rsion.
2640 </dd> 2641 </dd>
2641 2642
(...skipping 297 matching lines...) Expand 10 before | Expand all | Expand 10 after
2939 _uff=0; 2940 _uff=0;
2940 urchinTracker(); 2941 urchinTracker();
2941 } 2942 }
2942 catch(e) {/* urchinTracker not available. */} 2943 catch(e) {/* urchinTracker not available. */}
2943 </script> 2944 </script>
2944 <!-- end analytics --> 2945 <!-- end analytics -->
2945 </div> 2946 </div>
2946 </div> <!-- /gc-footer --> 2947 </div> <!-- /gc-footer -->
2947 </div> <!-- /gc-container --> 2948 </div> <!-- /gc-container -->
2948 </body></html> 2949 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/api/extension_api.json ('k') | chrome/common/extensions/docs/experimental.ttsEngine.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698