chrome/common/extensions/docs/experimental.tts.html - Issue 7258007: Move the tts and ttsEngine APIs out of experimental, and give

Unified Diff: chrome/common/extensions/docs/experimental.tts.html

Issue 7258007: Move the tts and ttsEngine APIs out of experimental, and give (Closed) Base URL: svn://chrome-svn/chrome/trunk/src/

Patch Set: '' Created 9 years, 5 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: chrome/common/extensions/docs/experimental.tts.html

===================================================================

--- chrome/common/extensions/docs/experimental.tts.html (revision 93167)

+++ chrome/common/extensions/docs/experimental.tts.html (working copy)

@@ -1,2949 +0,0 @@

-<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

- 1) The <head> information in this page is significant, should be uniform

- across api docs and should be edited only with knowledge of the

- templating mechanism.

- 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

- browser, it will be re-generated from the template, json schema and

- authored overview content.

- 4) The <body>.innerHTML is also generated by an offline step so that this

- page may easily be indexed by search engines.

---><html xmlns="http://www.w3.org/1999/xhtml"><head>

- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

- <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">

- </script>

- <script type="text/javascript" src="js/api_page_generator.js"></script>

- <script type="text/javascript" src="js/bootstrap.js"></script>

- <script type="text/javascript" src="js/sidebar.js"></script>

- <title>chrome.experimental.tts - Google Chrome Extensions - Google Code</title></head>

- <body> <div id="gc-container" class="labs">

- <div id="devModeWarning">

- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.

- </div>

-

- <!-- In particular, sub-templates that recurse, must be used by allowing

- jstemplate to make a copy of the template in this section which

- are not operated on by way of the jsskip="true" -->

- <div style="display:none">

-

- <div id="valueTemplate">

- <dt>

- <var>paramName</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

- <span>

- <a> Type</a>

- </span>

- <span>

- array of <span><span></span></span>

- </span>

- <span>paramType</span>

- <span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- <dd>

- Description of this parameter from the json schema.

- </dd>

- <dd>

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd>

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd>

- <div></div>

- </dd>

-

- <dd>

- <div></div>

- </dd>

-

- <dd>

- <div></div>

- </dd>

- </div>

- <div id="functionParametersTemplate">

- <h5>Parameters</h5>

- <dl>

- <div>

- </div>

- </dl>

- </div>

- </div>

- <a id="top"></a>

- <div id="skipto">

- <a href="#gc-pagecontent">Skip to page content</a>

- <a href="#gc-toc">Skip to main navigation</a>

- </div>

-

- <table id="header" width="100%" cellspacing="0" border="0">

- <tbody><tr>

- <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>

- <td valign="middle" width="100%" style="padding-left:0.6em;">

- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">

- <div id="gsc-search-box">

- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">

- <input type="hidden" name="ie" value="UTF-8">

- <input type="text" name="q" value="" size="55">

- <input class="gsc-search-button" type="submit" name="sa" value="Search">

- <br>

- <span class="greytext">e.g. "page action" or "tabs"</span>

- </div>

- </form>

- <script type="text/javascript" src="http://www.google.com/jsapi"></script>

- <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

- <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>

- <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script>

- </td>

- </tr>

- </tbody></table>

- <div id="codesiteContent" class="">

- <a id="gc-topnav-anchor"></a>

- <div id="gc-topnav">

- <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>

- <ul id="home" class="gc-topnav-tabs">

- <li id="home_link">

- <a href="index.html" title="Google Chrome Extensions home page">Home</a>

- </li>

- <li id="docs_link">

- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>

- </li>

- <li id="faq_link">

- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>

- </li>

- <li id="samples_link">

- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>

- </li>

- <li id="group_link">

- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

- </li>

- </ul>

- </div>

- <div class="g-section g-tpl-170">

-

- <div class="g-unit g-first" id="gc-toc">

- <ul>

- <li><a href="getstarted.html">Getting Started</a></li>

- <li><a href="overview.html">Overview</a></li>

- <li><a href="whats_new.html">What's New?</a></li>

- <li><h2><a href="devguide.html">Developer's Guide</a></h2>

- <ul>

- <li>Browser UI

- <ul>

- <li><a href="browserAction.html">Browser Actions</a></li>

- <li><a href="contextMenus.html">Context Menus</a></li>

- <li><a href="notifications.html">Desktop Notifications</a></li>

- <li><a href="omnibox.html">Omnibox</a></li>

