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

Unified Diff: chrome/common/extensions/docs/experimental.tts_engine.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, 6 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

« chrome/common/extensions/docs/experimental.tts.html ('K') | « chrome/common/extensions/docs/experimental.tts.html ('k') | chrome/common/extensions/docs/static/experimental.tts.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

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

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

--- chrome/common/extensions/docs/experimental.tts_engine.html (revision 0)

+++ chrome/common/extensions/docs/experimental.tts_engine.html (revision 0)

@@ -0,0 +1,1536 @@

+<!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_engine - 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_engine</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="#manifest">Manifest</a>

+ <ol>

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

+ <a>h3Name</a>

+ </li>

+ </ol>

+ </li><li>

+ <a href="#handling_speech_events">Handling Speech Events</a>

+ <ol>

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

+ <a>h3Name</a>

+ </li>

+ </ol>

+ </li>

+ <li>

+ <a href="#apiReference">API reference: chrome.experimental.tts_engine</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 style="display: none; ">

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

+ </li>

+ </ol>

+ </li>

+ <li>

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

+ <ol>

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

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

+ </li><li>

+ <a href="#event-onSpeak">onSpeak</a>

+ </li><li>

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

+ </li>

+ </ol>

+ </li>

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

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

+ <ol>

+ <li>

+ <a href="#id-anchor">id</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_engine</code> module to

+implement a text-to-speech (TTS) engine using an extension. If your

+extension registers using this API, it will receive events containing

+the intended utterance and other parameters when any extension or packaged

+app uses the

+<a href="experimental.tts.html">experimental.tts</a>

+module to generate speech. Your extension can then use any available

+web technology to synthesize and output the speech, and send events back

+to the calling function to report the status.

+</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>An extension can register itself as a speech engine. By doing so, it

+can intercept some or all calls to functions such as

+<a href="experimental.tts.html#method-speak"><code>speak()</code></a> and

+<a href="experimental.tts.html#method-stop"><code>stop()</code></a>

+and provide an alternate implementation.

+Extensions are free to use any available web technology

+to provide speech, including streaming audio from a server, HTML5 audio,

+Native Client, or Flash. An extension could even do something different

+with the utterances, like display closed captions in a pop-up window or

+send them as log messages to a remote server.</p>

+<h2 id="manifest">Manifest</h2>

+<p>To implement a TTS engine, an extension must first declare all voices

+it provides in the extension manifest, like this:</p>

+<pre>{

+ "name": "My TTS Engine",

+ "version": "1.0",

+ <b>"permissions": ["experimental"],

+ "tts_engine": {

+ "voices": [

+ {

+ "voice_name": "Alice",

+ "lang": "en-US",

+ "gender": "female",

+ "event_types": ["start", "marker", "end"]

+ },

+ {

+ "voice_name": "Pat",

+ "lang": "en-US",

+ "event_types": ["end"]

+ }

+ ]

+ },</b>

+ "background_page": "background.html",

+}</pre>

+<p>An extension can specify any number of voices.</p>

+<p>The <code>voice_name</code> parameter is required. The name should be

+descriptive enough that it identifies the name of the voice and the

+engine used. In the unlikely event that two extensions register voices

+with the same name, a client can manually specify the extension id to

kathyw 2011/07/13 20:39:58 manually specify the extension id to -> specify th

dmazzoni 2011/07/14 06:50:55 Done.

+receive speech calls.</p>

+The <code>gender</code> parameter is optional. If your voice corresponds

+to a male or female voice, you can use this parameter to help clients

+choose the most appropriate voice for their application.

+<p>The <code>lang</code> parameter is optional, but highly recommended.

+Almost always, a voice can synthesize speech in just a single language.

+When an engine supports more than one language, it can easily register a

+separate voice for each language. Under rare circumstances where a single

+voice can handle more than one language, it's easiest to just list two

+separate voices and handle them using the same logic internally. However,

+if you want to create a voice that will handle utterances in any language,

+leave out the <code>lang</code> parameter from your extension's manifest.

