chrome/common/extensions/docs/ttsEngine.html - Issue 10642015: Basic setup for generating app docs

Unified Diff: chrome/common/extensions/docs/ttsEngine.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 8 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

Index: chrome/common/extensions/docs/ttsEngine.html

diff --git a/chrome/common/extensions/docs/ttsEngine.html b/chrome/common/extensions/docs/ttsEngine.html

deleted file mode 100644

index dc81ae5ebb19e0d49a2c3f9ddf0b06efc3235455..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/ttsEngine.html

+++ /dev/null

@@ -1,698 +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="../../../../third_party/json_minify/minify-sans-regexp.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>

- <meta name="description" content="Documentation for the chrome.ttsEngine module, which is part of the Google Chrome extension APIs."><title>chrome.ttsEngine - Google Chrome Extensions - Google Code</title></head>

- <body> <div id="devModeWarning" class="displayModeWarning">

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

- <div id="branchWarning" class="displayModeWarning">

- <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

- It may not work with the stable release of Chrome.</span>

- <select id="branchChooser">

- <option>Choose a different version...

- </option><option value="">Stable

- </option><option value="beta">Beta

- </option><option value="dev">Dev

- </option><option value="trunk">Trunk

- </option></select>

- </div>

- <div id="unofficialWarning" class="displayModeWarning">

- <span>WARNING: This is unofficial documentation. It may not work with the

- current release of Chrome.</span>

- <button id="goToOfficialDocs">Go to the official docs</button>

- </div>

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

-

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

-

- <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="https://www.google.com/jsapi"></script>

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

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

- <script type="text/javascript" src="https://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>

- <li id="so_link">

- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</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="devtools.html">Developer Tools</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="i18n.html">Internationalization</a></li>

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

- <li><a href="permissions.html">Optional Permissions</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.ttsEngine</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

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

- <ol>

- </ol>

- </li><li>

- <a href="#manifest">Manifest</a>

- <ol>

- </ol>

- </li><li>

- <a href="#handling_speech_events">Handling speech events</a>

- <ol>

- </ol>

- </li>

- <li>

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

- <ol>

- <li>

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

- <ol>

- <li>

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

- </li><li>

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

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

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

-Use the <code>chrome.ttsEngine</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

-an utterance to be spoken and other parameters when any extension or packaged

-app uses the

-<a href="tts.html">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>

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

-<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="tts.html#method-speak"><code>speak()</code></a> and

-<a href="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

-declare the "ttsEngine" permission and then declare all voices

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

-<pre>{

- "name": "My TTS Engine",

- "version": "1.0",

- <b>"permissions": ["ttsEngine"],

- "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 specify the ID of the extension that

-should do the synthesis.</p>

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

-<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.</p>

-<p>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 recommended, otherwise Chrome cannot

-schedule queued utterances.</p>

-<p class="note">

-<strong>Note:</strong> If your TTS engine does not support

-the <code>'end'</code> event type, Chrome cannot queue utterances

-because it has no way of knowing when your utterance has finished. To

-help mitigate this, Chrome passes an additional boolean <code>enqueue</code>

-option to your engine's onSpeak handler, giving you the option of

-implementing your own queueing. This is discouraged because then

-clients are unable to queue utterances that should get spoken by different

-speech engines.</p>

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

-that the <code>speak()</code> method receives:</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>'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>Text-to-speech clients can get the voice information from your

-extension's manifest by calling

-<a href="tts.html#method-getVoices">getVoices()</a>,

-assuming you've registered speech event listeners as described below.</p>

-<h2 id="handling_speech_events">Handling speech events</h2>

-<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.ttsEngine.onSpeak.addListener(speakListener);

-chrome.ttsEngine.onStop.addListener(stopListener);</pre>

-<p class="warning">

-<b>Important:</b>

-If your extension does not register listeners for both

-<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.</p>

-</div>

-

- <div class="apiPage">

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

- <h2>API reference: chrome.ttsEngine</h2>

-

-

-

-

-

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

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

- <h3>Events</h3>

-

- <div class="apiItem">

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

- <h4>onSpeak</h4>

- <div class="summary">

-

- <span class="subdued">chrome.ttsEngine.</span><span>onSpeak</span><span class="subdued">.addListener</span>(function(<span>string utterance, object options, function sendTtsEvent</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Called when the user makes a call to tts.speak() and one of the voices from this extension's manifest is the first to match the options object.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>utterance</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The text to speak, specified as either plain text or an SSML document. If your engine does not support SSML, you should strip out all XML markup and synthesize only the underlying text content. The value of this parameter 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>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>options</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Options specified to the tts.speak() method.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>voiceName</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The name of the voice to use for synthesis.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>lang</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

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

-

-

-

-

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

- <span>string</span>

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

- </span>

- )

- </div>

- </em>

- </dt>

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

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>rate</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>number</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <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. This value is guaranteed to be between 0.1 and 10.0, inclusive. When a voice does not support this full range of rates, don't return an error. Instead, clip the rate to the range the voice supports.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>pitch</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>number</span>

- </span>

- )

- </div>

- </em>

- </dt>

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

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>volume</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>number</span>

- </span>

- )

- </div>

- </em>

- </dt>

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

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>sendTtsEvent</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Call this function with events that occur in the process of speaking the utterance.</dd>

-

-

-

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>event</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a>tts.TtsEvent</a>

- </span>

- )

- </div>

- </em>

- </dt>

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

-

-

-

-

- </div>

- </dl>

- </div>

- </dd>

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

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

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

- <h4>onStop</h4>

- <div class="summary">

-

- <span class="subdued">chrome.ttsEngine.</span><span>onStop</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

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

-

-

-

- <dl>

- </dl>

- </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="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>

-<script src="https://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/tts.html ('k') | chrome/common/extensions/docs/tut_analytics.html » ('j') | no next file with comments »