Index: chrome/common/extensions/docs/server2/templates/intros/tts.html |
diff --git a/chrome/common/extensions/docs/server2/templates/intros/tts.html b/chrome/common/extensions/docs/server2/templates/intros/tts.html |
index 12be2275cb65d9b1fc6589027c5b3f467b0d27ec..07fa3a07472521a520239e7d4b3db3a2b33630f2 100644 |
--- a/chrome/common/extensions/docs/server2/templates/intros/tts.html |
+++ b/chrome/common/extensions/docs/server2/templates/intros/tts.html |
@@ -5,65 +5,47 @@ See also the related |
<a href="ttsEngine.html">ttsEngine</a> |
module, which allows an extension to implement a speech engine. |
</p> |
- |
- |
<h2 id="overview">Overview</h2> |
- |
<p>You must declare the "tts" permission |
in your extension's manifest to use this API. |
</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.tts.speak('Hello, world.');</pre> |
- |
<p>To stop speaking immediately, just call <code>stop()</code>: |
- |
<pre>chrome.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.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.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.tts.speak( |
'Speak this first.'); |
chrome.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.tts.speak( |
utterance, |
options, |
@@ -72,19 +54,15 @@ to see if there were any errors.</p> |
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.tts.speak( |
utterance, |
{ |
@@ -96,11 +74,9 @@ pass an event listener in the options to <code>speak()</code>, like this:</p> |
} |
}, |
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><code>'word'</code>: A word boundary was reached. Use |
@@ -123,43 +99,34 @@ error message. The event types are:</p> |
this utterance cannot be spoken. |
Check <code>event.errorMessage</code> for details. |
</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.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 |
@@ -168,11 +135,9 @@ 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.tts.getVoices( |
function(voices) { |
for (var i = 0; i < voices.length; i++) { |
@@ -183,4 +148,4 @@ argument:</p> |
console.log(' extension id: ' + voices[i].extensionId); |
console.log(' event types: ' + voices[i].eventTypes); |
} |
- });</pre> |
+ });</pre> |