+Finally, the <code>event_types</code> parameter is required if the engine can

+send events to update the client on the progress of speech synthesis.

+At a minimum, supporting the <code>'end'</code> event type to indicate

+when speech is finished is highly recommend, otherwise it's impossible

kathyw 2011/07/13 20:39:58 recommend, otherwise -> recommended; otherwise it

dmazzoni 2011/07/14 06:50:55 Done.

+for Chrome to schedule queued utterances.</p>

+<p class="note">If your TTS engine does not support the <code>'end'</code>

kathyw 2011/07/13 20:39:58 <p...>If -> <p...> <strong>Note:</strong> If

dmazzoni 2011/07/14 06:50:55 Done.

+event type, Chrome will pass the <code>enqueue</code> option to

kathyw 2011/07/13 20:39:58 will pass -> passes I don't understand how it can

dmazzoni 2011/07/14 06:50:55 I tried to reword it, is it more clear now?

kathyw 2011/07/14 16:13:23 Yes, looks good.

+onSpeak, so that your engine can implement its own queuing. However, this is

kathyw 2011/07/13 20:39:58 queuing -> queueing (both are correct, but the la

+discouraged because it means that users cannot queue utterances that get

kathyw 2011/07/13 20:39:58 users -> extensions? or maybe -> users of your sp

dmazzoni 2011/07/14 06:50:55 Done.

+sent to different speech engines.</p>

+<p>The possible event types you can send correspond to the event types that

kathyw 2011/07/13 20:39:58 you -> that you (missing 'that' tends to trip up

dmazzoni 2011/07/14 06:50:55 Done.

+the <code>speak()</code> method receives:</p>

+<ul>

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

kathyw 2011/07/13 20:39:58 the -> The [and do the same capitalization for ev

dmazzoni 2011/07/14 06:50:55 Done.

+ </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>'error'</code>: An engine-specific error occurred and

+ this utterance cannot be spoken.

+ Pass more information in <code>event.errorMessage</code>.

+</li></ul>

+<p>The <code>'interrupted'</code> and <code>'cancelled'</code> events are

+not sent by the speech engine; they are generated automatically by Chrome.</p>

+<p>The information about your extensions's voices from your manifest

kathyw 2011/07/13 20:39:58 Turn this around to not have so much passive voice

dmazzoni 2011/07/14 06:50:55 Done.

+will be returned to any client that calls <code>getVoices</code>, assuming

+you've also registered speech event listeners as described below.</p>

+<h2 id="handling_speech_events">Handling Speech Events</h2>

kathyw 2011/07/13 20:39:58 Speech Events -> speech events

dmazzoni 2011/07/14 06:50:55 Done.

+<p>To generate speech at the request of clients, your extension must

+register listeners for both <code>onSpeak</code> and <code>onStop</code>,

+like this:</p>

+<pre>var speakListener = function(utterance, options, sendTtsEvent) {

+ sendTtsEvent({'event_type': 'start', 'charIndex': 0})

+ // (start speaking)

+ sendTtsEvent({'event_type': 'end', 'charIndex': utterance.length})

+};

+var stopListener = function() {

+ // (stop all speech)

+};

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

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

+<p class="warning">If an extension does not register listeners for both

kathyw 2011/07/13 20:39:58 <p ...> -> <p ...><b>Important:</b> an extension

dmazzoni 2011/07/14 06:50:55 :)

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

+speech calls, regardless of what is in the manifest.</p>

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

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

+parameters in its manifest and has registered listeners

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

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

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

kathyw 2011/07/13 20:39:58 delete "or not". Or change "whether" to "whether o

dmazzoni 2011/07/14 06:50:55 Done.

+</div>

+

+ <div class="apiPage">

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

+ <h2>API reference: chrome.experimental.tts_engine</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" style="display: none; ">

+ <a></a>

+ <h4>method name</h4>

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

+

+ <span>chrome.module.methodName</span>(<span><span>, </span><span></span>

+ <var><span></span></var></span>)</div>

+ <div class="description">

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

+ <p>

+ A description from the json schema def of the function goes here.

+ </p>

+

+ <h4>Parameters</h4>

+ <dl>

+ <div>

+ </div>

+ </dl>

+

+ <h4>Returns</h4>

+ <dl>

+ <div>

+ </div>

+ </dl>

+

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

+ 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">

+ <a name="global-events"></a>

+ <h3>Events</h3>

+

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

+ <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 class="apiItem">

+ <a name="event-onSpeak"></a>

+ <h4>onSpeak</h4>

+ <div class="summary">

+

+ <span class="subdued">chrome.experimental.tts_engine.</span><span>onSpeak</span><span class="subdued">.addListener</span>(function(<span>string utterance, object options, function sendTtsEvent, number id</span>) <span class="subdued">{...}</span><span></span>));

+ </div>

+ <div class="description">

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

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

kathyw 2011/07/13 20:39:58 tts.speak -> tts.speak() options matches -> optio

dmazzoni 2011/07/14 06:50:55 Thanks, I reworded it to say this will be called i

+

+ <div>

+ <h4>Listener 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. This may include SSML, so if your engine does not support SSML, you should strip out all XML markup and synthesize only the underlying text content. This is guaranteed to be no more than 32,768 characters. If this engine does not support speaking that many characters at a time, the utterance should be split into smaller chunks and queued internally without returning an error.</dd>

kathyw 2011/07/13 20:39:58 speak. -> speak, specified as either plain text or

dmazzoni 2011/07/14 06:50:55 Done.

+ <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" 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>The speak options.</dd>

kathyw 2011/07/13 20:39:58 The speak options -> Options specified to the tts.

dmazzoni 2011/07/14 06:50:55 Done.

+ <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 to use for 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>

+ </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 <language>-<region>, e.g. en-US, en-GB, fr-CA, zh-CN, etc.</region></language></dd>

kathyw 2011/07/13 20:39:58 Ha, all that shows is -! Please change to <em>lan

dmazzoni 2011/07/14 06:50:55 Done.

+ <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 would be twice as fast, and 0.5 would be half as fast. This value is guaranteed to be between 0.1 and 10.0, inclusive. When a voice does not support this full range of rates, the actual rate should be clipped to the range that is supported without returning an error.</dd>

kathyw 2011/07/13 20:39:58 See comments for tts. Also, change the last sente

dmazzoni 2011/07/14 06:50:55 Done.

+ <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 1 being highest, with 1.0 being the default pitch of this particular voice.</dd>

kathyw 2011/07/13 20:39:58 See comments for tts

dmazzoni 2011/07/14 06:50:55 Done.

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

+ </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>sendTtsEvent</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>function</span>

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

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

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

+ Undocumented.

+ </dd>

+ <dd>Call this function 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 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>

+ </div><div>

+ <div>

+ <dt>

+ <var>id</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 utterance id, used internally.</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>

+

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

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

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </div>

+

+ <h4 style="display: none; ">Listener returns</h4>

+ <dl>

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

+ <div>

+ </div>

+ </dl>

+ </div>

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

+ <a name="event-onStop"></a>

+ <h4>onStop</h4>

+ <div class="summary">

+

+ <span class="subdued">chrome.experimental.tts_engine.</span><span>onStop</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>));

+ </div>

+ <div class="description">

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

+ <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 speech is already stopped, it should do nothing (not raise an error).</p>

+

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

+ <h4>Listener parameters</h4>

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </div>

+

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

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

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </div>

+

+ <h4 style="display: none; ">Listener returns</h4>

+ <dl>

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

+ <div>

+ </div>

+ </dl>

+ </div>

+ </div>

+ </div>

+

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

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

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

+

+ <div class="apiItem">

+ <a></a>

+ <h4>type name</h4>

+ <div>

+ </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>

Property changes on: chrome/common/extensions/docs/experimental.tts_engine.html

___________________________________________________________________

Added: svn:eol-style

+ LF