chrome/common/extensions/docs/experimental.tts.html - Issue 7282048: Update TTS extension API docs to reflect latest changes. Note that this

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/docs/experimental.html ('k') | chrome/common/extensions/docs/experimental.tts_engine.html » ('j') | chrome/common/extensions/docs/experimental.tts_engine.html » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
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 254 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
265 </li>	265 </li>

266 </ol>	266 </ol>

267 </li><li>	267 </li><li>

268 <a href="#generating_speech">Generating speech</a>	268 <a href="#generating_speech">Generating speech</a>

269 <ol>	269 <ol>

270 <li style="display: none; ">	270 <li style="display: none; ">

271 <a>h3Name</a>	271 <a>h3Name</a>

272 </li>	272 </li>

273 </ol>	273 </ol>

274 </li><li>	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>

275 <a href="#ssml">SSML markup</a>	282 <a href="#ssml">SSML markup</a>

276 <ol>	283 <ol>

277 <li style="display: none; ">	284 <li style="display: none; ">

278 <a>h3Name</a>	285 <a>h3Name</a>

279 </li>	286 </li>

280 </ol>	287 </ol>

281 </li><li>	288 </li><li>

282 <a href="#provider">Implementing a speech provider</a>	289 <a href="#choosing_voice">Choosing a voice</a>

283 <ol>	290 <ol>

284 <li style="display: none; ">	291 <li style="display: none; ">

285 <a>h3Name</a>	292 <a>h3Name</a>

286 </li>	293 </li>

287 </ol>	294 </ol>

288 </li>	295 </li>

289 <li>	296 <li>

290 <a href="#apiReference">API reference: chrome.experimental.tts</ a>	297 <a href="#apiReference">API reference: chrome.experimental.tts</ a>

291 <ol>	298 <ol>

292 <li style="display: none; ">	299 <li style="display: none; ">

293 <a href="#properties">Properties</a>	300 <a href="#properties">Properties</a>

294 <ol>	301 <ol>

295 <li>	302 <li>

296 <a href="#property-anchor">propertyName</a>	303 <a href="#property-anchor">propertyName</a>

297 </li>	304 </li>

298 </ol>	305 </ol>

299 </li>	306 </li>

300 <li>	307 <li>

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

302 <ol>	309 <ol>

303 <li>	310 <li>

	311 <a href="#method-getVoices">getVoices</a>

	312 </li><li>

304 <a href="#method-isSpeaking">isSpeaking</a>	313 <a href="#method-isSpeaking">isSpeaking</a>

305 </li><li>	314 </li><li>

306 <a href="#method-speak">speak</a>	315 <a href="#method-speak">speak</a>

307 </li><li style="display: none; ">

308 <a href="#method-anchor">methodName</a>

309 </li><li>	316 </li><li>

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

311 </li>	318 </li>

312 </ol>	319 </ol>

313 </li>	320 </li>

314 <li>	321 <li style="display: none; ">

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

316 <ol>	323 <ol>

317 <li>	324 <li>

318 <a href="#event-onSpeak">onSpeak</a>	325 <a href="#event-anchor">eventName</a>

319 </li><li>

320 <a href="#event-onStop">onStop</a>

321 </li>	326 </li>

322 </ol>	327 </ol>

323 </li>	328 </li>

324 <li style="display: none; ">	329 <li>

325 <a href="#types">Types</a>	330 <a href="#types">Types</a>

326 <ol>	331 <ol>

327 <li>	332 <li>

328 <a href="#id-anchor">id</a>	333 <a href="#type-TtsEvent">TtsEvent</a>

	334 </li><li>

	335 <a href="#type-TtsVoice">TtsVoice</a>

329 </li>	336 </li>

330 </ol>	337 </ol>

331 </li>	338 </li>

332 </ol>	339 </ol>

333 </li>	340 </li>

334 </ol>	341 </ol>

335 </div>	342 </div>

336 <!-- /TABLE OF CONTENTS -->	343 <!-- /TABLE OF CONTENTS -->

337	344

338 <!-- Standard content lead-in for experimental API pages -->	345 <!-- Standard content lead-in for experimental API pages -->

339 <p id="classSummary">	346 <p id="classSummary">

340 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.

341 </p>	348 </p>

342	349

343 <!-- STATIC CONTENT PLACEHOLDER -->	350 <!-- STATIC CONTENT PLACEHOLDER -->

344 <div id="static"><p id="classSummary">	351 <div id="static"><p id="classSummary">

345 Use the <code>chrome.experimental.tts</code> module to play synthesized	352 Use the <code>chrome.experimental.tts</code> module to play synthesized

346 text-to-speech (TTS) from your extension or packaged app, or to register	353 text-to-speech (TTS) from your extension or packaged app.

347 as a speech provider for other extensions and packaged apps that want to speak.	354 See also the related

	355 <a href="experimental.tts_engine.html">experimental.tts_engine</a>

	356 module which allows an extension to implement a speech engine.
	kathyw 2011/07/13 20:39:58 which allows -> , which allows In general, you sh which allows -> , which allows In general, you should put a comma before "which" in a phrase like this, so it's clear that it's a parenthetical phrase -- one that adds information but could be removed without changing the meaning of the sentence. The exception is when you could change the "which" to "that", in which case you should just use "that". (But ", which" is what we want in this case.) dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > which allows -> , which allows > > In general, you should put a comma before "which" in a phrase like this, > so it's clear that it's a parenthetical phrase -- one that adds information > but could be removed without changing the meaning of the sentence. > > The exception is when you could change the "which" to "that", in which > case you should just use "that". (But ", which" is what we want in this case.) Done.
348 </p>	357 </p>

349	358

350 <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,

351 especially changes that should be made before stabilizing the first	360 especially changes that should be made before stabilizing the first

352 version of this API, please send your ideas to the	361 version of this API, please send your ideas to the

353 <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>

354 group.</p>	363 group.</p>

355	364

356 <h2 id="overview">Overview</h2>	365 <h2 id="overview">Overview</h2>

357	366

358 <p>To enable this experimental API, visit	367 <p>To enable this experimental API, visit

359 <b>chrome://flags</b> and enable <b>Experimental Extension APIs</b>.	368 <b>chrome://flags</b> and enable <b>Experimental Extension APIs</b>.

360	369

361 </p><p>Chrome provides native support for speech on Windows (using SAPI	370 </p><p>Chrome provides native support for speech on Windows (using SAPI

362 5), Mac OS X, and Chrome OS, using speech synthesis capabilities	371 5), Mac OS X, and Chrome OS, using speech synthesis capabilities

363 provided by the operating system. On all platforms, the user can	372 provided by the operating system. On all platforms, the user can

364 install extensions that register themselves as alternative speech	373 install extensions that register themselves as alternative speech

365 synthesis providers.</p>	374 engines.</p>

366	375

367 <h2 id="generating_speech">Generating speech</h2>	376 <h2 id="generating_speech">Generating speech</h2>

368	377

369 <p>Call <code>speak()</code> from your extension or	378 <p>Call <code>speak()</code> from your extension or

370 packaged app to speak. For example:</p>	379 packaged app to speak. For example:</p>

371	380

372 <pre>chrome.experimental.tts.speak('Hello, world.');</pre>	381 <pre>chrome.experimental.tts.speak('Hello, world.');</pre>

373	382

	383 <p>To stop speaking immediately, just call <code>stop()</code>:

	384

	385 </p><pre>chrome.experimental.tts.stop();</pre>

	386

374 <p>You can provide options that control various properties of the speech,	387 <p>You can provide options that control various properties of the speech,

375 such as its rate, pitch, and more. For example:</p>	388 such as its rate, pitch, and more. For example:</p>

376	389

377 <pre>chrome.experimental.tts.speak('Hello, world.', {'rate': 0.8});</pre>	390 <pre>chrome.experimental.tts.speak('Hello, world.', {'rate': 2.0});</pre>

378	391

379 <p>It's also a good idea to specify the locale so that a synthesizer	392 <p>It's also a good idea to specify the language so that a synthesizer

380 supporting that language (and regional dialect, if applicable) is chosen.</p>	393 supporting that language (and regional dialect, if applicable) is chosen.</p>

381	394