- <li><a href="options.html">Options Pages</a></li>

- <li><a href="override.html">Override Pages</a></li>

- <li><a href="pageAction.html">Page Actions</a></li>

- </ul>

- </li>

- <li>Browser Interaction

- <ul>

- <li><a href="bookmarks.html">Bookmarks</a></li>

- <li><a href="cookies.html">Cookies</a></li>

- <li><a href="events.html">Events</a></li>

- <li><a href="history.html">History</a></li>

- <li><a href="management.html">Management</a></li>

- <li><a href="tabs.html">Tabs</a></li>

- <li><a href="windows.html">Windows</a></li>

- </ul>

- </li>

- <li>Implementation

- <ul>

- <li><a href="a11y.html">Accessibility</a></li>

- <li><a href="background_pages.html">Background Pages</a></li>

- <li><a href="content_scripts.html">Content Scripts</a></li>

- <li><a href="xhr.html">Cross-Origin XHR</a></li>

- <li><a href="idle.html">Idle</a></li>

- <li><a href="i18n.html">Internationalization</a></li>

- <li><a href="messaging.html">Message Passing</a></li>

- <li><a href="npapi.html">NPAPI Plugins</a></li>

- </ul>

- </li>

- <li>Finishing

- <ul>

- <li><a href="hosting.html">Hosting</a></li>

- <li><a href="external_extensions.html">Other Deployment Options</a></li>

- </ul>

- </li>

- </ul>

- </li>

- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

- <li><h2><a href="tutorials.html">Tutorials</a></h2>

- <ul>

- <li><a href="tut_debugging.html">Debugging</a></li>

- <li><a href="tut_analytics.html">Google Analytics</a></li>

- <li><a href="tut_oauth.html">OAuth</a></li>

- </ul>

- </li>

- <li><h2>Reference</h2>

- <ul>

- <li>Formats

- <ul>

- <li><a href="manifest.html">Manifest Files</a></li>

- <li><a href="match_patterns.html">Match Patterns</a></li>

- </ul>

- </li>

- <li><a href="permission_warnings.html">Permission Warnings</a></li>

- <li><a href="api_index.html">chrome.* APIs</a></li>

- <li><a href="api_other.html">Other APIs</a></li>

- </ul>

- </li>

- <li><h2><a href="samples.html">Samples</a></h2></li>

- <div class="line"> </div>

- <li><h2>More</h2>

- <ul>

- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>

- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>

- <li><a href="themes.html">Themes</a></li>

- </ul>

- </li>

- </ul>

- </div>

- <script>

- initToggles();

- </script>

- <div class="g-unit" id="gc-pagecontent">

- <div id="pageTitle">

- <h1 class="page_title">chrome.experimental.tts</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#overview">Overview</a>

- <ol>

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

- <a>h3Name</a>

- </li>

- </ol>

- </li><li>

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

- <ol>

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

- <a>h3Name</a>

- </li>

- </ol>

- </li><li>

- <a href="#events">Listening to events</a>

- <ol>

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

- <a>h3Name</a>

- </li>

- </ol>

- </li><li>

- <a href="#ssml">SSML markup</a>

- <ol>

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

- <a>h3Name</a>

- </li>

- </ol>

- </li><li>

- <a href="#choosing_voice">Choosing a voice</a>

- <ol>

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

- <a>h3Name</a>

- </li>

- </ol>

- </li>

- <li>

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

- <ol>

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

- <a href="#properties">Properties</a>

- <ol>

- <li>

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

- </li>

- </ol>

- </li>

- <li>

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

- <ol>

- <li>

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

- </li><li>

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

- </li><li>

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

- </li><li>

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

- </li>

- </ol>

- </li>

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

- <a>Events</a>

- <ol>

- <li>

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

- </li>

- </ol>

- </li>

- <li>

- <a href="#types">Types</a>

- <ol>

- <li>

- <a href="#type-TtsEvent">TtsEvent</a>

- </li><li>

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

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

- <p id="classSummary">

- For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.

- </p>

-

- <div id="static"><p id="classSummary">

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

-text-to-speech (TTS) from your extension or packaged app.

-See also the related

-<a href="experimental.ttsEngine.html">experimental.ttsEngine</a>

-module, which allows an extension to implement a speech engine.

-</p>

-<p class="note"><b>Give us feedback:</b> If you have suggestions,

-especially changes that should be made before stabilizing the first

-version of this API, please send your ideas to the