382 <pre>chrome.experimental.tts.speak(	395 <pre>chrome.experimental.tts.speak(

383 'Hello, world.',	396 'Hello, world.', {'lang': 'en-US', 'rate': 2.0});</pre>

384 {	397

385 'locale': 'en-US',	398 <p>By default, each call to <code>speak()</code> will interrupt any
	kathyw 2011/07/13 20:39:58 will interrupt -> interrupts (general rule: stick will interrupt -> interrupts (general rule: stick to present tense whenever you can) dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > will interrupt -> interrupts > > (general rule: stick to present tense whenever you can) Done.
386 'rate': 0.8	399 ongoing speech and speak immediately. To determine if a call would be
	kathyw 2011/07/13 20:39:58 speak -> speaks speak -> speaks dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > speak -> speaks Done.
	400 interrupting anything, you can call <code>isSpeaking()</code>, or
	kathyw 2011/07/13 20:39:58 The "or" makes it sound like enqueue tells you whe The "or" makes it sound like enqueue tells you when you're interrupting something. How about instead: ...you can call isSpeaking. Alternatively, you can use... dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > The "or" makes it sound like enqueue tells you when you're interrupting > something. How about instead: > > ...you can call isSpeaking. > Alternatively, you can use... Done.
	401 you can use the <code>enqueue</code> option to cause this utterance to

	402 be added to a queue of utterances that will be spoken when the current

	403 utterance has finished.

	404

	405 </p><pre>chrome.experimental.tts.speak(

	406 'Speak this first.');

	407 chrome.experimental.tts.speak(

	408 'Speak this next, when the first sentence is done.', {'enqueue': true});

	409 </pre>

	410

	411 <p>A complete description of all options can be found in the

	412 <a href="#method-speak">speak() method documentation</a> below.

	413 Not all speech engines will support all options.</p>

	414

	415 <p>To catch errors and make sure you're calling <code>speak()</code>

	416 correctly, pass a callback function that takes no arguments. Inside

	417 the callback, check

	418 <a href="extension.html#property-lastError">chrome.extension.lastError</a>

	419 to see if there were any errors.</p>

	420

	421 <pre>chrome.experimental.tts.speak(

	422 utterance,

	423 options,

	424 function() {

	425 if (chrome.extension.lastError) {

	426 console.log('Error: ' + chrome.extension.lastError.message);

	427 }

387 });</pre>	428 });</pre>

388	429

389 <p>Not all speech engines will support all options.</p>	430 <p>The callback returns right away, before the speech engine has started

	431 generating speech. The purpose of the callback is to alert you to syntax

	432 errors in your use of the TTS API, not all possible errors that might occur
	kathyw 2011/07/13 20:39:58 Needs parallelism: not all -> not to all or not a Needs parallelism: not all -> not to all or not all -> not to catch all dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > Needs parallelism: > > not all -> not to all > or > not all -> not to catch all Done.
	433 in the process of synthesizing and outputting speech. To catch these errors

	434 too, you need to use an event listener, described below.

390	435

391 <p>You can also pass a callback function that will be called when the	436 </p><h2 id="events">Listening to events</h2>

392 speech has finished. For example, suppose we have an image on our page

393 displaying a picture of a face with a closed mouth. We could open the mouth

394 while speaking, and close it when done.</p>

395	437

396 <pre>faceImage.src = 'open_mouth.png';	438 <p>To get more real-time information about the status of synthesized speech,

397 chrome.experimental.tts.speak(	439 pass an event listener in the options to <code>speak()</code>, like this:</p>

398 'Hello, world.', null, function() {

399 faceImage.src = 'closed_mouth.png';

400 });

401 </pre>

402	440

403 <p>To stop speaking immediately, just call <code>stop()</code>. Call	441 <pre>chrome.experimental.tts.speak(

404 <code>isSpeaking()</code> to find out if a TTS engine is currently speaking.</p>	442 utterance, {

	443 'onevent': function(event) {

	444 console.log('Event ' + event.type ' at position ' + event.charIndex);

	445 if (event.type == 'error') {

	446 console.log('Error: ' + event.errorMessage);

	447 }

	448 }

	449 },

	450 callback);</pre>

405	451

406 <p>You can check to see if an error occurred by checking	452 <p>Each event includes an event type, the character index of the current

407 <code>chrome.extension.lastError</code> inside the callback function.</p>	453 speech relative to the utterance, and for error events, an optional

	454 error message. The event types are:</p>

408	455

409 <h2 id="ssml">SSML markup</h2>	456 <ul>

	457 <li><code>'start'</code>: the engine has started speaking the utterance.
	kathyw 2011/07/13 20:39:58 the -> The [do the same for all the following lis the -> The [do the same for all the following list items -- capitalize the letter that follows the ':'] dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > the -> The > > [do the same for all the following list items -- capitalize the letter that > follows the ':'] Done.
	458 </li><li><code>'word'</code>: a word boundary was reached. Use

	459 <code>event.charIndex</code> to determine the current speech

	460 position.

	461 </li><li><code>'sentence'</code>: a sentence boundary was reached. Use

	462 <code>event.charIndex</code> to determine the current speech

	463 position.

	464 </li><li><code>'marker'</code>: an SSML marker was reached. Use

	465 <code>event.charIndex</code> to determine the current speech

	466 position.

	467 </li><li><code>'end'</code>: the engine has finished speaking the utterance.

	468 </li><li><code>'interrupted'</code>: this utterance was interrupted by another

	469 call to <code>speak()</code> or <code>stop()</code> and did not

	470 finish.

	471 </li><li><code>'cancelled'</code>: this utterance was cancelled by another

	472 call to <code>speak()</code> or <code>stop()</code> and never

	473 began to speak at all.

	474 </li><li><code>'error'</code>: An engine-specific error occurred and

	475 this utterance cannot be spoken.

	476 Check <code>event.errorMessage</code> for details.

	477 </li></ul>

	478

	479 <p>Four of the event types, <code>'end'</code>, <code>'interrupted'</code>,
	kathyw 2011/07/13 20:39:58 It'd be easier to read this list if it were set of It'd be easier to read this list if it were set off by dashes. So: event types, <code> -> event types—<code> dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > It'd be easier to read this list if it were set off by dashes. So: > > event types, <code> > -> > event types—<code> Done.
	480 <code>'cancelled'</code>, and <code>'error'</code>, are <i>final</i>. After
	kathyw 2011/07/13 20:39:58 , are -> —are , are -> —are dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > , are > -> > —are Done.
	481 one of those events is received, this utterance will no longer speak and

	482 no new events from this utterance will be received.</p>

	483

	484 <p>Some TTS engines may not support all event types, and some may not even

	485 support any events at all. To require that the speech engine used sends
	kathyw 2011/07/13 20:39:58 "used sends" is a little hard to parse. How about: "used sends" is a little hard to parse. How about: To require that the speech engine used sends -> To make sure that the speech engine can send It's not quite as precise, but maybe that's OK here in descriptive text. Or we could spend a little more time and come up with something better. dmazzoni 2011/07/14 06:50:55 I tried to word it, how's this? Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > "used sends" is a little hard to parse. How about: > > To require that the speech engine used sends > -> > To make sure that the speech engine can send > > It's not quite as precise, but maybe that's OK here in descriptive text. Or we > could spend a little more time and come up with something better. I tried to word it, how's this? kathyw 2011/07/14 16:13:23 Good. I like the new text. Good. I like the new text.
	486 the events you're interested in, you can pass a list of event types in

	487 the <code>requiredEventTypes</code> member of the options object, or use

	488 <code>getVoices</code> to choose a voice that has the events you need.
	kathyw 2011/07/13 20:39:58 getVoices -> getVoices() getVoices -> getVoices() dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > getVoices -> getVoices() Done.
	489 Both are documented below.

	490

	491 </p><h2 id="ssml">SSML markup</h2>
	kathyw 2011/07/13 20:39:58 This looks like a generator-inserted </p>. Could y This looks like a generator-inserted </p>. Could you add/move it right after the paragraph? dmazzoni 2011/07/14 06:50:55 Strange, it doesn't look that way in the source. S Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > This looks like a generator-inserted </p>. Could you add/move it right after the > paragraph? Strange, it doesn't look that way in the source. See static/experimental.tts.html kathyw 2011/07/14 16:13:23 I was looking at old diffs, so you might have fixe I was looking at old diffs, so you might have fixed it already.
410	492

411 <p>Utterances used in this API may include markup using the	493 <p>Utterances used in this API may include markup using the

412 <a href="http://www.w3.org/TR/speech-synthesis">Speech Synthesis Markup	494 <a href="http://www.w3.org/TR/speech-synthesis">Speech Synthesis Markup

413 Language (SSML)</a>. For example:	495 Language (SSML)</a>. If you use SSML, the first argument to

	496 <code>speak()</code> should be a complete SSML document with an XML

	497 header and a top-level <code><speak></code> tag, not a document

	498 fragment.
	kathyw 2011/07/13 20:39:58 Add a </p> here. Add a </p> here. dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > Add a </p> here. Done.
414	499

415 </p><pre>chrome.experimental.tts.speak('The <emphasis>second</emphasis& gt; word of this sentence was emphasized.');</pre>	500 For example:
	kathyw 2011/07/13 20:39:58 Add <p>...</p> before and after this line. Add <p>...</p> before and after this line. dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > Add <p>...</p> before and after this line. Done.
	501

	502 </p><pre>chrome.experimental.tts.speak(

	503 '<?xml version="1.0"?>' +

	504 '<speak>' +

	505 ' The <emphasis>second</emphasis> ' +

	506 ' word of this sentence was emphasized.' +

	507 '</speak>');</pre>

416	508

417 <p>Not all speech engines will support all SSML tags, and some may not support	509 <p>Not all speech engines will support all SSML tags, and some may not support

418 SSML at all, but all engines are expected to ignore any SSML they don't	510 SSML at all, but all engines are required to ignore any SSML they don't

419 support and still speak the underlying text.</p>	511 support and still speak the underlying text.</p>
	kathyw 2011/07/13 20:39:58 still speak -> to still speak (a little easier to still speak -> to still speak (a little easier to parse) dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > still speak -> to still speak > > (a little easier to parse) Done.
420	512

421 <h2 id="provider">Implementing a speech provider</h2>	513 <h2 id="choosing_voice">Choosing a voice</h2>

422	514

423 <p>An extension can register itself as a speech provider. By doing so, it	515 <p>By default, Chrome will choose the most appropriate voice for each
	kathyw 2011/07/13 20:39:58 will choose -> chooses will choose -> chooses dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > will choose -> chooses Done.
424 can intercept some or all calls to functions such as	516 utterance you want to speak, based on the language and gender. On most

425 <code>speak()</code> and <code>stop()</code> and provide an alternate	517 Windows, Mac OS X, and Chrome OS systems, speech synthesis provided by

426 implementation. Extensions are free to use any available web technology	518 the operating system should be able to speak any text in at least one

427 to provide speech, including streaming audio from a server, HTML5 audio,	519 language. Some users may have a variety of voices available, though,

428 Native Client, or Flash. An extension could even do something different	520 from their operating system and from speech engines implemented by other

429 with the utterances, like display closed captions in a pop-up window or	521 Chrome extensions. In those cases, you can implement custom code to choose

430 send them as log messages to a remote server.</p>	522 the appropriate voice, or present the user with a list of choices.</p>
	kathyw 2011/07/13 20:39:58 present -> to present present -> to present dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > present -> to present Done.
431	523

432 <p>To provide TTS, an extension must first declare all voices it provides	524 <p>To get a list of all voices, call <code>getVoices()</code> and pass it

433 in the extension manifest, like this:</p>	525 a function that receives an array of <code>TtsVoice</code> objects as its

	526 argument:</p>

434	527

435 <pre>{	528 <pre>chrome.experimental.tts.getVoices(

436 "name": "My TTS Provider",	529 function(voices) {

437 "version": "1.0",	530 for (var i = 0; i < voices.length; i++) {

438 <b>"permissions": ["experimental"]	531 console.log('Voice ' + i + ':');

439 "tts": {	532 console.log(' name: ' + voices[i].voiceName);

440 "voices": [	533 console.log(' lang: ' + voices[i].lang);

441 {	534 console.log(' gender: ' + voices[i].gender);

442 "voiceName": "Alice",	535 console.log(' extension id: ' + voices[i].extensionId);

443 "locale": "en-US",	536 console.log(' event types: ' + voices[i].eventTypes);

444 "gender": "female"

445 },

446 {

447 "voiceName": "Pat",

448 "locale": "en-US"

449 }	537 }

450 ]	538 });</pre>

451 },</b>

452 "background_page": "background.html",

453 }</pre>

454

455 <p>An extension can specify any number of voices. The three

456 parameters—<code>voiceName</code>, <code>locale</code>,

457 and <code>gender</code>—are all optional. If they are all unspecified,

458 the extension will handle all speech from all clients. If any of them

459 are specified, they can be used to filter speech requests. For

460 example, if a voice only supports French, it should set the locale to

461 'fr' (or something more specific like 'fr-FR') so that only utterances

462 in that locale are routed to that extension.</p>

463

464 <p>To handle speech calls, the extension should register listeners

465 for <code>onSpeak</code> and <code>onStop</code>, like this:</p>

466

467 <pre>var speakListener = function(utterance, options, callback) {

468 ...

469 callback();

470 };

471 var stopListener = function() {

472 ...

473 };

474 chrome.experimental.tts.onSpeak.addListener(speakListener);

475 chrome.experimental.tts.onStop.addListener(stopListener);</pre>

476

477 <p class="warning"><b>Important:</b> Don't forget to call the callback

478 function from your speak listener!</p>

479

480 <p>If an extension does not register listeners for both

481 <code>onSpeak</code> and <code>onStop</code>, it will not intercept any

482 speech calls, regardless of what is in the manifest.

483

484 </p><p>The decision of whether or not to send a given speech request to an

485 extension is based solely on whether the extension supports the given voice

486 parameters in its manifest and has registered listeners

487 for <code>onSpeak</code> and <code>onStop</code>. In other words,

488 there's no way for an extension to receive a speech request and

489 dynamically decide whether to handle it or not.</p>

490 </div>	539 </div>

491	540

492 <!-- API PAGE -->	541 <!-- API PAGE -->

493 <div class="apiPage">	542 <div class="apiPage">

494 <a name="apiReference"></a>	543 <a name="apiReference"></a>

495 <h2>API reference: chrome.experimental.tts</h2>	544 <h2>API reference: chrome.experimental.tts</h2>

496	545

497 <!-- PROPERTIES -->	546 <!-- PROPERTIES -->

498 <div class="apiGroup" style="display: none; ">	547 <div class="apiGroup" style="display: none; ">

499 <a name="properties"></a>	548 <a name="properties"></a>

(...skipping 12 matching lines...) Expand all Loading...
512	561

513 </div> <!-- /apiGroup -->	562 </div> <!-- /apiGroup -->

514	563

515 <!-- METHODS -->	564 <!-- METHODS -->

516 <div id="methodsTemplate" class="apiGroup">	565 <div id="methodsTemplate" class="apiGroup">

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

518 <h3>Methods</h3>	567 <h3>Methods</h3>

519	568

520 <!-- iterates over all functions -->	569 <!-- iterates over all functions -->

521 <div class="apiItem">	570 <div class="apiItem">

	571 <a name="method-getVoices"></a> <!-- method-anchor -->

	572 <h4>getVoices</h4>

	573

	574 <div class="summary"><span style="display: none; ">void</span>

	575 <!-- Note: intentionally longer 80 columns -->

	576 <span>chrome.experimental.tts.getVoices</span>(<span class="op tional"><span style="display: none; ">, </span><span>function</span>

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

	578

	579 <div class="description">

	580 <p class="todo" style="display: none; ">Undocumented.</p>

	581 <p>Get an array of all available voices.</p>

	582

	583 <!-- PARAMETERS -->

	584 <h4>Parameters</h4>

	585 <dl>

	586 <div>

	587 <div>

	588 <dt>

	589 <var>callback</var>

	590 <em>

	591

	592 <!-- TYPE -->

	593 <div style="display:inline">

	594 (

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

	596 <span class="enum" style="display: none; ">enumerated</span>

	597 <span id="typeTemplate">

	598 <span style="display: none; ">

	599 <a> Type</a>

	600 </span>

	601 <span>

	602 <span style="display: none; ">

	603 array of <span><span></span></span>

	604 </span>

	605 <span>function</span>

	606 <span style="display: none; "></span>

	607 </span>

	608 </span>

	609 )

	610 </div>

	611

	612 </em>

	613 </dt>

	614 <dd class="todo">

	615 Undocumented.

	616 </dd>

	617 <dd style="display: none; ">

	618 Description of this parameter from the json schema.

	619 </dd>

	620 <dd style="display: none; ">

	621 This parameter was added in version

	622 <b><span></span></b>.

	623 You must omit this parameter in earlier versions,

	624 and you may omit it in any version. If you require this

	625 parameter, the manifest key

	626 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

	627 can ensure that your extension won't be run in an earlier browser ve rsion.

	628 </dd>

	629

	630 <!-- OBJECT PROPERTIES -->

	631 <dd style="display: none; ">

	632 <dl>

	633 <div>

	634 <div>

	635 </div>

	636 </div>

	637 </dl>

	638 </dd>

	639

	640 <!-- OBJECT METHODS -->

	641 <dd style="display: none; ">

	642 <div></div>

	643 </dd>

	644

	645 <!-- OBJECT EVENT FIELDS -->

	646 <dd style="display: none; ">

	647 <div></div>

	648 </dd>

	649

	650 <!-- FUNCTION PARAMETERS -->

	651 <dd style="display: none; ">

	652 <div></div>

	653 </dd>

	654

	655 </div>

	656 </div>

	657 </dl>

	658

	659 <!-- RETURNS -->

	660 <h4 style="display: none; ">Returns</h4>

	661 <dl>

	662 <div style="display: none; ">

	663 <div>

	664 </div>

	665 </div>

	666 </dl>

	667

	668 <!-- CALLBACK -->

	669 <div>

	670 <div>

	671 <h4>Callback function</h4>

	672 <p style="display: none; ">

	673 The callback <em>parameter</em> should specify a function

	674 that looks like this:

	675 </p>

	676 <p>

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

	678 specify a function that looks like this:

	679 </p>

	680

	681 <!-- Note: intentionally longer 80 columns -->

	682 <pre>function(<span>array of TtsVoice voices</span>) <span cla ss="subdued">{...}</span>;</pre>

	683 <dl>

	684 <div>

	685 <div>

	686 <dt>

	687 <var>voices</var>

	688 <em>

	689

	690 <!-- TYPE -->

	691 <div style="display:inline">

	692 (

	693 <span class="optional" style="display: none; ">optional</spa n>

	694 <span class="enum" style="display: none; ">enumerated</span>

	695 <span id="typeTemplate">

	696 <span style="display: none; ">

	697 <a> Type</a>

	698 </span>

	699 <span>

	700 <span>

	701 array of <span><span>

	702 <span>

	703 <a href="experimental.tts.html#type-TtsVoice">TtsVoice</ a>

	704 </span>

	705 <span style="display: none; ">

	706 <span>

	707 array of <span><span></span></span>

	708 </span>

	709 <span>paramType</span>

	710 <span></span>

	711 </span>

	712 </span></span>

	713 </span>

	714 <span style="display: none; ">paramType</span>

	715 <span style="display: none; "></span>

	716 </span>

	717 </span>

	718 )

	719 </div>

	720

	721 </em>

	722 </dt>

	723 <dd class="todo" style="display: none; ">

	724 Undocumented.

	725 </dd>

	726 <dd>Array of <a href="experimental.tts.html#type-TtsVoice">TtsVoice</a > objects representing the available voices for speech synthesis.</dd>

	727 <dd style="display: none; ">

	728 This parameter was added in version

	729 <b><span></span></b>.

	730 You must omit this parameter in earlier versions,

	731 and you may omit it in any version. If you require this

	732 parameter, the manifest key

	733 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

	734 can ensure that your extension won't be run in an earlier browser ve rsion.

	735 </dd>

	736

	737 <!-- OBJECT PROPERTIES -->

	738 <dd style="display: none; ">

	739 <dl>

	740 <div>

	741 <div>

	742 </div>

	743 </div>

	744 </dl>

	745 </dd>

	746

	747 <!-- OBJECT METHODS -->

	748 <dd style="display: none; ">

	749 <div></div>

	750 </dd>

	751

	752 <!-- OBJECT EVENT FIELDS -->

	753 <dd style="display: none; ">

	754 <div></div>

	755 </dd>

	756

	757 <!-- FUNCTION PARAMETERS -->

	758 <dd style="display: none; ">

	759 <div></div>

	760 </dd>

	761

	762 </div>

	763 </div>

	764 </dl>

	765 </div>

	766 </div>

	767

	768 <!-- MIN_VERSION -->

	769 <p style="display: none; ">

	770 This function was added in version <b><span></span></b>.

	771 If you require this function, the manifest key

	772 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>

	773 can ensure that your extension won't be run in an earlier brow ser version.

	774 </p>

	775 </div> <!-- /description -->

	776

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

522 <a name="method-isSpeaking"></a> <!-- method-anchor -->	778 <a name="method-isSpeaking"></a> <!-- method-anchor -->

523 <h4>isSpeaking</h4>	779 <h4>isSpeaking</h4>

524	780

525 <div class="summary"><span style="display: none; ">void</span>	781 <div class="summary"><span style="display: none; ">void</span>

526 <!-- Note: intentionally longer 80 columns -->	782 <!-- Note: intentionally longer 80 columns -->

527 <span>chrome.experimental.tts.isSpeaking</span>(<span class="o ptional"><span style="display: none; ">, </span><span>function</span>	783 <span>chrome.experimental.tts.isSpeaking</span>(<span class="o ptional"><span style="display: none; ">, </span><span>function</span>

528 <var><span>callback</span></var></span>)</div>	784 <var><span>callback</span></var></span>)</div>

529	785

530 <div class="description">	786 <div class="description">

531 <p class="todo" style="display: none; ">Undocumented.</p>	787 <p class="todo" style="display: none; ">Undocumented.</p>

(...skipping 224 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
756 </span>	1012 </span>

757 </span>	1013 </span>

758 )	1014 )

759 </div>	1015 </div>

760	1016

761 </em>	1017 </em>

762 </dt>	1018 </dt>

763 <dd class="todo" style="display: none; ">	1019 <dd class="todo" style="display: none; ">

764 Undocumented.	1020 Undocumented.

765 </dd>	1021 </dd>

766 <dd>The text to speak. May include SSML markup.</dd>	1022 <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>
	kathyw 2011/07/13 20:39:58 plaintext -> plain text complete well-formed -> c plaintext -> plain text complete well-formed -> complete, well-formed dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > plaintext -> plain text > > complete well-formed -> complete, well-formed Done.
767 <dd style="display: none; ">	1023 <dd style="display: none; ">

768 This parameter was added in version	1024 This parameter was added in version

769 <b><span></span></b>.	1025 <b><span></span></b>.

770 You must omit this parameter in earlier versions,	1026 You must omit this parameter in earlier versions,

771 and you may omit it in any version. If you require this	1027 and you may omit it in any version. If you require this

772 parameter, the manifest key	1028 parameter, the manifest key

773 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	1029 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

774 can ensure that your extension won't be run in an earlier browser ve rsion.	1030 can ensure that your extension won't be run in an earlier browser ve rsion.

775 </dd>	1031 </dd>

776	1032

(...skipping 200 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
977	1233

978 <!-- FUNCTION PARAMETERS -->	1234 <!-- FUNCTION PARAMETERS -->

979 <dd style="display: none; ">	1235 <dd style="display: none; ">

980 <div></div>	1236 <div></div>

981 </dd>	1237 </dd>

982	1238

983 </div>	1239 </div>

984 </div><div>	1240 </div><div>

985 <div>	1241 <div>

986 <dt>	1242 <dt>

987 <var>locale</var>	1243 <var>extensionId</var>

988 <em>	1244 <em>

989	1245

990 <!-- TYPE -->	1246 <!-- TYPE -->

991 <div style="display:inline">	1247 <div style="display:inline">

992 (	1248 (

993 <span class="optional">optional</span>	1249 <span class="optional">optional</span>

994 <span class="enum" style="display: none; ">enumerated</span>	1250 <span class="enum" style="display: none; ">enumerated</span>

995 <span id="typeTemplate">	1251 <span id="typeTemplate">

996 <span style="display: none; ">	1252 <span style="display: none; ">

997 <a> Type</a>	1253 <a> Type</a>

998 </span>	1254 </span>

999 <span>	1255 <span>

1000 <span style="display: none; ">	1256 <span style="display: none; ">

1001 array of <span><span></span></span>	1257 array of <span><span></span></span>

1002 </span>	1258 </span>

1003 <span>string</span>	1259 <span>string</span>

1004 <span style="display: none; "></span>	1260 <span style="display: none; "></span>

1005 </span>	1261 </span>

1006 </span>	1262 </span>

1007 )	1263 )

1008 </div>	1264 </div>

1009	1265

1010 </em>	1266 </em>

1011 </dt>	1267 </dt>

1012 <dd class="todo" style="display: none; ">	1268 <dd class="todo" style="display: none; ">

1013 Undocumented.	1269 Undocumented.

1014 </dd>	1270 </dd>

1015 <dd>The language and optional region code that specify the language an d dialect to be used for synthesis, in the form <language>-<region>. Examples: 'en', 'en-US', 'en-GB', 'zh-CN', etc.</dd>	1271 <dd>The specific extension ID of the speech engine to use, if known.</ dd>
	kathyw 2011/07/13 20:39:58 delete "specific" delete "specific" dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > delete "specific" Done.
1016 <dd style="display: none; ">	1272 <dd style="display: none; ">

1017 This parameter was added in version	1273 This parameter was added in version

1018 <b><span></span></b>.	1274 <b><span></span></b>.

1019 You must omit this parameter in earlier versions,	1275 You must omit this parameter in earlier versions,

1020 and you may omit it in any version. If you require this	1276 and you may omit it in any version. If you require this

1021 parameter, the manifest key	1277 parameter, the manifest key

1022 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	1278 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1023 can ensure that your extension won't be run in an earlier browser ve rsion.	1279 can ensure that your extension won't be run in an earlier browser ve rsion.

1024 </dd>	1280 </dd>

1025	1281

(...skipping 19 matching lines...) Expand all Loading...
1045	1301

1046 <!-- FUNCTION PARAMETERS -->	1302 <!-- FUNCTION PARAMETERS -->

1047 <dd style="display: none; ">	1303 <dd style="display: none; ">

1048 <div></div>	1304 <div></div>

1049 </dd>	1305 </dd>

1050	1306

1051 </div>	1307 </div>

1052 </div><div>	1308 </div><div>

1053 <div>	1309 <div>

1054 <dt>	1310 <dt>

	1311 <var>lang</var>

	1312 <em>

	1313

	1314 <!-- TYPE -->

	1315 <div style="display:inline">

	1316 (

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

	1318 <span class="enum" style="display: none; ">enumerated</span>

	1319 <span id="typeTemplate">

	1320 <span style="display: none; ">

	1321 <a> Type</a>

	1322 </span>

	1323 <span>

	1324 <span style="display: none; ">

	1325 array of <span><span></span></span>

	1326 </span>

	1327 <span>string</span>

	1328 <span style="display: none; "></span>

	1329 </span>

	1330 </span>

	1331 )

	1332 </div>

	1333

	1334 </em>

	1335 </dt>

	1336 <dd class="todo" style="display: none; ">

	1337 Undocumented.

	1338 </dd>

	1339 <dd>The language to be used for synthesis, in the form <language&gt ;-<region>. Examples: 'en', 'en-US', 'en-GB', 'zh-CN', etc.</dd>
	kathyw 2011/07/13 20:39:58 It's hard to see the - when it's between ><. How a It's hard to see the - when it's between ><. How about: <language>-<region> -> <em>language</em>-<em>region</em> delete ", etc" (It's unnecessary) dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > It's hard to see the - when it's between ><. How about: > > <language>-<region> > -> > <em>language</em>-<em>region</em> > > delete ", etc" > (It's unnecessary) Done.
	1340 <dd style="display: none; ">

	1341 This parameter was added in version

	1342 <b><span></span></b>.

	1343 You must omit this parameter in earlier versions,

	1344 and you may omit it in any version. If you require this

	1345 parameter, the manifest key

	1346 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

	1347 can ensure that your extension won't be run in an earlier browser ve rsion.

	1348 </dd>

	1349

	1350 <!-- OBJECT PROPERTIES -->

	1351 <dd style="display: none; ">

	1352 <dl>

	1353 <div>

	1354 <div>

	1355 </div>

	1356 </div>

	1357 </dl>

	1358 </dd>

	1359

	1360 <!-- OBJECT METHODS -->

	1361 <dd style="display: none; ">

	1362 <div></div>

	1363 </dd>

	1364

	1365 <!-- OBJECT EVENT FIELDS -->

	1366 <dd style="display: none; ">

	1367 <div></div>

	1368 </dd>

	1369

	1370 <!-- FUNCTION PARAMETERS -->

	1371 <dd style="display: none; ">

	1372 <div></div>

	1373 </dd>

	1374

	1375 </div>

	1376 </div><div>

	1377 <div>

	1378 <dt>

1055 <var>gender</var>	1379 <var>gender</var>

1056 <em>	1380 <em>

1057	1381

1058 <!-- TYPE -->	1382 <!-- TYPE -->

1059 <div style="display:inline">	1383 <div style="display:inline">

1060 (	1384 (

1061 <span class="optional">optional</span>	1385 <span class="optional">optional</span>

1062 <span class="enum">enumerated</span>	1386 <span class="enum">enumerated</span>

1063 <span id="typeTemplate">	1387 <span id="typeTemplate">

1064 <span style="display: none; ">	1388 <span style="display: none; ">

(...skipping 76 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1141 </span>	1465 </span>

1142 </span>	1466 </span>

1143 )	1467 )

1144 </div>	1468 </div>

1145	1469

1146 </em>	1470 </em>

1147 </dt>	1471 </dt>

1148 <dd class="todo" style="display: none; ">	1472 <dd class="todo" style="display: none; ">

1149 Undocumented.	1473 Undocumented.

1150 </dd>	1474 </dd>

1151 <dd>Speaking speed between 0 and 1 inclusive, with 0 being slowest and 1 being fastest, with a default of 0.5.</dd>	1475 <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>
	kathyw 2011/07/13 20:39:58 minute, -> minute. 2.0 would be -> 2.0 is minute, -> minute. 2.0 would be -> 2.0 is kathyw 2011/07/13 20:39:58 0.5 would be -> 0.5 is 0.5 would be -> 0.5 is kathyw 2011/07/13 20:39:58 further - i.e. a particular -> further—for e further - i.e. a particular -> further—for example, a particular (i.e. means "that is", but I think this is more of an e.g. This illustrates why it's usually better to avoid latin abbreviations!) dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > minute, -> minute. > > 2.0 would be -> 2.0 is Done. dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > 0.5 would be -> 0.5 is Done. dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > minute, -> minute. > > 2.0 would be -> 2.0 is Done. dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > further - i.e. a particular > -> > further—for example, a particular > > (i.e. means "that is", but I think this is more of an e.g. This illustrates why > it's usually better to avoid latin abbreviations!) Done.
1152 <dd style="display: none; ">	1476 <dd style="display: none; ">

1153 This parameter was added in version	1477 This parameter was added in version

1154 <b><span></span></b>.	1478 <b><span></span></b>.

1155 You must omit this parameter in earlier versions,	1479 You must omit this parameter in earlier versions,

1156 and you may omit it in any version. If you require this	1480 and you may omit it in any version. If you require this

1157 parameter, the manifest key	1481 parameter, the manifest key

1158 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	1482 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1159 can ensure that your extension won't be run in an earlier browser ve rsion.	1483 can ensure that your extension won't be run in an earlier browser ve rsion.

1160 </dd>	1484 </dd>

1161	1485

(...skipping 47 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1209 </span>	1533 </span>

1210 </span>	1534 </span>

1211 )	1535 )

1212 </div>	1536 </div>

1213	1537

1214 </em>	1538 </em>

1215 </dt>	1539 </dt>

1216 <dd class="todo" style="display: none; ">	1540 <dd class="todo" style="display: none; ">

1217 Undocumented.	1541 Undocumented.

1218 </dd>	1542 </dd>

1219 <dd>Speaking pitch between 0 and 1 inclusive, with 0 being lowest and 1 being highest, with a default of 0.5.</dd>	1543 <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>
	kathyw 2011/07/13 20:39:58 1 being highest -> 2 being highest , with...voice 1 being highest -> 2 being highest , with...voice -> . The default pitch of this particular voice is 1.0. dmazzoni 2011/07/14 06:50:55 I reworded it, is this okay? Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > 1 being highest -> 2 being highest > > , with...voice > -> > . The default pitch of this particular voice is 1.0. I reworded it, is this okay? kathyw 2011/07/14 16:13:23 Yep, looks good. Show quoted text > I reworded it, is this okay? Yep, looks good.
1220 <dd style="display: none; ">	1544 <dd style="display: none; ">

1221 This parameter was added in version	1545 This parameter was added in version

1222 <b><span></span></b>.	1546 <b><span></span></b>.

1223 You must omit this parameter in earlier versions,	1547 You must omit this parameter in earlier versions,

1224 and you may omit it in any version. If you require this	1548 and you may omit it in any version. If you require this

1225 parameter, the manifest key	1549 parameter, the manifest key

1226 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	1550 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1227 can ensure that your extension won't be run in an earlier browser ve rsion.	1551 can ensure that your extension won't be run in an earlier browser ve rsion.

1228 </dd>	1552 </dd>

1229	1553

(...skipping 84 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1314 <dd style="display: none; ">	1638 <dd style="display: none; ">

1315 <div></div>	1639 <div></div>

1316 </dd>	1640 </dd>

1317	1641

1318 <!-- FUNCTION PARAMETERS -->	1642 <!-- FUNCTION PARAMETERS -->

1319 <dd style="display: none; ">	1643 <dd style="display: none; ">

1320 <div></div>	1644 <div></div>

1321 </dd>	1645 </dd>

1322	1646

1323 </div>	1647 </div>

	1648 </div><div>

	1649 <div>

	1650 <dt>

	1651 <var>requiredEventTypes</var>

	1652 <em>

	1653

	1654 <!-- TYPE -->

	1655 <div style="display:inline">

	1656 (

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

	1658 <span class="enum" style="display: none; ">enumerated</span>

	1659 <span id="typeTemplate">

	1660 <span style="display: none; ">

	1661 <a> Type</a>

	1662 </span>

	1663 <span>

	1664 <span>

	1665 array of <span><span>

	1666 <span style="display: none; ">

	1667 <a> Type</a>

	1668 </span>

	1669 <span>

	1670 <span style="display: none; ">

	1671 array of <span><span></span></span>

	1672 </span>

	1673 <span>string</span>

	1674 <span style="display: none; "></span>

	1675 </span>

	1676 </span></span>

	1677 </span>

	1678 <span style="display: none; ">paramType</span>

	1679 <span style="display: none; "></span>

	1680 </span>

	1681 </span>

	1682 )

	1683 </div>

	1684

	1685 </em>

	1686 </dt>

	1687 <dd class="todo" style="display: none; ">

	1688 Undocumented.

	1689 </dd>

	1690 <dd>The TTS event types the voice must support. If missing, this crite ria will not be used to filter voices.</dd>
	kathyw 2011/07/13 20:39:58 "Criteria" is plural, so it'd be "these", but actu "Criteria" is plural, so it'd be "these", but actually... Couldn't we just delete the second sentence? It seems obvious. Or if you want to keep it, clarify it -- for example, "If this field is missing, the voice might support any set of event types, or none at all." dmazzoni 2011/07/14 06:50:55 You're right, it's clear enough without it. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > "Criteria" is plural, so it'd be "these", but actually... > > Couldn't we just delete the second sentence? It seems obvious. Or if you want to > keep it, clarify it -- for example, "If this field is missing, the voice might > support any set of event types, or none at all." You're right, it's clear enough without it.
	1691 <dd style="display: none; ">

	1692 This parameter was added in version

	1693 <b><span></span></b>.

	1694 You must omit this parameter in earlier versions,

	1695 and you may omit it in any version. If you require this

	1696 parameter, the manifest key

	1697 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

	1698 can ensure that your extension won't be run in an earlier browser ve rsion.

	1699 </dd>

	1700

	1701 <!-- OBJECT PROPERTIES -->

	1702 <dd style="display: none; ">

	1703 <dl>

	1704 <div>

	1705 <div>

	1706 </div>

1324 </div>	1707 </div>

1325 </dl>	1708 </dl>

1326 </dd>	1709 </dd>

1327	1710

1328 <!-- OBJECT METHODS -->	1711 <!-- OBJECT METHODS -->

1329 <dd style="display: none; ">	1712 <dd style="display: none; ">

1330 <div></div>	1713 <div></div>

1331 </dd>	1714 </dd>

1332	1715

1333 <!-- OBJECT EVENT FIELDS -->	1716 <!-- OBJECT EVENT FIELDS -->

1334 <dd style="display: none; ">	1717 <dd style="display: none; ">

1335 <div></div>	1718 <div></div>

1336 </dd>	1719 </dd>

1337	1720

1338 <!-- FUNCTION PARAMETERS -->	1721 <!-- FUNCTION PARAMETERS -->

1339 <dd style="display: none; ">	1722 <dd style="display: none; ">

1340 <div></div>	1723 <div></div>

1341 </dd>	1724 </dd>

1342	1725

1343 </div>	1726 </div>

1344 </div><div>	1727 </div><div>

1345 <div>	1728 <div>

1346 <dt>	1729 <dt>

1347 <var>callback</var>	1730 <var>desiredEventTypes</var>

1348 <em>	1731 <em>

1349	1732

1350 <!-- TYPE -->	1733 <!-- TYPE -->

1351 <div style="display:inline">	1734 <div style="display:inline">

1352 (	1735 (

1353 <span class="optional">optional</span>	1736 <span class="optional">optional</span>

1354 <span class="enum" style="display: none; ">enumerated</span>	1737 <span class="enum" style="display: none; ">enumerated</span>

1355 <span id="typeTemplate">	1738 <span id="typeTemplate">

1356 <span style="display: none; ">	1739 <span style="display: none; ">

1357 <a> Type</a>	1740 <a> Type</a>

1358 </span>	1741 </span>

1359 <span>	1742 <span>

	1743 <span>

	1744 array of <span><span>

	1745 <span style="display: none; ">

	1746 <a> Type</a>

	1747 </span>

	1748 <span>

1360 <span style="display: none; ">	1749 <span style="display: none; ">

1361 array of <span><span></span></span>	1750 array of <span><span></span></span>

1362 </span>	1751 </span>

1363 <span>function</span>	1752 <span>string</span>

	1753 <span style="display: none; "></span>

	1754 </span>

	1755 </span></span>

	1756 </span>

	1757 <span style="display: none; ">paramType</span>

1364 <span style="display: none; "></span>	1758 <span style="display: none; "></span>

1365 </span>	1759 </span>

1366 </span>	1760 </span>

1367 )	1761 )

1368 </div>	1762 </div>

1369	1763

1370 </em>	1764 </em>

1371 </dt>	1765 </dt>

1372 <dd class="todo" style="display: none; ">	1766 <dd class="todo" style="display: none; ">

1373 Undocumented.	1767 Undocumented.

1374 </dd>	1768 </dd>

1375 <dd>This function is called when speaking is finished.</dd>	1769 <dd>The TTS event types that should be sent. If missing, all event typ es will be sent.</dd>
	kathyw 2011/07/13 20:39:58 will be -> may be? I'm not clear on why you'd use will be -> may be? I'm not clear on why you'd use this. Is it just a way of saying "don't bother sending events that aren't in this list, since I'm not listening for them"? Also "all event types will be sent" makes it sound like every single possible event type will be sent, but since speech engines don't all support every possible event type, that doesn't make sense. dmazzoni 2011/07/14 06:50:55 You're right, clarified. It's true, this isn't ne Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > will be -> may be? > > I'm not clear on why you'd use this. Is it just a way of saying "don't bother > sending events that aren't in this list, since I'm not listening for them"? > > Also "all event types will be sent" makes it sound like every single possible > event type will be sent, but since speech engines don't all support every > possible event type, that doesn't make sense. You're right, clarified. It's true, this isn't necessary because you could just filter the events in the client side, but it was requested in the review, as a convenience for developers.
1376 <dd style="display: none; ">	1770 <dd style="display: none; ">

1377 This parameter was added in version	1771 This parameter was added in version

1378 <b><span></span></b>.	1772 <b><span></span></b>.

1379 You must omit this parameter in earlier versions,	1773 You must omit this parameter in earlier versions,

1380 and you may omit it in any version. If you require this	1774 and you may omit it in any version. If you require this

1381 parameter, the manifest key	1775 parameter, the manifest key

1382 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	1776 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1383 can ensure that your extension won't be run in an earlier browser ve rsion.	1777 can ensure that your extension won't be run in an earlier browser ve rsion.

1384 </dd>	1778 </dd>

1385	1779

(...skipping 16 matching lines...) Expand all Loading...
1402 <dd style="display: none; ">	1796 <dd style="display: none; ">

1403 <div></div>	1797 <div></div>

1404 </dd>	1798 </dd>

1405	1799

1406 <!-- FUNCTION PARAMETERS -->	1800 <!-- FUNCTION PARAMETERS -->

1407 <dd style="display: none; ">	1801 <dd style="display: none; ">

1408 <div></div>	1802 <div></div>

1409 </dd>	1803 </dd>

1410	1804

1411 </div>	1805 </div>

	1806 </div><div>

	1807 <div>

	1808 <dt>

	1809 <var>onevent</var>
	kathyw 2011/07/13 20:39:58 onevent -> onEvent or maybe -> eventHandler onevent -> onEvent or maybe -> eventHandler dmazzoni 2011/07/14 06:50:55 I made it all lowercase to be consistent with "onc Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > onevent -> onEvent > > or maybe -> eventHandler I made it all lowercase to be consistent with "onclick" in the contextMenus API: http://code.google.com/chrome/extensions/contextMenus.html This may have been chosen because so many other HTML event handler properties like "onclick" and "onkeydown" and "onreadystatechange" are all lowercase. I can still change it to onEvent, what do you think? In another context, eventHandler would be fine, but for web-based APIs I think that onthis and onthat is more common. kathyw 2011/07/14 16:13:23 I don't feel terribly strongly about this. It's ju I don't feel terribly strongly about this. It's just easy to read this particular word as oneVent, and since "event" is generic in this case, it's a little odd. Fwiw, the context menu parameter aside, event titles in the extension APIs are onXyz. (e.g. chrome.browserAction.onClicked).
	1810 <em>

	1811

	1812 <!-- TYPE -->

	1813 <div style="display:inline">

	1814 (

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

	1816 <span class="enum" style="display: none; ">enumerated</span>

	1817 <span id="typeTemplate">

	1818 <span style="display: none; ">

	1819 <a> Type</a>

	1820 </span>

	1821 <span>

	1822 <span style="display: none; ">

	1823 array of <span><span></span></span>

	1824 </span>

	1825 <span>function</span>

	1826 <span style="display: none; "></span>

	1827 </span>

	1828 </span>

	1829 )

	1830 </div>

	1831

	1832 </em>

	1833 </dt>

	1834 <dd class="todo" style="display: none; ">

	1835 Undocumented.

	1836 </dd>

	1837 <dd>This function is called with events that occur in the process of s peaking the utterance.</dd>

	1838 <dd style="display: none; ">

	1839 This parameter was added in version

	1840 <b><span></span></b>.

	1841 You must omit this parameter in earlier versions,

	1842 and you may omit it in any version. If you require this

	1843 parameter, the manifest key

	1844 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

	1845 can ensure that your extension won't be run in an earlier browser ve rsion.

	1846 </dd>

	1847

	1848 <!-- OBJECT PROPERTIES -->

	1849 <dd style="display: none; ">

	1850 <dl>

	1851 <div>

	1852 <div>

	1853 </div>

	1854 </div>

	1855 </dl>

	1856 </dd>

	1857

	1858 <!-- OBJECT METHODS -->

	1859 <dd style="display: none; ">

	1860 <div></div>

	1861 </dd>

	1862

	1863 <!-- OBJECT EVENT FIELDS -->

	1864 <dd style="display: none; ">

	1865 <div></div>

	1866 </dd>

	1867

	1868 <!-- FUNCTION PARAMETERS -->

	1869 <dd>

	1870 <div>

	1871 <h5>Parameters</h5>

	1872 <dl>

	1873 <div>

	1874 <div>

	1875 <dt>

	1876 <var>event</var>

	1877 <em>

	1878

	1879 <!-- TYPE -->

	1880 <div style="display:inline">

	1881 (

	1882 <span class="optional" style="display: none; ">optional</spa n>

	1883 <span class="enum" style="display: none; ">enumerated</span>

	1884 <span id="typeTemplate">

	1885 <span>

	1886 <a href="experimental.tts.html#type-TtsEvent">TtsEvent</ a>

	1887 </span>

	1888 <span style="display: none; ">

	1889 <span>

	1890 array of <span><span></span></span>

	1891 </span>

	1892 <span>paramType</span>

	1893 <span></span>

	1894 </span>

	1895 </span>

	1896 )

	1897 </div>

	1898

	1899 </em>

	1900 </dt>

	1901 <dd class="todo" style="display: none; ">

	1902 Undocumented.

	1903 </dd>

	1904 <dd>The update event from the text-to-speech engine indicating the sta tus of this utterance.</dd>

	1905 <dd style="display: none; ">

	1906 This parameter was added in version

	1907 <b><span></span></b>.

	1908 You must omit this parameter in earlier versions,

	1909 and you may omit it in any version. If you require this

	1910 parameter, the manifest key

	1911 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

	1912 can ensure that your extension won't be run in an earlier browser ve rsion.

	1913 </dd>

	1914

	1915 <!-- OBJECT PROPERTIES -->

	1916 <dd style="display: none; ">

	1917 <dl>

	1918 <div>

	1919 <div>

	1920 </div>

	1921 </div>

	1922 </dl>

	1923 </dd>

	1924

	1925 <!-- OBJECT METHODS -->

	1926 <dd style="display: none; ">

	1927 <div></div>

	1928 </dd>

	1929

	1930 <!-- OBJECT EVENT FIELDS -->

	1931 <dd style="display: none; ">

	1932 <div></div>

	1933 </dd>

	1934

	1935 <!-- FUNCTION PARAMETERS -->

	1936 <dd style="display: none; ">

	1937 <div></div>

	1938 </dd>

	1939

	1940 </div>

	1941 </div>

	1942 </dl>

	1943 </div>

	1944 </dd>

	1945

	1946 </div>

	1947 </div>

	1948 </dl>

	1949 </dd>

	1950

	1951 <!-- OBJECT METHODS -->

	1952 <dd style="display: none; ">

	1953 <div></div>

	1954 </dd>

	1955

	1956 <!-- OBJECT EVENT FIELDS -->

	1957 <dd style="display: none; ">

	1958 <div></div>

	1959 </dd>

	1960

	1961 <!-- FUNCTION PARAMETERS -->

	1962 <dd style="display: none; ">

	1963 <div></div>

	1964 </dd>

	1965

	1966 </div>

	1967 </div><div>

	1968 <div>

	1969 <dt>

	1970 <var>callback</var>

	1971 <em>

	1972

	1973 <!-- TYPE -->

	1974 <div style="display:inline">

	1975 (

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

	1977 <span class="enum" style="display: none; ">enumerated</span>

	1978 <span id="typeTemplate">

	1979 <span style="display: none; ">

	1980 <a> Type</a>

	1981 </span>

	1982 <span>

	1983 <span style="display: none; ">

	1984 array of <span><span></span></span>

	1985 </span>

	1986 <span>function</span>

	1987 <span style="display: none; "></span>

	1988 </span>

	1989 </span>

	1990 )

	1991 </div>

	1992

	1993 </em>

	1994 </dt>

	1995 <dd class="todo" style="display: none; ">

	1996 Undocumented.

	1997 </dd>

	1998 <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>

	1999 <dd style="display: none; ">

	2000 This parameter was added in version

	2001 <b><span></span></b>.

	2002 You must omit this parameter in earlier versions,

	2003 and you may omit it in any version. If you require this

	2004 parameter, the manifest key

	2005 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

	2006 can ensure that your extension won't be run in an earlier browser ve rsion.

	2007 </dd>

	2008

	2009 <!-- OBJECT PROPERTIES -->

	2010 <dd style="display: none; ">

	2011 <dl>

	2012 <div>

	2013 <div>

	2014 </div>

	2015 </div>

	2016 </dl>

	2017 </dd>

	2018

	2019 <!-- OBJECT METHODS -->

	2020 <dd style="display: none; ">

	2021 <div></div>

	2022 </dd>

	2023

	2024 <!-- OBJECT EVENT FIELDS -->

	2025 <dd style="display: none; ">

	2026 <div></div>

	2027 </dd>

	2028

	2029 <!-- FUNCTION PARAMETERS -->

	2030 <dd style="display: none; ">

	2031 <div></div>

	2032 </dd>

	2033

	2034 </div>

1412 </div>	2035 </div>

1413 </dl>	2036 </dl>

1414	2037

1415 <!-- RETURNS -->	2038 <!-- RETURNS -->

1416 <h4 style="display: none; ">Returns</h4>	2039 <h4 style="display: none; ">Returns</h4>

1417 <dl>	2040 <dl>

1418 <div style="display: none; ">	2041 <div style="display: none; ">

1419 <div>	2042 <div>

1420 </div>	2043 </div>

1421 </div>	2044 </div>

1422 </dl>

1423

1424 <!-- CALLBACK -->

1425 <div>

1426 <div>

1427 <h4>Callback function</h4>

1428 <p style="display: none; ">

1429 The callback <em>parameter</em> should specify a function

1430 that looks like this:

1431 </p>

1432 <p>

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

1434 specify a function that looks like this:

1435 </p>

1436

1437 <!-- Note: intentionally longer 80 columns -->

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

1439 <dl>

1440 <div style="display: none; ">

1441 <div>

1442 </div>

1443 </div>

1444 </dl>

1445 </div>

1446 </div>

1447

1448 <!-- MIN_VERSION -->

1449 <p style="display: none; ">

1450 This function was added in version <b><span></span></b>.

1451 If you require this function, the manifest key

1452 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>

1453 can ensure that your extension won't be run in an earlier brow ser version.

1454 </p>

1455 </div> <!-- /description -->

1456

1457 </div><div class="apiItem" style="display: none; ">

1458 <a></a> <!-- method-anchor -->

1459 <h4>method name</h4>

1460

1461 <div class="summary"><span>void</span>

1462 <!-- Note: intentionally longer 80 columns -->

1463 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>

1464 <var><span></span></var></span>)</div>

1465

1466 <div class="description">

1467 <p class="todo">Undocumented.</p>

1468 <p>

1469 A description from the json schema def of the function goes he re.

1470 </p>

1471

1472 <!-- PARAMETERS -->

1473 <h4>Parameters</h4>

1474 <dl>

1475 <div>

1476 <div>

1477 </div>

1478 </div>

1479 </dl>

1480

1481 <!-- RETURNS -->

1482 <h4>Returns</h4>

1483 <dl>

1484 <div>

1485 <div>

1486 </div>

1487 </div>

1488 </dl>	2045 </dl>

1489	2046

1490 <!-- CALLBACK -->	2047 <!-- CALLBACK -->

1491 <div>	2048 <div>

1492 <div>	2049 <div>

1493 <h4>Callback function</h4>	2050 <h4>Callback function</h4>

1494 <p>	2051 <p style="display: none; ">

1495 The callback <em>parameter</em> should specify a function	2052 The callback <em>parameter</em> should specify a function

1496 that looks like this:	2053 that looks like this:

1497 </p>	2054 </p>

1498 <p>	2055 <p>

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

1500 specify a function that looks like this:	2057 specify a function that looks like this:

1501 </p>	2058 </p>

1502	2059

1503 <!-- Note: intentionally longer 80 columns -->	2060 <!-- Note: intentionally longer 80 columns -->

1504 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>	2061 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>

1505 <dl>	2062 <dl>

1506 <div>	2063 <div style="display: none; ">

1507 <div>	2064 <div>

1508 </div>	2065 </div>

1509 </div>	2066 </div>

1510 </dl>	2067 </dl>

1511 </div>	2068 </div>

1512 </div>	2069 </div>

1513	2070

1514 <!-- MIN_VERSION -->	2071 <!-- MIN_VERSION -->

1515 <p>	2072 <p style="display: none; ">

1516 This function was added in version <b><span></span></b>.	2073 This function was added in version <b><span></span></b>.

1517 If you require this function, the manifest key	2074 If you require this function, the manifest key

1518 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>	2075 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>

1519 can ensure that your extension won't be run in an earlier brow ser version.	2076 can ensure that your extension won't be run in an earlier brow ser version.

1520 </p>	2077 </p>

1521 </div> <!-- /description -->	2078 </div> <!-- /description -->

1522	2079

1523 </div><div class="apiItem">	2080 </div><div class="apiItem">

1524 <a name="method-stop"></a> <!-- method-anchor -->	2081 <a name="method-stop"></a> <!-- method-anchor -->

1525 <h4>stop</h4>	2082 <h4>stop</h4>

(...skipping 56 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1582 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>	2139 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>

1583 can ensure that your extension won't be run in an earlier brow ser version.	2140 can ensure that your extension won't be run in an earlier brow ser version.

1584 </p>	2141 </p>

1585 </div> <!-- /description -->	2142 </div> <!-- /description -->

1586	2143

1587 </div> <!-- /apiItem -->	2144 </div> <!-- /apiItem -->

1588	2145

1589 </div> <!-- /apiGroup -->	2146 </div> <!-- /apiGroup -->

1590	2147

1591 <!-- EVENTS -->	2148 <!-- EVENTS -->

1592 <div id="eventsTemplate" class="apiGroup">	2149 <div id="eventsTemplate" class="apiGroup" style="display: none; ">

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

1594 <h3>Events</h3>	2151 <h3>Events</h3>

1595 <!-- iterates over all events -->	2152 <!-- iterates over all events -->

1596 <div class="apiItem">	2153 <div class="apiItem">

1597 <a name="event-onSpeak"></a>	2154 <a></a>

1598 <h4>onSpeak</h4>	2155 <h4>event name</h4>

1599	2156

1600 <div class="summary">	2157 <div class="summary">

1601 <!-- Note: intentionally longer 80 columns -->	2158 <!-- Note: intentionally longer 80 columns -->

1602 <span class="subdued">chrome.experimental.tts.</span><span>onSpe ak</span><span class="subdued">.addListener</span>(function(<span>string utteran ce, object options, function callback</span>) <span class="subdued">{...}</span> <span></span>));	2159 <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>));

1603 </div>	2160 </div>

1604	2161

1605 <div class="description">	2162 <div class="description">

1606 <p class="todo" style="display: none; ">Undocumented.</p>	2163 <p class="todo">Undocumented.</p>

1607 <p>Called when the user makes a call to tts.speak and the option s matches one of the tts_voices from this extension's manifest.</p>	2164 <p>

	2165 A description from the json schema def of the event goes here.

	2166 </p>

1608	2167

1609 <!-- LISTENER PARAMETERS -->	2168 <!-- LISTENER PARAMETERS -->

1610 <div>	2169 <div>

1611 <h4>Listener parameters</h4>	2170 <h4>Listener parameters</h4>

1612 <dl>	2171 <dl>

1613 <div>	2172 <div>

1614 <div>	2173 <div>

	2174 </div>

	2175 </div>

	2176 </dl>

	2177 </div>

	2178

	2179 <!-- EXTRA PARAMETERS -->

	2180 <div>

	2181 <h4>Extra parameters to addListener</h4>

	2182 <dl>

	2183 <div>

	2184 <div>

	2185 </div>

	2186 </div>

	2187 </dl>

	2188 </div>

	2189

	2190 <!-- LISTENER RETURN VALUE -->

	2191 <h4>Listener returns</h4>

	2192 <dl>

	2193 <div>

	2194 <div>

	2195 </div>

	2196 </div>

	2197 </dl>

	2198

	2199 </div> <!-- /description -->

	2200 </div> <!-- /apiItem -->

	2201

	2202 </div> <!-- /apiGroup -->

	2203

	2204 <!-- TYPES -->

	2205 <div class="apiGroup">

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

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

	2208

	2209 <!-- iterates over all types -->

	2210 <div class="apiItem">

	2211 <a name="type-TtsEvent"></a>

	2212 <h4>TtsEvent</h4>

	2213

	2214 <div>

1615 <dt>	2215 <dt>

1616 <var>utterance</var>	2216 <var style="display: none; ">paramName</var>

1617 <em>	2217 <em>

1618	2218

1619 <!-- TYPE -->	2219 <!-- TYPE -->

1620 <div style="display:inline">	2220 <div style="display:inline">

1621 (	2221 (

1622 <span class="optional" style="display: none; ">optional</spa n>	2222 <span class="optional" style="display: none; ">optional</spa n>

1623 <span class="enum" style="display: none; ">enumerated</span>	2223 <span class="enum" style="display: none; ">enumerated</span>

1624 <span id="typeTemplate">	2224 <span id="typeTemplate">

1625 <span style="display: none; ">	2225 <span style="display: none; ">

1626 <a> Type</a>	2226 <a> Type</a>

1627 </span>	2227 </span>

1628 <span>	2228 <span>

1629 <span style="display: none; ">	2229 <span style="display: none; ">

1630 array of <span><span></span></span>	2230 array of <span><span></span></span>

1631 </span>	2231 </span>

1632 <span>string</span>	2232 <span>object</span>

1633 <span style="display: none; "></span>	2233 <span style="display: none; "></span>

1634 </span>	2234 </span>

1635 </span>	2235 </span>

1636 )	2236 )

1637 </div>	2237 </div>

1638	2238

1639 </em>	2239 </em>

1640 </dt>	2240 </dt>

1641 <dd class="todo" style="display: none; ">	2241 <dd class="todo" style="display: none; ">

1642 Undocumented.	2242 Undocumented.

1643 </dd>	2243 </dd>

1644 <dd>The text to speak. This may include SSML, so if your engine does n ot support SSML, you should strip out all XML markup and synthesize only the und erlying text content.</dd>	2244 <dd>An event from the TTS engine to communicate the status of an utter ance.</dd>

1645 <dd style="display: none; ">	2245 <dd style="display: none; ">

1646 This parameter was added in version	2246 This parameter was added in version

1647 <b><span></span></b>.	2247 <b><span></span></b>.

1648 You must omit this parameter in earlier versions,	2248 You must omit this parameter in earlier versions,

1649 and you may omit it in any version. If you require this	2249 and you may omit it in any version. If you require this

1650 parameter, the manifest key	2250 parameter, the manifest key

1651 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	2251 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1652 can ensure that your extension won't be run in an earlier browser ve rsion.	2252 can ensure that your extension won't be run in an earlier browser ve rsion.

1653 </dd>	2253 </dd>

1654	2254

1655 <!-- OBJECT PROPERTIES -->	2255 <!-- OBJECT PROPERTIES -->

1656 <dd style="display: none; ">	2256 <dd>

1657 <dl>	2257 <dl>

1658 <div>	2258 <div>

1659 <div>	2259 <div>

1660 </div>

1661 </div>

1662 </dl>

1663 </dd>

1664

1665 <!-- OBJECT METHODS -->

1666 <dd style="display: none; ">

1667 <div></div>

1668 </dd>

1669

1670 <!-- OBJECT EVENT FIELDS -->

1671 <dd style="display: none; ">

1672 <div></div>

1673 </dd>

1674

1675 <!-- FUNCTION PARAMETERS -->

1676 <dd style="display: none; ">

1677 <div></div>

1678 </dd>

1679

1680 </div>

1681 </div><div>

1682 <div>

1683 <dt>	2260 <dt>

1684 <var>options</var>	2261 <var>type</var>

1685 <em>	2262 <em>

1686	2263

1687 <!-- TYPE -->	2264 <!-- TYPE -->

1688 <div style="display:inline">	2265 <div style="display:inline">

1689 (	2266 (

1690 <span class="optional" style="display: none; ">optional</spa n>	2267 <span class="optional" style="display: none; ">optional</spa n>

1691 <span class="enum" style="display: none; ">enumerated</span>	2268 <span class="enum">enumerated</span>

1692 <span id="typeTemplate">	2269 <span id="typeTemplate">

1693 <span style="display: none; ">	2270 <span style="display: none; ">

1694 <a> Type</a>	2271 <a> Type</a>

1695 </span>	2272 </span>

1696 <span>	2273 <span>

1697 <span style="display: none; ">	2274 <span style="display: none; ">

1698 array of <span><span></span></span>	2275 array of <span><span></span></span>

1699 </span>	2276 </span>

1700 <span>object</span>	2277 <span>string</span>

1701 <span style="display: none; "></span>	2278 <span>["start", "end", "word", "sentence", "marker", "in terrupted", "cancelled", "error"]</span>

1702 </span>	2279 </span>

1703 </span>	2280 </span>

1704 )	2281 )

1705 </div>	2282 </div>

1706	2283

1707 </em>	2284 </em>

1708 </dt>	2285 </dt>

1709 <dd class="todo" style="display: none; ">	2286 <dd class="todo" style="display: none; ">

1710 Undocumented.	2287 Undocumented.

1711 </dd>	2288 </dd>

1712 <dd>The speak options.</dd>	2289 <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>
	kathyw 2011/07/13 20:39:58 message -> type is begun -> has begun or ...as so message -> type is begun -> has begun or ...as soon as speech has started... and 'error' -> or 'error' Clients...engine -> The 'end', cancelled', interrupted', and 'error' messages are supported for all speech engines; support for other events depends on the engine. dmazzoni 2011/07/14 06:50:55 Done, except I just deleted the last sentence beca Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > message -> type > > is begun -> has begun > or > ...as soon as speech has started... > > and 'error' -> or 'error' > > Clients...engine > -> > The 'end', cancelled', interrupted', and 'error' messages > are supported for all speech engines; > support for other events depends on the engine. Done, except I just deleted the last sentence because I realized it's not quite correct. It's clearer to take it out; it's explained better in other places in the docs.
1713 <dd style="display: none; ">	2290 <dd style="display: none; ">

1714 This parameter was added in version	2291 This parameter was added in version

1715 <b><span></span></b>.	2292 <b><span></span></b>.

1716 You must omit this parameter in earlier versions,	2293 You must omit this parameter in earlier versions,

1717 and you may omit it in any version. If you require this	2294 and you may omit it in any version. If you require this

1718 parameter, the manifest key	2295 parameter, the manifest key

1719 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	2296 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1720 can ensure that your extension won't be run in an earlier browser ve rsion.	2297 can ensure that your extension won't be run in an earlier browser ve rsion.

1721 </dd>	2298 </dd>

1722	2299

1723 <!-- OBJECT PROPERTIES -->	2300 <!-- OBJECT PROPERTIES -->

1724 <dd>	2301 <dd style="display: none; ">

1725 <dl>	2302 <dl>

1726 <div>	2303 <div>

1727 <div>	2304 <div>

	2305 </div>

	2306 </div>

	2307 </dl>

	2308 </dd>

	2309

	2310 <!-- OBJECT METHODS -->

	2311 <dd style="display: none; ">

	2312 <div></div>

	2313 </dd>

	2314

	2315 <!-- OBJECT EVENT FIELDS -->

	2316 <dd style="display: none; ">

	2317 <div></div>

	2318 </dd>

	2319

	2320 <!-- FUNCTION PARAMETERS -->

	2321 <dd style="display: none; ">

	2322 <div></div>

	2323 </dd>

	2324

	2325 </div>

	2326 </div><div>

	2327 <div>

1728 <dt>	2328 <dt>

1729 <var>voiceName</var>	2329 <var>charIndex</var>

1730 <em>	2330 <em>

1731	2331

1732 <!-- TYPE -->	2332 <!-- TYPE -->

1733 <div style="display:inline">	2333 <div style="display:inline">

1734 (	2334 (

1735 <span class="optional">optional</span>	2335 <span class="optional">optional</span>

1736 <span class="enum" style="display: none; ">enumerated</span>	2336 <span class="enum" style="display: none; ">enumerated</span>

1737 <span id="typeTemplate">	2337 <span id="typeTemplate">

1738 <span style="display: none; ">	2338 <span style="display: none; ">

1739 <a> Type</a>	2339 <a> Type</a>

1740 </span>	2340 </span>

1741 <span>	2341 <span>

1742 <span style="display: none; ">	2342 <span style="display: none; ">

1743 array of <span><span></span></span>	2343 array of <span><span></span></span>

1744 </span>	2344 </span>

1745 <span>string</span>	2345 <span>number</span>

1746 <span style="display: none; "></span>	2346 <span style="display: none; "></span>

1747 </span>	2347 </span>

1748 </span>	2348 </span>

1749 )	2349 )

1750 </div>	2350 </div>

1751	2351

1752 </em>	2352 </em>

1753 </dt>	2353 </dt>

1754 <dd class="todo" style="display: none; ">	2354 <dd class="todo" style="display: none; ">

1755 Undocumented.	2355 Undocumented.

1756 </dd>	2356 </dd>

1757 <dd>The name of the voice to use for synthesis.</dd>	2357 <dd>The index of the current character in the utterance.</dd>

1758 <dd style="display: none; ">	2358 <dd style="display: none; ">

1759 This parameter was added in version	2359 This parameter was added in version

1760 <b><span></span></b>.	2360 <b><span></span></b>.

1761 You must omit this parameter in earlier versions,	2361 You must omit this parameter in earlier versions,

1762 and you may omit it in any version. If you require this	2362 and you may omit it in any version. If you require this

1763 parameter, the manifest key	2363 parameter, the manifest key

1764 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	2364 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1765 can ensure that your extension won't be run in an earlier browser ve rsion.	2365 can ensure that your extension won't be run in an earlier browser ve rsion.

1766 </dd>	2366 </dd>

1767	2367

(...skipping 19 matching lines...) Expand all Loading...
1787	2387

1788 <!-- FUNCTION PARAMETERS -->	2388 <!-- FUNCTION PARAMETERS -->

1789 <dd style="display: none; ">	2389 <dd style="display: none; ">

1790 <div></div>	2390 <div></div>

1791 </dd>	2391 </dd>

1792	2392

1793 </div>	2393 </div>

1794 </div><div>	2394 </div><div>

1795 <div>	2395 <div>

1796 <dt>	2396 <dt>

1797 <var>locale</var>	2397 <var>errorMessage</var>

1798 <em>	2398 <em>

1799	2399

1800 <!-- TYPE -->	2400 <!-- TYPE -->

1801 <div style="display:inline">	2401 <div style="display:inline">

1802 (	2402 (

1803 <span class="optional">optional</span>	2403 <span class="optional">optional</span>

1804 <span class="enum" style="display: none; ">enumerated</span>	2404 <span class="enum" style="display: none; ">enumerated</span>

1805 <span id="typeTemplate">	2405 <span id="typeTemplate">

1806 <span style="display: none; ">	2406 <span style="display: none; ">

1807 <a> Type</a>	2407 <a> Type</a>

1808 </span>	2408 </span>

1809 <span>	2409 <span>

1810 <span style="display: none; ">	2410 <span style="display: none; ">

1811 array of <span><span></span></span>	2411 array of <span><span></span></span>

1812 </span>	2412 </span>

1813 <span>string</span>	2413 <span>string</span>

1814 <span style="display: none; "></span>	2414 <span style="display: none; "></span>

1815 </span>	2415 </span>

1816 </span>	2416 </span>

1817 )	2417 )

1818 </div>	2418 </div>

1819	2419

1820 </em>	2420 </em>

1821 </dt>	2421 </dt>

1822 <dd class="todo" style="display: none; ">	2422 <dd class="todo" style="display: none; ">

1823 Undocumented.	2423 Undocumented.

1824 </dd>	2424 </dd>

1825 <dd>The language and region code that specify the language and dialect to be used for synthesis, in the form <language>-<region>, e.g. en-US, en-GB, f r-CA, zh-CN, etc.</region></language></dd>	2425 <dd>The error message, if the message is 'error'.</dd>
	kathyw 2011/07/13 20:39:58 error message -> error description message -> eve error message -> error description message -> event type dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > error message -> error description > > message -> event type Done.
1826 <dd style="display: none; ">	2426 <dd style="display: none; ">

1827 This parameter was added in version	2427 This parameter was added in version

1828 <b><span></span></b>.	2428 <b><span></span></b>.

1829 You must omit this parameter in earlier versions,	2429 You must omit this parameter in earlier versions,

1830 and you may omit it in any version. If you require this	2430 and you may omit it in any version. If you require this

1831 parameter, the manifest key	2431 parameter, the manifest key

1832 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	2432 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1833 can ensure that your extension won't be run in an earlier browser ve rsion.	2433 can ensure that your extension won't be run in an earlier browser ve rsion.

1834 </dd>	2434 </dd>

1835	2435

(...skipping 16 matching lines...) Expand all Loading...
1852 <dd style="display: none; ">	2452 <dd style="display: none; ">

1853 <div></div>	2453 <div></div>

1854 </dd>	2454 </dd>

1855	2455

1856 <!-- FUNCTION PARAMETERS -->	2456 <!-- FUNCTION PARAMETERS -->

1857 <dd style="display: none; ">	2457 <dd style="display: none; ">

1858 <div></div>	2458 <div></div>

1859 </dd>	2459 </dd>

1860	2460

1861 </div>	2461 </div>

1862 </div><div>	2462 </div>

	2463 </dl>

	2464 </dd>

	2465

	2466 <!-- OBJECT METHODS -->

	2467 <dd style="display: none; ">

	2468 <div></div>

	2469 </dd>

	2470

	2471 <!-- OBJECT EVENT FIELDS -->

	2472 <dd style="display: none; ">

	2473 <div></div>

	2474 </dd>

	2475

	2476 <!-- FUNCTION PARAMETERS -->

	2477 <dd style="display: none; ">

	2478 <div></div>

	2479 </dd>

	2480

	2481 </div>

	2482

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

	2484 <a name="type-TtsVoice"></a>

	2485 <h4>TtsVoice</h4>

	2486

	2487 <div>

	2488 <dt>

	2489 <var style="display: none; ">paramName</var>

	2490 <em>

	2491

	2492 <!-- TYPE -->

	2493 <div style="display:inline">

	2494 (

	2495 <span class="optional" style="display: none; ">optional</spa n>

	2496 <span class="enum" style="display: none; ">enumerated</span>

	2497 <span id="typeTemplate">

	2498 <span style="display: none; ">

	2499 <a> Type</a>

	2500 </span>

	2501 <span>

	2502 <span style="display: none; ">

	2503 array of <span><span></span></span>

	2504 </span>

	2505 <span>object</span>

	2506 <span style="display: none; "></span>

	2507 </span>

	2508 </span>

	2509 )

	2510 </div>

	2511

	2512 </em>

	2513 </dt>

	2514 <dd class="todo" style="display: none; ">

	2515 Undocumented.

	2516 </dd>

	2517 <dd>A description of a voice available for speech synthesis.</dd>

	2518 <dd style="display: none; ">

	2519 This parameter was added in version

	2520 <b><span></span></b>.

	2521 You must omit this parameter in earlier versions,

	2522 and you may omit it in any version. If you require this

	2523 parameter, the manifest key

	2524 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

	2525 can ensure that your extension won't be run in an earlier browser ve rsion.

	2526 </dd>

	2527

	2528 <!-- OBJECT PROPERTIES -->

	2529 <dd>

	2530 <dl>

	2531 <div>

1863 <div>	2532 <div>

1864 <dt>	2533 <dt>

1865 <var>gender</var>	2534 <var>voiceName</var>

1866 <em>	2535 <em>

1867	2536

1868 <!-- TYPE -->	2537 <!-- TYPE -->

1869 <div style="display:inline">	2538 <div style="display:inline">

1870 (	2539 (

1871 <span class="optional">optional</span>	2540 <span class="optional">optional</span>

1872 <span class="enum">enumerated</span>	2541 <span class="enum" style="display: none; ">enumerated</span>

1873 <span id="typeTemplate">	2542 <span id="typeTemplate">

1874 <span style="display: none; ">	2543 <span style="display: none; ">

1875 <a> Type</a>	2544 <a> Type</a>

1876 </span>	2545 </span>

1877 <span>	2546 <span>

1878 <span style="display: none; ">	2547 <span style="display: none; ">

1879 array of <span><span></span></span>	2548 array of <span><span></span></span>

1880 </span>	2549 </span>

1881 <span>string</span>	2550 <span>string</span>

1882 <span>["male", "female"]</span>	2551 <span style="display: none; "></span>

1883 </span>	2552 </span>

1884 </span>	2553 </span>

1885 )	2554 )

1886 </div>	2555 </div>

1887	2556

1888 </em>	2557 </em>

1889 </dt>	2558 </dt>

1890 <dd class="todo" style="display: none; ">	2559 <dd class="todo" style="display: none; ">

1891 Undocumented.	2560 Undocumented.

1892 </dd>	2561 </dd>

1893 <dd>Gender of voice for synthesized speech.</dd>	2562 <dd>The name of the voice.</dd>

1894 <dd style="display: none; ">	2563 <dd style="display: none; ">

1895 This parameter was added in version	2564 This parameter was added in version

1896 <b><span></span></b>.	2565 <b><span></span></b>.

1897 You must omit this parameter in earlier versions,	2566 You must omit this parameter in earlier versions,

1898 and you may omit it in any version. If you require this	2567 and you may omit it in any version. If you require this

1899 parameter, the manifest key	2568 parameter, the manifest key

1900 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	2569 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1901 can ensure that your extension won't be run in an earlier browser ve rsion.	2570 can ensure that your extension won't be run in an earlier browser ve rsion.

1902 </dd>	2571 </dd>

1903	2572

(...skipping 19 matching lines...) Expand all Loading...
1923	2592

1924 <!-- FUNCTION PARAMETERS -->	2593 <!-- FUNCTION PARAMETERS -->

1925 <dd style="display: none; ">	2594 <dd style="display: none; ">

1926 <div></div>	2595 <div></div>

1927 </dd>	2596 </dd>

1928	2597

1929 </div>	2598 </div>

1930 </div><div>	2599 </div><div>

1931 <div>	2600 <div>

1932 <dt>	2601 <dt>

1933 <var>rate</var>	2602 <var>lang</var>

1934 <em>	2603 <em>

1935	2604

1936 <!-- TYPE -->	2605 <!-- TYPE -->

1937 <div style="display:inline">	2606 <div style="display:inline">

1938 (	2607 (

1939 <span class="optional">optional</span>	2608 <span class="optional">optional</span>

1940 <span class="enum" style="display: none; ">enumerated</span>	2609 <span class="enum" style="display: none; ">enumerated</span>

1941 <span id="typeTemplate">	2610 <span id="typeTemplate">

1942 <span style="display: none; ">	2611 <span style="display: none; ">

1943 <a> Type</a>	2612 <a> Type</a>

1944 </span>	2613 </span>

1945 <span>	2614 <span>

1946 <span style="display: none; ">	2615 <span style="display: none; ">

1947 array of <span><span></span></span>	2616 array of <span><span></span></span>

1948 </span>	2617 </span>

1949 <span>number</span>	2618 <span>string</span>

1950 <span style="display: none; "></span>	2619 <span style="display: none; "></span>

1951 </span>	2620 </span>

1952 </span>	2621 </span>

1953 )	2622 )

1954 </div>	2623 </div>

1955	2624

1956 </em>	2625 </em>

1957 </dt>	2626 </dt>

1958 <dd class="todo" style="display: none; ">	2627 <dd class="todo" style="display: none; ">

1959 Undocumented.	2628 Undocumented.

1960 </dd>	2629 </dd>

1961 <dd>Speaking speed between 0 and 1 inclusive, with 0 being slowest and 1 being fastest.</dd>	2630 <dd>The language that this voice supports, in the form <language&gt ;-<region>. Examples: 'en', 'en-US', 'en-GB', 'zh-CN', etc.</dd>
	kathyw 2011/07/13 20:39:58 same <> -> <em>...</em> change as above. delete " same <> -> <em>...</em> change as above. delete ", etc" (It's unnecessary) dmazzoni 2011/07/14 06:50:55 Done. Show quoted text On 2011/07/13 20:39:58, kathyw wrote: > same <> -> <em>...</em> change as above. > > delete ", etc" > (It's unnecessary) Done.
1962 <dd style="display: none; ">	2631 <dd style="display: none; ">

1963 This parameter was added in version	2632 This parameter was added in version

1964 <b><span></span></b>.	2633 <b><span></span></b>.

1965 You must omit this parameter in earlier versions,	2634 You must omit this parameter in earlier versions,

1966 and you may omit it in any version. If you require this	2635 and you may omit it in any version. If you require this

1967 parameter, the manifest key	2636 parameter, the manifest key

1968 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	2637 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

1969 can ensure that your extension won't be run in an earlier browser ve rsion.	2638 can ensure that your extension won't be run in an earlier browser ve rsion.

1970 </dd>	2639 </dd>

1971	2640

(...skipping 19 matching lines...) Expand all Loading...
1991	2660

1992 <!-- FUNCTION PARAMETERS -->	2661 <!-- FUNCTION PARAMETERS -->

1993 <dd style="display: none; ">	2662 <dd style="display: none; ">

1994 <div></div>	2663 <div></div>

1995 </dd>	2664 </dd>

1996	2665

1997 </div>	2666 </div>

1998 </div><div>	2667 </div><div>

1999 <div>	2668 <div>

2000 <dt>	2669 <dt>

2001 <var>pitch</var>	2670 <var>gender</var>

2002 <em>	2671 <em>

2003	2672

2004 <!-- TYPE -->	2673 <!-- TYPE -->

2005 <div style="display:inline">	2674 <div style="display:inline">

2006 (	2675 (

2007 <span class="optional">optional</span>	2676 <span class="optional">optional</span>

2008 <span class="enum" style="display: none; ">enumerated</span>	2677 <span class="enum">enumerated</span>

2009 <span id="typeTemplate">	2678 <span id="typeTemplate">

2010 <span style="display: none; ">	2679 <span style="display: none; ">

2011 <a> Type</a>	2680 <a> Type</a>

2012 </span>	2681 </span>

2013 <span>	2682 <span>

2014 <span style="display: none; ">	2683 <span style="display: none; ">

2015 array of <span><span></span></span>	2684 array of <span><span></span></span>

2016 </span>	2685 </span>

2017 <span>number</span>	2686 <span>string</span>

2018 <span style="display: none; "></span>	2687 <span>["male", "female"]</span>

2019 </span>	2688 </span>

2020 </span>	2689 </span>

2021 )	2690 )

2022 </div>	2691 </div>

2023	2692

2024 </em>	2693 </em>

2025 </dt>	2694 </dt>

2026 <dd class="todo" style="display: none; ">	2695 <dd class="todo" style="display: none; ">

2027 Undocumented.	2696 Undocumented.

2028 </dd>	2697 </dd>

2029 <dd>Speaking pitch between 0 and 1 inclusive, with 0 being lowest and 1 being highest.</dd>	2698 <dd>This voice's gender.</dd>

2030 <dd style="display: none; ">	2699 <dd style="display: none; ">

2031 This parameter was added in version	2700 This parameter was added in version

2032 <b><span></span></b>.	2701 <b><span></span></b>.

2033 You must omit this parameter in earlier versions,	2702 You must omit this parameter in earlier versions,

2034 and you may omit it in any version. If you require this	2703 and you may omit it in any version. If you require this

2035 parameter, the manifest key	2704 parameter, the manifest key

2036 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	2705 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

2037 can ensure that your extension won't be run in an earlier browser ve rsion.	2706 can ensure that your extension won't be run in an earlier browser ve rsion.

2038 </dd>	2707 </dd>

2039	2708

(...skipping 19 matching lines...) Expand all Loading...
2059	2728

2060 <!-- FUNCTION PARAMETERS -->	2729 <!-- FUNCTION PARAMETERS -->

2061 <dd style="display: none; ">	2730 <dd style="display: none; ">

2062 <div></div>	2731 <div></div>

2063 </dd>	2732 </dd>

2064	2733

2065 </div>	2734 </div>

2066 </div><div>	2735 </div><div>

2067 <div>	2736 <div>

2068 <dt>	2737 <dt>

2069 <var>volume</var>	2738 <var>extensionId</var>

2070 <em>	2739 <em>

2071	2740

2072 <!-- TYPE -->	2741 <!-- TYPE -->

2073 <div style="display:inline">	2742 <div style="display:inline">

2074 (	2743 (

2075 <span class="optional">optional</span>	2744 <span class="optional">optional</span>

2076 <span class="enum" style="display: none; ">enumerated</span>	2745 <span class="enum" style="display: none; ">enumerated</span>

2077 <span id="typeTemplate">	2746 <span id="typeTemplate">

2078 <span style="display: none; ">	2747 <span style="display: none; ">

2079 <a> Type</a>	2748 <a> Type</a>

2080 </span>	2749 </span>

2081 <span>	2750 <span>

2082 <span style="display: none; ">	2751 <span style="display: none; ">

2083 array of <span><span></span></span>	2752 array of <span><span></span></span>

2084 </span>	2753 </span>

2085 <span>number</span>	2754 <span>string</span>

2086 <span style="display: none; "></span>	2755 <span style="display: none; "></span>

2087 </span>	2756 </span>

2088 </span>	2757 </span>

2089 )	2758 )

2090 </div>	2759 </div>

2091	2760

2092 </em>	2761 </em>

2093 </dt>	2762 </dt>

2094 <dd class="todo" style="display: none; ">	2763 <dd class="todo" style="display: none; ">

2095 Undocumented.	2764 Undocumented.

2096 </dd>	2765 </dd>

2097 <dd>Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1 being highest.</dd>	2766 <dd>The ID of the extension providing this voice.</dd>

2098 <dd style="display: none; ">	2767 <dd style="display: none; ">

2099 This parameter was added in version	2768 This parameter was added in version

2100 <b><span></span></b>.	2769 <b><span></span></b>.

2101 You must omit this parameter in earlier versions,	2770 You must omit this parameter in earlier versions,

2102 and you may omit it in any version. If you require this	2771 and you may omit it in any version. If you require this

2103 parameter, the manifest key	2772 parameter, the manifest key

2104 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	2773 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

2105 can ensure that your extension won't be run in an earlier browser ve rsion.	2774 can ensure that your extension won't be run in an earlier browser ve rsion.

2106 </dd>	2775 </dd>

2107	2776

(...skipping 16 matching lines...) Expand all Loading...
2124 <dd style="display: none; ">	2793 <dd style="display: none; ">

2125 <div></div>	2794 <div></div>

2126 </dd>	2795 </dd>

2127	2796

2128 <!-- FUNCTION PARAMETERS -->	2797 <!-- FUNCTION PARAMETERS -->

2129 <dd style="display: none; ">	2798 <dd style="display: none; ">

2130 <div></div>	2799 <div></div>

2131 </dd>	2800 </dd>

2132	2801

2133 </div>	2802 </div>

2134 </div>	2803 </div><div>

2135 </dl>	2804 <div>

2136 </dd>

2137

2138 <!-- OBJECT METHODS -->

2139 <dd style="display: none; ">

2140 <div></div>

2141 </dd>

2142

2143 <!-- OBJECT EVENT FIELDS -->

2144 <dd style="display: none; ">

2145 <div></div>

2146 </dd>

2147

2148 <!-- FUNCTION PARAMETERS -->

2149 <dd style="display: none; ">

2150 <div></div>

2151 </dd>

2152

2153 </div>

2154 </div><div>

2155 <div>

2156 <dt>	2805 <dt>

2157 <var>callback</var>	2806 <var>eventTypes</var>

2158 <em>	2807 <em>

2159	2808

2160 <!-- TYPE -->	2809 <!-- TYPE -->

2161 <div style="display:inline">	2810 <div style="display:inline">

2162 (	2811 (

2163 <span class="optional" style="display: none; ">optional</spa n>	2812 <span class="optional">optional</span>

2164 <span class="enum" style="display: none; ">enumerated</span>	2813 <span class="enum" style="display: none; ">enumerated</span>

2165 <span id="typeTemplate">	2814 <span id="typeTemplate">

2166 <span style="display: none; ">	2815 <span style="display: none; ">

2167 <a> Type</a>	2816 <a> Type</a>

2168 </span>	2817 </span>

2169 <span>	2818 <span>

	2819 <span>

	2820 array of <span><span>

	2821 <span style="display: none; ">

	2822 <a> Type</a>

	2823 </span>

	2824 <span>

2170 <span style="display: none; ">	2825 <span style="display: none; ">

2171 array of <span><span></span></span>	2826 array of <span><span></span></span>

2172 </span>	2827 </span>

2173 <span>function</span>	2828 <span>string</span>

	2829 <span style="display: none; "></span>

	2830 </span>

	2831 </span></span>

	2832 </span>

	2833 <span style="display: none; ">paramType</span>

2174 <span style="display: none; "></span>	2834 <span style="display: none; "></span>

2175 </span>	2835 </span>

2176 </span>	2836 </span>

2177 )	2837 )

2178 </div>	2838 </div>

2179	2839

2180 </em>	2840 </em>

2181 </dt>	2841 </dt>

2182 <dd class="todo" style="display: none; ">	2842 <dd class="todo" style="display: none; ">

2183 Undocumented.	2843 Undocumented.

2184 </dd>	2844 </dd>

2185 <dd>You must call this function when speaking is finished.</dd>	2845 <dd>All of the callback event types that this voice is capable of send ing.</dd>

2186 <dd style="display: none; ">	2846 <dd style="display: none; ">

2187 This parameter was added in version	2847 This parameter was added in version

2188 <b><span></span></b>.	2848 <b><span></span></b>.

2189 You must omit this parameter in earlier versions,	2849 You must omit this parameter in earlier versions,

2190 and you may omit it in any version. If you require this	2850 and you may omit it in any version. If you require this

2191 parameter, the manifest key	2851 parameter, the manifest key

2192 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>	2852 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

2193 can ensure that your extension won't be run in an earlier browser ve rsion.	2853 can ensure that your extension won't be run in an earlier browser ve rsion.

2194 </dd>	2854 </dd>

2195	2855

(...skipping 16 matching lines...) Expand all Loading...
2212 <dd style="display: none; ">	2872 <dd style="display: none; ">

2213 <div></div>	2873 <div></div>

2214 </dd>	2874 </dd>

2215	2875

2216 <!-- FUNCTION PARAMETERS -->	2876 <!-- FUNCTION PARAMETERS -->

2217 <dd style="display: none; ">	2877 <dd style="display: none; ">

2218 <div></div>	2878 <div></div>

2219 </dd>	2879 </dd>

2220	2880

2221 </div>	2881 </div>

2222 </div>	2882 </div>

2223 </dl>	2883 </dl>

2224 </div>	2884 </dd>

2225	2885

2226 <!-- EXTRA PARAMETERS -->	2886 <!-- OBJECT METHODS -->

2227 <div style="display: none; ">	2887 <dd style="display: none; ">

2228 <h4>Extra parameters to addListener</h4>	2888 <div></div>

2229 <dl>	2889 </dd>

2230 <div>

2231 <div>

2232 </div>

2233 </div>

2234 </dl>

2235 </div>

2236	2890

2237 <!-- LISTENER RETURN VALUE -->	2891 <!-- OBJECT EVENT FIELDS -->

2238 <h4 style="display: none; ">Listener returns</h4>	2892 <dd style="display: none; ">

2239 <dl>	2893 <div></div>

2240 <div style="display: none; ">	2894 </dd>

2241 <div>

2242 </div>

2243 </div>

2244 </dl>

2245	2895

2246 </div> <!-- /description -->	2896 <!-- FUNCTION PARAMETERS -->

2247 </div><div class="apiItem">	2897 <dd style="display: none; ">

2248 <a name="event-onStop"></a>	2898 <div></div>

2249 <h4>onStop</h4>	2899 </dd>

2250	2900

2251 <div class="summary">	2901 </div>

2252 <!-- Note: intentionally longer 80 columns -->

2253 <span class="subdued">chrome.experimental.tts.</span><span>onSto p</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>));

2254 </div>

2255

2256 <div class="description">

2257 <p class="todo" style="display: none; ">Undocumented.</p>

2258 <p>Fired when a call is made to tts.stop and this extension may be in the middle of speaking. If an extension receives a call to onStop and spee ch is already stopped, it should do nothing (not raise an error).</p>

2259

2260 <!-- LISTENER PARAMETERS -->

2261 <div style="display: none; ">

2262 <h4>Listener parameters</h4>

2263 <dl>

2264 <div>

2265 <div>

2266 </div>

2267 </div>

2268 </dl>

2269 </div>

2270

2271 <!-- EXTRA PARAMETERS -->

2272 <div style="display: none; ">

2273 <h4>Extra parameters to addListener</h4>

2274 <dl>

2275 <div>

2276 <div>

2277 </div>

2278 </div>

2279 </dl>

2280 </div>

2281

2282 <!-- LISTENER RETURN VALUE -->

2283 <h4 style="display: none; ">Listener returns</h4>

2284 <dl>

2285 <div style="display: none; ">

2286 <div>

2287 </div>

2288 </div>

2289 </dl>

2290

2291 </div> <!-- /description -->

2292 </div> <!-- /apiItem -->

2293

2294 </div> <!-- /apiGroup -->

2295

2296 <!-- TYPES -->