-<a href="http://groups.google.com/a/chromium.org/group/chromium-extensions">chromium-extensions</a>

-group.</p>

-<h2 id="overview">Overview</h2>

-<p>To enable this experimental API, visit

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

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

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

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

-install extensions that register themselves as alternative speech

-engines.</p>

-<h2 id="generating_speech">Generating speech</h2>

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

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

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

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

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

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

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

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

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

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

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

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

-<p>By default, each call to <code>speak()</code> interrupts any

-ongoing speech and speaks immediately. To determine if a call would be

-interrupting anything, you can call <code>isSpeaking()</code>. In

-addition, you can use the <code>enqueue</code> option to cause this

-utterance to be added to a queue of utterances that will be spoken

-when the current utterance has finished.</p>

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

- 'Speak this first.');

-chrome.experimental.tts.speak(

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

-</pre>

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

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

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

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

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

-the callback, check

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

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

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

- utterance,

- options,

- function() {

- if (chrome.extension.lastError) {

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

- }

- });</pre>

-<p>The callback returns right away, before the engine has started

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

-syntax errors in your use of the TTS API, not to catch all possible

-errors that might occur in the process of synthesizing and outputting

-speech. To catch these errors too, you need to use an event listener,

-described below.</p>

-<h2 id="events">Listening to events</h2>

-<p>To get more real-time information about the status of synthesized speech,

-pass an event listener in the options to <code>speak()</code>, like this:</p>

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

- utterance,

- {

- onEvent: function(event) {

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

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

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

- }

- },

- callback);</pre>

-<p>Each event includes an event type, the character index of the current

-speech relative to the utterance, and for error events, an optional

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

-<ul>

- <li><code>'start'</code>: The engine has started speaking the utterance.

- </li><li><code>'word'</code>: A word boundary was reached. Use

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

- position.

- </li><li><code>'sentence'</code>: A sentence boundary was reached. Use

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

- position.

- </li><li><code>'marker'</code>: An SSML marker was reached. Use

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

- position.

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

- </li><li><code>'interrupted'</code>: This utterance was interrupted by another

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

- finish.

- </li><li><code>'cancelled'</code>: This utterance was queued, but then

- cancelled by another call to <code>speak()</code> or

- <code>stop()</code> and never began to speak at all.

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

- this utterance cannot be spoken.

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

-</li></ul>

-<p>Four of the event types—<code>'end'</code>, <code>'interrupted'</code>,

-<code>'cancelled'</code>, and <code>'error'</code>—are <i>final</i>.

-After one of those events is received, this utterance will no longer

-speak and no new events from this utterance will be received.</p>

-<p>Some voices may not support all event types, and some voices may not

-send any events at all. If you do not want to use a voice unless it sends

-certain events, pass the events you require in the

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

-<code>getVoices()</code> to choose a voice that meets your requirements.

-Both are documented below.</p>

-<h2 id="ssml">SSML markup</h2>

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

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

-Language (SSML)</a>. If you use SSML, the first argument to

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

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

-fragment.</p>

-<p>For example:</p>

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

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

- '<speak>' +

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

- ' word of this sentence was emphasized.' +

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

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

-SSML at all, but all engines are required to ignore any SSML they don't

-support and to still speak the underlying text.</p>

-<h2 id="choosing_voice">Choosing a voice</h2>

-<p>By default, Chrome chooses the most appropriate voice for each

-utterance you want to speak, based on the language and gender. On most

-Windows, Mac OS X, and Chrome OS systems, speech synthesis provided by

-the operating system should be able to speak any text in at least one

-language. Some users may have a variety of voices available, though,

-from their operating system and from speech engines implemented by other

-Chrome extensions. In those cases, you can implement custom code to choose

-the appropriate voice, or to present the user with a list of choices.</p>

-<p>To get a list of all voices, call <code>getVoices()</code> and pass it

-a function that receives an array of <code>TtsVoice</code> objects as its

-argument:</p>

-<pre>chrome.experimental.tts.getVoices(

- function(voices) {

- for (var i = 0; i < voices.length; i++) {

- console.log('Voice ' + i + ':');

- console.log(' name: ' + voices[i].voiceName);

- console.log(' lang: ' + voices[i].lang);

- console.log(' gender: ' + voices[i].gender);

- console.log(' extension id: ' + voices[i].extensionId);

- console.log(' event types: ' + voices[i].eventTypes);

- }

- });</pre>

-</div>

-

- <div class="apiPage">