2297 <div class="apiGroup" style="display: none; ">

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

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

2300

2301 <!-- iterates over all types -->

2302 <div class="apiItem">

2303 <a></a>

2304 <h4>type name</h4>

2305

2306 <div>

2307 </div>

2308	2902

2309 </div> <!-- /apiItem -->	2903 </div> <!-- /apiItem -->

2310	2904

2311 </div> <!-- /apiGroup -->	2905 </div> <!-- /apiGroup -->

2312	2906

2313 </div> <!-- /apiPage -->	2907 </div> <!-- /apiPage -->

2314 </div> <!-- /gc-pagecontent -->	2908 </div> <!-- /gc-pagecontent -->

2315 </div> <!-- /g-section -->	2909 </div> <!-- /g-section -->

2316 </div> <!-- /codesiteContent -->	2910 </div> <!-- /codesiteContent -->

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

(...skipping 26 matching lines...) Expand all Loading...
2344 _uff=0;	2938 _uff=0;

2345 urchinTracker();	2939 urchinTracker();

2346 }	2940 }

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

2348 </script>	2942 </script>

2349 <!-- end analytics -->	2943 <!-- end analytics -->

2350 </div>	2944 </div>

2351 </div> <!-- /gc-footer -->	2945 </div> <!-- /gc-footer -->

2352 </div> <!-- /gc-container -->	2946 </div> <!-- /gc-container -->

2353 </body></html>	2947 </body></html>

OLD	NEW