- <a name="apiReference"></a>

- <h2>API reference: chrome.experimental.tts</h2>

-

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

- <a name="properties"></a>

- <h3 id="properties">Properties</h3>

- <div>

- <a></a>

- <h4>getLastError</h4>

- <div class="summary">

-

- <span>chrome.extension</span><span>lastError</span>

- </div>

- <div>

- </div>

- </div>

-

- <div id="methodsTemplate" class="apiGroup">

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

- <h3>Methods</h3>

-

- <div class="apiItem">

- <a name="method-getVoices"></a>

- <h4>getVoices</h4>

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

-

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

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

- <div class="description">

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

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

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>function</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

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

- Description of this parameter from the json schema.

- </dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </dl>

-

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

- <dl>

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

- <div>

- </div>

- </dl>

-

- <div>

- <h4>Callback function</h4>

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

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

- that looks like this:

- </p>

- <p>

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

- specify a function that looks like this:

- </p>

-

- <pre>function(<span>array of TtsVoice voices</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>voices</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

- array of <span><span>

- <span>

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

- </span>

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

- <span>

- array of <span><span></span></span>

- </span>

- <span>paramType</span>

- <span></span>

- </span>

- </span></span>

- </span>

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

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

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

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </dl>

- </div>

-

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

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

- If you require this function, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </p>

- </div>

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

- <a name="method-isSpeaking"></a>

- <h4>isSpeaking</h4>

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

-

- <span>chrome.experimental.tts.isSpeaking</span>(<span class="optional"><span style="display: none; ">, </span><span>function</span>

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

- <div class="description">

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

- <p>Check if the engine is currently speaking.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>function</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

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

- Description of this parameter from the json schema.

- </dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </dl>

-

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

- <dl>

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

- <div>

- </div>

- </dl>

-

- <div>

- <h4>Callback function</h4>

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

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

- that looks like this:

- </p>

- <p>

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

- specify a function that looks like this:

- </p>

-

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

- <dl>

- <div>

- <dt>

- <var>speaking</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>boolean</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>True if speaking, false otherwise.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </dl>

- </div>

-

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

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

- If you require this function, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </p>

- </div>

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

- <a name="method-speak"></a>

- <h4>speak</h4>

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

-

- <span>chrome.experimental.tts.speak</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>

- <var><span>utterance</span></var></span><span class="optional"><span>, </span><span>object</span>

- <var><span>options</span></var></span><span class="optional"><span>, </span><span>function</span>

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

- <div class="description">

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

- <p>Speak text using a text-to-speech engine.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>utterance</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The text to speak, either plain text 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>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>options</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>object</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The speech options.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>enqueue</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>boolean</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>If true, enqueues this utterance if TTS is already in progress. If false (the default), interrupts any current speech and flushes the speech queue before speaking this new utterance.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>voiceName</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The name of the voice to use for synthesis. If empty, uses any available voice.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>extensionId</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The extension ID of the speech engine to use, if known.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>lang</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The language to be used for synthesis, in the form <em>language</em>-<em>region</em>. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>gender</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

- <span>["male", "female"]</span>

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>Gender of voice for synthesized speech.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>rate</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>number</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>Speaking rate relative to the default rate for this voice. 1.0 is the default rate, normally around 180 to 220 words per minute. 2.0 is twice as fast, and 0.5 is half as fast. Values below 0.1 or above 10.0 are strictly disallowed, but many voices will constrain the minimum and maximum rates further—for example a particular voice may not actually speak faster than 3 times normal even if you specify a value larger than 3.0.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>pitch</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>number</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>Speaking pitch between 0 and 2 inclusive, with 0 being lowest and 2 being highest. 1.0 corresponds to a voice's default pitch.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>volume</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>number</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1 being highest, with a default of 1.0.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>requiredEventTypes</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

- array of <span><span>

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

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

- </span>

- </span></span>

- </span>

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

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The TTS event types the voice must support.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>desiredEventTypes</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

- array of <span><span>

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

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

- </span>

- </span></span>

- </span>

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

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The TTS event types that you are interested in listening to. If missing, all event types may be sent.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>onEvent</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>function</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>This function is called with events that occur in the process of speaking the utterance.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>event</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

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

- <span id="typeTemplate">

- <span>

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

- </span>

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

- <span>

- array of <span><span></span></span>

- </span>

- <span>paramType</span>

- <span></span>

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

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

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </dl>

- </div>

- </dd>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>function</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>Called right away, before speech finishes. Check chrome.extension.lastError to make sure there were no errors. Use options.onEvent to get more detailed feedback.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </dl>

-

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

- <dl>

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

- <div>

- </div>

- </dl>

-

- <div>

- <h4>Callback function</h4>

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

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

- that looks like this:

- </p>

- <p>

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

- specify a function that looks like this:

- </p>

-

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

- <dl>

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

- <div>

- </div>

- </dl>

- </div>

-

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

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

- If you require this function, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </p>

- </div>

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

- <a name="method-stop"></a>

- <h4>stop</h4>

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

-

- <span>chrome.experimental.tts.stop</span>(<span style="display: none; "><span>, </span><span></span>

- <var><span></span></var></span>)</div>

- <div class="description">

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

- <p>Stop any current speech.</p>

-

- <h4 style="display: none; ">Parameters</h4>

- <dl>

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

- <div>

- </div>

- </dl>

-

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

- <dl>

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

- <div>

- </div>

- </dl>

-

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

- <div>

- <h4>Callback function</h4>

- <p>

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

- that looks like this:

- </p>

- <p>

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

- specify a function that looks like this:

- </p>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </div>

-

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

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

- If you require this function, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </p>

- </div>

- </div>

- </div>

-

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

- <a></a>

- <h3>Events</h3>

-

- <div class="apiItem">

- <a></a>

- <h4>event name</h4>

- <div class="summary">

-

- <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_param2</span>));

- </div>

- <div class="description">

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

- <p>

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

- </p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- </div>

- </dl>

- </div>

-

- <div>

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

- <dl>

- <div>

- </div>

- </dl>

- </div>

-

- <h4>Listener returns</h4>

- <dl>

- <div>

- </div>

- </dl>

- </div>

- </div>

- </div>

-

- <div class="apiGroup">

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

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

-

- <div class="apiItem">

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

- <h4>TtsEvent</h4>

- <div>

- <dt>

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

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>object</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>An event from the TTS engine to communicate the status of an utterance.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>type</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

- <span>["start", "end", "word", "sentence", "marker", "interrupted", "cancelled", "error"]</span>

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The type can be 'start' as soon as speech has started, 'word' when a word boundary is reached, 'sentence' when a sentence boundary is reached, 'marker' when an SSML mark element is reached, 'end' when the end of the utterance is reached, 'interrupted' when the utterance is stopped or interrupted before reaching the end, 'cancelled' when it's removed from the queue before ever being synthesized, or 'error' when any other error occurs.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>charIndex</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>number</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The index of the current character in the utterance.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>errorMessage</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The error description, if the event type is 'error'.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

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

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

- <h4>TtsVoice</h4>

- <div>

- <dt>

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

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>object</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

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

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>voiceName</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The name of the voice.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>lang</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The language that this voice supports, in the form <em>language</em>-<em>region</em>. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>gender</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

- <span>["male", "female"]</span>

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>This voice's gender.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>extensionId</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>The ID of the extension providing this voice.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>eventTypes</var>

- <em>

-

- <div style="display:inline">

- (

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

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

- <span id="typeTemplate">

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

- <a> Type</a>

- </span>

- <span>

- array of <span><span>

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

- <a> Type</a>

- </span>

- <span>

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

- array of <span><span></span></span>

- </span>

- <span>string</span>

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

- </span>

- </span></span>

- </span>

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

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

- </span>

- )

- </div>

- </em>

- </dt>

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

- Undocumented.

- </dd>

- <dd>All of the callback event types that this voice is capable of sending.</dd>

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

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

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

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </dl>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

-

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

- <div></div>

- </dd>

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- <div id="gc-footer" --="">

- <div class="text">

- <p>

- Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,

- the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons

- Attribution 3.0 License</a>, and code samples are licensed under the

- <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.

- </p>

- <p>

- </p>

-

-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>

-<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script>

-<script type="text/javascript">

- // chrome doc tracking

- try {

- var engdocs = _gat._getTracker("YT-10763712-2");

- engdocs._trackPageview();

- } catch(err) {}

- // code.google.com site-wide tracking

- try {

- _uacct="UA-18071-1";

- _uanchor=1;

- _uff=0;

- urchinTracker();

- }

- catch(e) {/* urchinTracker not available. */}

-</script>

-

- </div>

- </div>

- </div>

-</body></html>

« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/experimental.ttsEngine.html » ('j') | no next file with comments »