PageRenderTime 57ms CodeModel.GetById 14ms app.highlight 33ms RepoModel.GetById 1ms app.codeStats 0ms

/documentation/tts/com/google/tts/TextToSpeechBeta.html

http://eyes-free.googlecode.com/
HTML | 1064 lines | 936 code | 104 blank | 24 comment | 0 complexity | f10bb1cbe3998f9080b42b66a21bda5a MD5 | raw file
   1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2<!--NewPage-->
   3<HTML>
   4<HEAD>
   5<!-- Generated by javadoc (build 1.6.0_16) on Fri Oct 09 19:06:10 PDT 2009 -->
   6<TITLE>
   7TextToSpeechBeta
   8</TITLE>
   9
  10<META NAME="date" CONTENT="2009-10-09">
  11
  12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  13
  14<SCRIPT type="text/javascript">
  15function windowTitle()
  16{
  17    if (location.href.indexOf('is-external=true') == -1) {
  18        parent.document.title="TextToSpeechBeta";
  19    }
  20}
  21</SCRIPT>
  22<NOSCRIPT>
  23</NOSCRIPT>
  24
  25</HEAD>
  26
  27<BODY BGCOLOR="white" onload="windowTitle();">
  28<HR>
  29
  30
  31<!-- ========= START OF TOP NAVBAR ======= -->
  32<A NAME="navbar_top"><!-- --></A>
  33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  35<TR>
  36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  37<A NAME="navbar_top_firstrow"><!-- --></A>
  38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  39  <TR ALIGN="center" VALIGN="top">
  40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../com/google/tts/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  41  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  46  </TR>
  47</TABLE>
  48</TD>
  49<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  50</EM>
  51</TD>
  52</TR>
  53
  54<TR>
  55<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  56&nbsp;PREV CLASS&nbsp;
  57&nbsp;<A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html" title="class in com.google.tts"><B>NEXT CLASS</B></A></FONT></TD>
  58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  59  <A HREF="../../../index.html?com/google/tts/TextToSpeechBeta.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  60&nbsp;<A HREF="TextToSpeechBeta.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  61&nbsp;<SCRIPT type="text/javascript">
  62  <!--
  63  if(window==top) {
  64    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  65  }
  66  //-->
  67</SCRIPT>
  68<NOSCRIPT>
  69  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  70</NOSCRIPT>
  71
  72
  73</FONT></TD>
  74</TR>
  75<TR>
  76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  77  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  79DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  80</TR>
  81</TABLE>
  82<A NAME="skip-navbar_top"></A>
  83<!-- ========= END OF TOP NAVBAR ========= -->
  84
  85<HR>
  86<!-- ======== START OF CLASS DATA ======== -->
  87<H2>
  88<FONT SIZE="-1">
  89com.google.tts</FONT>
  90<BR>
  91Class TextToSpeechBeta</H2>
  92<PRE>
  93java.lang.Object
  94  <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">TextToSpeech
  95      <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.google.tts.TextToSpeechBeta</B>
  96</PRE>
  97<HR>
  98<DL>
  99<DT><PRE>public class <B>TextToSpeechBeta</B><DT>extends TextToSpeech</DL>
 100</PRE>
 101
 102<P>
 103Synthesizes speech from text for immediate playback or to create a sound
 104 file.
 105 <p>
 106 A TextToSpeech instance can only be used to synthesize text once it has
 107 completed its initialization. Implement the
 108 <A HREF="../../../com/google/tts/TextToSpeechBeta.OnInitListener.html" title="interface in com.google.tts"><CODE>TextToSpeechBeta.OnInitListener</CODE></A> to be notified of the completion of
 109 the initialization.<br>
 110 When you are done using the TextToSpeech instance, call the
 111 <A HREF="../../../com/google/tts/TextToSpeechBeta.html#shutdown()"><CODE>shutdown()</CODE></A> method to release the native resources used by the
 112 TextToSpeech engine.
 113<P>
 114
 115<P>
 116<HR>
 117
 118<P>
 119<!-- ======== NESTED CLASS SUMMARY ======== -->
 120
 121<A NAME="nested_class_summary"><!-- --></A>
 122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 124<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 125<B>Nested Class Summary</B></FONT></TH>
 126</TR>
 127<TR BGCOLOR="white" CLASS="TableRowColor">
 128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 129<CODE>&nbsp;class</CODE></FONT></TD>
 130<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html" title="class in com.google.tts">TextToSpeechBeta.Engine</A></B></CODE>
 131
 132<BR>
 133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Internal constants for the TextToSpeech functionality</TD>
 134</TR>
 135<TR BGCOLOR="white" CLASS="TableRowColor">
 136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 137<CODE>static&nbsp;interface</CODE></FONT></TD>
 138<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.OnInitListener.html" title="interface in com.google.tts">TextToSpeechBeta.OnInitListener</A></B></CODE>
 139
 140<BR>
 141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Interface definition of a callback to be invoked indicating the completion
 142 of the TextToSpeech engine initialization.</TD>
 143</TR>
 144<TR BGCOLOR="white" CLASS="TableRowColor">
 145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 146<CODE>static&nbsp;interface</CODE></FONT></TD>
 147<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.OnUtteranceCompletedListener.html" title="interface in com.google.tts">TextToSpeechBeta.OnUtteranceCompletedListener</A></B></CODE>
 148
 149<BR>
 150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Interface definition of a callback to be invoked indicating the
 151 TextToSpeech engine has completed synthesizing an utterance with an
 152 utterance ID set.</TD>
 153</TR>
 154</TABLE>
 155&nbsp;<!-- =========== FIELD SUMMARY =========== -->
 156
 157<A NAME="field_summary"><!-- --></A>
 158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 159<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 160<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 161<B>Field Summary</B></FONT></TH>
 162</TR>
 163<TR BGCOLOR="white" CLASS="TableRowColor">
 164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 165<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
 166<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#ACTION_TTS_QUEUE_PROCESSING_COMPLETED">ACTION_TTS_QUEUE_PROCESSING_COMPLETED</A></B></CODE>
 167
 168<BR>
 169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Broadcast Action: The TextToSpeech synthesizer has completed processing of
 170 all the text in the speech queue.</TD>
 171</TR>
 172<TR BGCOLOR="white" CLASS="TableRowColor">
 173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 174<CODE>static&nbsp;int</CODE></FONT></TD>
 175<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR">ERROR</A></B></CODE>
 176
 177<BR>
 178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes a generic operation failure.</TD>
 179</TR>
 180<TR BGCOLOR="white" CLASS="TableRowColor">
 181<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 182<CODE>static&nbsp;int</CODE></FONT></TD>
 183<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_AVAILABLE">LANG_AVAILABLE</A></B></CODE>
 184
 185<BR>
 186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes the language is available for the language by the locale, but not
 187 the country and variant.</TD>
 188</TR>
 189<TR BGCOLOR="white" CLASS="TableRowColor">
 190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 191<CODE>static&nbsp;int</CODE></FONT></TD>
 192<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_COUNTRY_AVAILABLE">LANG_COUNTRY_AVAILABLE</A></B></CODE>
 193
 194<BR>
 195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes the language is available for the language and country specified by
 196 the locale, but not the variant.</TD>
 197</TR>
 198<TR BGCOLOR="white" CLASS="TableRowColor">
 199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 200<CODE>static&nbsp;int</CODE></FONT></TD>
 201<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_COUNTRY_VAR_AVAILABLE">LANG_COUNTRY_VAR_AVAILABLE</A></B></CODE>
 202
 203<BR>
 204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes the language is available exactly as specified by the locale.</TD>
 205</TR>
 206<TR BGCOLOR="white" CLASS="TableRowColor">
 207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 208<CODE>static&nbsp;int</CODE></FONT></TD>
 209<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_MISSING_DATA">LANG_MISSING_DATA</A></B></CODE>
 210
 211<BR>
 212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes the language data is missing.</TD>
 213</TR>
 214<TR BGCOLOR="white" CLASS="TableRowColor">
 215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 216<CODE>static&nbsp;int</CODE></FONT></TD>
 217<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_NOT_SUPPORTED">LANG_NOT_SUPPORTED</A></B></CODE>
 218
 219<BR>
 220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes the language is not supported.</TD>
 221</TR>
 222<TR BGCOLOR="white" CLASS="TableRowColor">
 223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 224<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
 225<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#NOT_ON_PLATFORM_TTS">NOT_ON_PLATFORM_TTS</A></B></CODE>
 226
 227<BR>
 228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 229</TR>
 230<TR BGCOLOR="white" CLASS="TableRowColor">
 231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 232<CODE>static&nbsp;int</CODE></FONT></TD>
 233<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#QUEUE_ADD">QUEUE_ADD</A></B></CODE>
 234
 235<BR>
 236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Queue mode where the new entry is added at the end of the playback queue.</TD>
 237</TR>
 238<TR BGCOLOR="white" CLASS="TableRowColor">
 239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 240<CODE>static&nbsp;int</CODE></FONT></TD>
 241<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#QUEUE_FLUSH">QUEUE_FLUSH</A></B></CODE>
 242
 243<BR>
 244&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Queue mode where all entries in the playback queue (media to be played and
 245 text to be synthesized) are dropped and replaced by the new entry.</TD>
 246</TR>
 247<TR BGCOLOR="white" CLASS="TableRowColor">
 248<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 249<CODE>static&nbsp;int</CODE></FONT></TD>
 250<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS">SUCCESS</A></B></CODE>
 251
 252<BR>
 253&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes a successful operation.</TD>
 254</TR>
 255<TR BGCOLOR="white" CLASS="TableRowColor">
 256<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 257<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
 258<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#USING_PLATFORM_TTS">USING_PLATFORM_TTS</A></B></CODE>
 259
 260<BR>
 261&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 262</TR>
 263</TABLE>
 264&nbsp;
 265<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 266
 267<A NAME="constructor_summary"><!-- --></A>
 268<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 269<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 270<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 271<B>Constructor Summary</B></FONT></TH>
 272</TR>
 273<TR BGCOLOR="white" CLASS="TableRowColor">
 274<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#TextToSpeechBeta(Context, com.google.tts.TextToSpeechBeta.OnInitListener)">TextToSpeechBeta</A></B>(Context&nbsp;context,
 275                 <A HREF="../../../com/google/tts/TextToSpeechBeta.OnInitListener.html" title="interface in com.google.tts">TextToSpeechBeta.OnInitListener</A>&nbsp;listener)</CODE>
 276
 277<BR>
 278&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The constructor for the TextToSpeech class.</TD>
 279</TR>
 280</TABLE>
 281&nbsp;
 282<!-- ========== METHOD SUMMARY =========== -->
 283
 284<A NAME="method_summary"><!-- --></A>
 285<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 286<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 287<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 288<B>Method Summary</B></FONT></TH>
 289</TR>
 290<TR BGCOLOR="white" CLASS="TableRowColor">
 291<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 292<CODE>&nbsp;int</CODE></FONT></TD>
 293<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#addEarcon(java.lang.String, java.lang.String)">addEarcon</A></B>(java.lang.String&nbsp;earcon,
 294          java.lang.String&nbsp;filename)</CODE>
 295
 296<BR>
 297&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a mapping between a string of text and a sound file.</TD>
 298</TR>
 299<TR BGCOLOR="white" CLASS="TableRowColor">
 300<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 301<CODE>&nbsp;int</CODE></FONT></TD>
 302<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#addEarcon(java.lang.String, java.lang.String, int)">addEarcon</A></B>(java.lang.String&nbsp;earcon,
 303          java.lang.String&nbsp;packagename,
 304          int&nbsp;resourceId)</CODE>
 305
 306<BR>
 307&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a mapping between a string of text and a sound resource in a package.</TD>
 308</TR>
 309<TR BGCOLOR="white" CLASS="TableRowColor">
 310<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 311<CODE>&nbsp;int</CODE></FONT></TD>
 312<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#addSpeech(java.lang.String, java.lang.String)">addSpeech</A></B>(java.lang.String&nbsp;text,
 313          java.lang.String&nbsp;filename)</CODE>
 314
 315<BR>
 316&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a mapping between a string of text and a sound file.</TD>
 317</TR>
 318<TR BGCOLOR="white" CLASS="TableRowColor">
 319<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 320<CODE>&nbsp;int</CODE></FONT></TD>
 321<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#addSpeech(java.lang.String, java.lang.String, int)">addSpeech</A></B>(java.lang.String&nbsp;text,
 322          java.lang.String&nbsp;packagename,
 323          int&nbsp;resourceId)</CODE>
 324
 325<BR>
 326&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a mapping between a string of text and a sound resource in a package.</TD>
 327</TR>
 328<TR BGCOLOR="white" CLASS="TableRowColor">
 329<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 330<CODE>&nbsp;java.util.Locale</CODE></FONT></TD>
 331<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#getLanguage()">getLanguage</A></B>()</CODE>
 332
 333<BR>
 334&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a Locale instance describing the language currently being used by
 335 the TextToSpeech engine.</TD>
 336</TR>
 337<TR BGCOLOR="white" CLASS="TableRowColor">
 338<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 339<CODE>static&nbsp;boolean</CODE></FONT></TD>
 340<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#isInstalled(Context)">isInstalled</A></B>(Context&nbsp;ctx)</CODE>
 341
 342<BR>
 343&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Standalone TTS ONLY!
 344 
 345 Checks if the TTS service is installed or not</TD>
 346</TR>
 347<TR BGCOLOR="white" CLASS="TableRowColor">
 348<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 349<CODE>&nbsp;int</CODE></FONT></TD>
 350<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#isLanguageAvailable(java.util.Locale)">isLanguageAvailable</A></B>(java.util.Locale&nbsp;loc)</CODE>
 351
 352<BR>
 353&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks if the specified language as represented by the Locale is available
 354 and supported.</TD>
 355</TR>
 356<TR BGCOLOR="white" CLASS="TableRowColor">
 357<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 358<CODE>&nbsp;boolean</CODE></FONT></TD>
 359<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#isSpeaking()">isSpeaking</A></B>()</CODE>
 360
 361<BR>
 362&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether or not the TextToSpeech engine is busy speaking.</TD>
 363</TR>
 364<TR BGCOLOR="white" CLASS="TableRowColor">
 365<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 366<CODE>&nbsp;int</CODE></FONT></TD>
 367<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#playEarcon(java.lang.String, int, java.util.HashMap)">playEarcon</A></B>(java.lang.String&nbsp;earcon,
 368           int&nbsp;queueMode,
 369           java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params)</CODE>
 370
 371<BR>
 372&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Plays the earcon using the specified queueing mode and parameters.</TD>
 373</TR>
 374<TR BGCOLOR="white" CLASS="TableRowColor">
 375<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 376<CODE>&nbsp;int</CODE></FONT></TD>
 377<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#playSilence(long, int, java.util.HashMap)">playSilence</A></B>(long&nbsp;durationInMs,
 378            int&nbsp;queueMode,
 379            java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params)</CODE>
 380
 381<BR>
 382&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Plays silence for the specified amount of time using the specified queue
 383 mode.</TD>
 384</TR>
 385<TR BGCOLOR="white" CLASS="TableRowColor">
 386<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 387<CODE>&nbsp;int</CODE></FONT></TD>
 388<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#setLanguage(java.util.Locale)">setLanguage</A></B>(java.util.Locale&nbsp;loc)</CODE>
 389
 390<BR>
 391&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the language for the TextToSpeech engine.</TD>
 392</TR>
 393<TR BGCOLOR="white" CLASS="TableRowColor">
 394<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 395<CODE>&nbsp;int</CODE></FONT></TD>
 396<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#setOnUtteranceCompletedListener(com.google.tts.TextToSpeechBeta.OnUtteranceCompletedListener)">setOnUtteranceCompletedListener</A></B>(<A HREF="../../../com/google/tts/TextToSpeechBeta.OnUtteranceCompletedListener.html" title="interface in com.google.tts">TextToSpeechBeta.OnUtteranceCompletedListener</A>&nbsp;listener)</CODE>
 397
 398<BR>
 399&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the OnUtteranceCompletedListener that will fire when an utterance
 400 completes.</TD>
 401</TR>
 402<TR BGCOLOR="white" CLASS="TableRowColor">
 403<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 404<CODE>&nbsp;int</CODE></FONT></TD>
 405<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#setPitch(float)">setPitch</A></B>(float&nbsp;pitch)</CODE>
 406
 407<BR>
 408&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the speech pitch for the TextToSpeech engine.</TD>
 409</TR>
 410<TR BGCOLOR="white" CLASS="TableRowColor">
 411<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 412<CODE>&nbsp;int</CODE></FONT></TD>
 413<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#setSpeechRate(float)">setSpeechRate</A></B>(float&nbsp;speechRate)</CODE>
 414
 415<BR>
 416&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the speech rate for the TextToSpeech engine.</TD>
 417</TR>
 418<TR BGCOLOR="white" CLASS="TableRowColor">
 419<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 420<CODE>&nbsp;void</CODE></FONT></TD>
 421<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#shutdown()">shutdown</A></B>()</CODE>
 422
 423<BR>
 424&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Releases the resources used by the TextToSpeech engine.</TD>
 425</TR>
 426<TR BGCOLOR="white" CLASS="TableRowColor">
 427<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 428<CODE>&nbsp;int</CODE></FONT></TD>
 429<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#speak(java.lang.String, int, java.util.HashMap)">speak</A></B>(java.lang.String&nbsp;text,
 430      int&nbsp;queueMode,
 431      java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params)</CODE>
 432
 433<BR>
 434&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Speaks the string using the specified queuing strategy and speech
 435 parameters.</TD>
 436</TR>
 437<TR BGCOLOR="white" CLASS="TableRowColor">
 438<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 439<CODE>&nbsp;int</CODE></FONT></TD>
 440<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#stop()">stop</A></B>()</CODE>
 441
 442<BR>
 443&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Interrupts the current utterance (whether played or rendered to file) and
 444 discards other utterances in the queue.</TD>
 445</TR>
 446<TR BGCOLOR="white" CLASS="TableRowColor">
 447<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 448<CODE>&nbsp;int</CODE></FONT></TD>
 449<TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#synthesizeToFile(java.lang.String, java.util.HashMap, java.lang.String)">synthesizeToFile</A></B>(java.lang.String&nbsp;text,
 450                 java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params,
 451                 java.lang.String&nbsp;filename)</CODE>
 452
 453<BR>
 454&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Synthesizes the given text to a file using the specified parameters.</TD>
 455</TR>
 456</TABLE>
 457&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 458<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 459<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 460<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
 461</TR>
 462<TR BGCOLOR="white" CLASS="TableRowColor">
 463<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 464</TR>
 465</TABLE>
 466&nbsp;
 467<P>
 468
 469<!-- ============ FIELD DETAIL =========== -->
 470
 471<A NAME="field_detail"><!-- --></A>
 472<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 473<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 474<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 475<B>Field Detail</B></FONT></TH>
 476</TR>
 477</TABLE>
 478
 479<A NAME="USING_PLATFORM_TTS"><!-- --></A><H3>
 480USING_PLATFORM_TTS</H3>
 481<PRE>
 482public static final java.lang.String <B>USING_PLATFORM_TTS</B></PRE>
 483<DL>
 484<DL>
 485<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.USING_PLATFORM_TTS">Constant Field Values</A></DL>
 486</DL>
 487<HR>
 488
 489<A NAME="NOT_ON_PLATFORM_TTS"><!-- --></A><H3>
 490NOT_ON_PLATFORM_TTS</H3>
 491<PRE>
 492public static final java.lang.String <B>NOT_ON_PLATFORM_TTS</B></PRE>
 493<DL>
 494<DL>
 495<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.NOT_ON_PLATFORM_TTS">Constant Field Values</A></DL>
 496</DL>
 497<HR>
 498
 499<A NAME="SUCCESS"><!-- --></A><H3>
 500SUCCESS</H3>
 501<PRE>
 502public static final int <B>SUCCESS</B></PRE>
 503<DL>
 504<DD>Denotes a successful operation.
 505<P>
 506<DL>
 507<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.SUCCESS">Constant Field Values</A></DL>
 508</DL>
 509<HR>
 510
 511<A NAME="ERROR"><!-- --></A><H3>
 512ERROR</H3>
 513<PRE>
 514public static final int <B>ERROR</B></PRE>
 515<DL>
 516<DD>Denotes a generic operation failure.
 517<P>
 518<DL>
 519<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.ERROR">Constant Field Values</A></DL>
 520</DL>
 521<HR>
 522
 523<A NAME="QUEUE_FLUSH"><!-- --></A><H3>
 524QUEUE_FLUSH</H3>
 525<PRE>
 526public static final int <B>QUEUE_FLUSH</B></PRE>
 527<DL>
 528<DD>Queue mode where all entries in the playback queue (media to be played and
 529 text to be synthesized) are dropped and replaced by the new entry.
 530<P>
 531<DL>
 532<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.QUEUE_FLUSH">Constant Field Values</A></DL>
 533</DL>
 534<HR>
 535
 536<A NAME="QUEUE_ADD"><!-- --></A><H3>
 537QUEUE_ADD</H3>
 538<PRE>
 539public static final int <B>QUEUE_ADD</B></PRE>
 540<DL>
 541<DD>Queue mode where the new entry is added at the end of the playback queue.
 542<P>
 543<DL>
 544<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.QUEUE_ADD">Constant Field Values</A></DL>
 545</DL>
 546<HR>
 547
 548<A NAME="LANG_COUNTRY_VAR_AVAILABLE"><!-- --></A><H3>
 549LANG_COUNTRY_VAR_AVAILABLE</H3>
 550<PRE>
 551public static final int <B>LANG_COUNTRY_VAR_AVAILABLE</B></PRE>
 552<DL>
 553<DD>Denotes the language is available exactly as specified by the locale.
 554<P>
 555<DL>
 556<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.LANG_COUNTRY_VAR_AVAILABLE">Constant Field Values</A></DL>
 557</DL>
 558<HR>
 559
 560<A NAME="LANG_COUNTRY_AVAILABLE"><!-- --></A><H3>
 561LANG_COUNTRY_AVAILABLE</H3>
 562<PRE>
 563public static final int <B>LANG_COUNTRY_AVAILABLE</B></PRE>
 564<DL>
 565<DD>Denotes the language is available for the language and country specified by
 566 the locale, but not the variant.
 567<P>
 568<DL>
 569<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.LANG_COUNTRY_AVAILABLE">Constant Field Values</A></DL>
 570</DL>
 571<HR>
 572
 573<A NAME="LANG_AVAILABLE"><!-- --></A><H3>
 574LANG_AVAILABLE</H3>
 575<PRE>
 576public static final int <B>LANG_AVAILABLE</B></PRE>
 577<DL>
 578<DD>Denotes the language is available for the language by the locale, but not
 579 the country and variant.
 580<P>
 581<DL>
 582<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.LANG_AVAILABLE">Constant Field Values</A></DL>
 583</DL>
 584<HR>
 585
 586<A NAME="LANG_MISSING_DATA"><!-- --></A><H3>
 587LANG_MISSING_DATA</H3>
 588<PRE>
 589public static final int <B>LANG_MISSING_DATA</B></PRE>
 590<DL>
 591<DD>Denotes the language data is missing.
 592<P>
 593<DL>
 594<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.LANG_MISSING_DATA">Constant Field Values</A></DL>
 595</DL>
 596<HR>
 597
 598<A NAME="LANG_NOT_SUPPORTED"><!-- --></A><H3>
 599LANG_NOT_SUPPORTED</H3>
 600<PRE>
 601public static final int <B>LANG_NOT_SUPPORTED</B></PRE>
 602<DL>
 603<DD>Denotes the language is not supported.
 604<P>
 605<DL>
 606<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.LANG_NOT_SUPPORTED">Constant Field Values</A></DL>
 607</DL>
 608<HR>
 609
 610<A NAME="ACTION_TTS_QUEUE_PROCESSING_COMPLETED"><!-- --></A><H3>
 611ACTION_TTS_QUEUE_PROCESSING_COMPLETED</H3>
 612<PRE>
 613public static final java.lang.String <B>ACTION_TTS_QUEUE_PROCESSING_COMPLETED</B></PRE>
 614<DL>
 615<DD>Broadcast Action: The TextToSpeech synthesizer has completed processing of
 616 all the text in the speech queue.
 617<P>
 618<DL>
 619<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.ACTION_TTS_QUEUE_PROCESSING_COMPLETED">Constant Field Values</A></DL>
 620</DL>
 621
 622<!-- ========= CONSTRUCTOR DETAIL ======== -->
 623
 624<A NAME="constructor_detail"><!-- --></A>
 625<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 626<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 627<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 628<B>Constructor Detail</B></FONT></TH>
 629</TR>
 630</TABLE>
 631
 632<A NAME="TextToSpeechBeta(Context, com.google.tts.TextToSpeechBeta.OnInitListener)"><!-- --></A><H3>
 633TextToSpeechBeta</H3>
 634<PRE>
 635public <B>TextToSpeechBeta</B>(Context&nbsp;context,
 636                        <A HREF="../../../com/google/tts/TextToSpeechBeta.OnInitListener.html" title="interface in com.google.tts">TextToSpeechBeta.OnInitListener</A>&nbsp;listener)</PRE>
 637<DL>
 638<DD>The constructor for the TextToSpeech class. This will also initialize the
 639 associated TextToSpeech engine if it isn't already running.
 640<P>
 641<DL>
 642<DT><B>Parameters:</B><DD><CODE>context</CODE> - The context this instance is running in.<DD><CODE>listener</CODE> - The <A HREF="../../../com/google/tts/TextToSpeechBeta.OnInitListener.html" title="interface in com.google.tts"><CODE>TextToSpeechBeta.OnInitListener</CODE></A> that will be
 643        called when the TextToSpeech engine has initialized.</DL>
 644</DL>
 645
 646<!-- ============ METHOD DETAIL ========== -->
 647
 648<A NAME="method_detail"><!-- --></A>
 649<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 650<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 651<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 652<B>Method Detail</B></FONT></TH>
 653</TR>
 654</TABLE>
 655
 656<A NAME="shutdown()"><!-- --></A><H3>
 657shutdown</H3>
 658<PRE>
 659public void <B>shutdown</B>()</PRE>
 660<DL>
 661<DD>Releases the resources used by the TextToSpeech engine. It is good practice
 662 for instance to call this method in the onDestroy() method of an Activity
 663 so the TextToSpeech engine can be cleanly stopped.
 664<P>
 665<DD><DL>
 666</DL>
 667</DD>
 668</DL>
 669<HR>
 670
 671<A NAME="addSpeech(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
 672addSpeech</H3>
 673<PRE>
 674public int <B>addSpeech</B>(java.lang.String&nbsp;text,
 675                     java.lang.String&nbsp;packagename,
 676                     int&nbsp;resourceId)</PRE>
 677<DL>
 678<DD>Adds a mapping between a string of text and a sound resource in a package.
 679 After a call to this method, subsequent calls to
 680 <A HREF="../../../com/google/tts/TextToSpeechBeta.html#speak(java.lang.String, int, java.util.HashMap)"><CODE>speak(String, int, HashMap)</CODE></A> will play the specified sound resource
 681 if it is available, or synthesize the text it is missing.
 682<P>
 683<DD><DL>
 684<DT><B>Parameters:</B><DD><CODE>text</CODE> - The string of text. Example: <code>"south_south_east"</code><DD><CODE>packagename</CODE> - Pass the packagename of the application that contains
 685        the resource. If the resource is in your own application (this is
 686        the most common case), then put the packagename of your application
 687        here.<br/>
 688        Example: <b>"com.google.marvin.compass"</b><br/>
 689        The packagename can be found in the AndroidManifest.xml of your
 690        application.
 691        <p>
 692        <code>&lt;manifest xmlns:android=&quot;...&quot;
 693      package=&quot;<b>com.google.marvin.compass</b>&quot;&gt;</code>
 694        </p><DD><CODE>resourceId</CODE> - Example: <code>R.raw.south_south_east</code>
 695<DT><B>Returns:</B><DD>Code indicating success or failure. See <A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR"><CODE>ERROR</CODE></A> and
 696         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>
 697</DD>
 698</DL>
 699<HR>
 700
 701<A NAME="addSpeech(java.lang.String, java.lang.String)"><!-- --></A><H3>
 702addSpeech</H3>
 703<PRE>
 704public int <B>addSpeech</B>(java.lang.String&nbsp;text,
 705                     java.lang.String&nbsp;filename)</PRE>
 706<DL>
 707<DD>Adds a mapping between a string of text and a sound file. Using this, it is
 708 possible to add custom pronounciations for a string of text. After a call
 709 to this method, subsequent calls to <A HREF="../../../com/google/tts/TextToSpeechBeta.html#speak(java.lang.String, int, java.util.HashMap)"><CODE>speak(String, int, HashMap)</CODE></A>
 710 will play the specified sound resource if it is available, or synthesize
 711 the text it is missing.
 712<P>
 713<DD><DL>
 714<DT><B>Parameters:</B><DD><CODE>text</CODE> - The string of text. Example: <code>"south_south_east"</code><DD><CODE>filename</CODE> - The full path to the sound file (for example:
 715        "/sdcard/mysounds/hello.wav")
 716<DT><B>Returns:</B><DD>Code indicating success or failure. See <A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR"><CODE>ERROR</CODE></A> and
 717         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>
 718</DD>
 719</DL>
 720<HR>
 721
 722<A NAME="addEarcon(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
 723addEarcon</H3>
 724<PRE>
 725public int <B>addEarcon</B>(java.lang.String&nbsp;earcon,
 726                     java.lang.String&nbsp;packagename,
 727                     int&nbsp;resourceId)</PRE>
 728<DL>
 729<DD>Adds a mapping between a string of text and a sound resource in a package.
 730 Use this to add custom earcons.
 731<P>
 732<DD><DL>
 733<DT><B>Parameters:</B><DD><CODE>earcon</CODE> - The name of the earcon. Example: <code>"[tick]"</code><br/><DD><CODE>packagename</CODE> - the package name of the application that contains the
 734        resource. This can for instance be the package name of your own
 735        application. Example: <b>"com.google.marvin.compass"</b><br/>
 736        The package name can be found in the AndroidManifest.xml of the
 737        application containing the resource.
 738        <p>
 739        <code>&lt;manifest xmlns:android=&quot;...&quot;
 740      package=&quot;<b>com.google.marvin.compass</b>&quot;&gt;</code>
 741        </p><DD><CODE>resourceId</CODE> - Example: <code>R.raw.tick_snd</code>
 742<DT><B>Returns:</B><DD>Code indicating success or failure. See <A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR"><CODE>ERROR</CODE></A> and
 743         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.<DT><B>See Also:</B><DD><A HREF="../../../com/google/tts/TextToSpeechBeta.html#playEarcon(java.lang.String, int, java.util.HashMap)"><CODE>playEarcon(String, int, HashMap)</CODE></A></DL>
 744</DD>
 745</DL>
 746<HR>
 747
 748<A NAME="addEarcon(java.lang.String, java.lang.String)"><!-- --></A><H3>
 749addEarcon</H3>
 750<PRE>
 751public int <B>addEarcon</B>(java.lang.String&nbsp;earcon,
 752                     java.lang.String&nbsp;filename)</PRE>
 753<DL>
 754<DD>Adds a mapping between a string of text and a sound file. Use this to add
 755 custom earcons.
 756<P>
 757<DD><DL>
 758<DT><B>Parameters:</B><DD><CODE>earcon</CODE> - The name of the earcon. Example: <code>"[tick]"</code><DD><CODE>filename</CODE> - The full path to the sound file (for example:
 759        "/sdcard/mysounds/tick.wav")
 760<DT><B>Returns:</B><DD>Code indicating success or failure. See <A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR"><CODE>ERROR</CODE></A> and
 761         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.<DT><B>See Also:</B><DD><A HREF="../../../com/google/tts/TextToSpeechBeta.html#playEarcon(java.lang.String, int, java.util.HashMap)"><CODE>playEarcon(String, int, HashMap)</CODE></A></DL>
 762</DD>
 763</DL>
 764<HR>
 765
 766<A NAME="speak(java.lang.String, int, java.util.HashMap)"><!-- --></A><H3>
 767speak</H3>
 768<PRE>
 769public int <B>speak</B>(java.lang.String&nbsp;text,
 770                 int&nbsp;queueMode,
 771                 java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params)</PRE>
 772<DL>
 773<DD>Speaks the string using the specified queuing strategy and speech
 774 parameters.
 775<P>
 776<DD><DL>
 777<DT><B>Parameters:</B><DD><CODE>text</CODE> - The string of text to be spoken.<DD><CODE>queueMode</CODE> - The queuing strategy to use. <A HREF="../../../com/google/tts/TextToSpeechBeta.html#QUEUE_ADD"><CODE>QUEUE_ADD</CODE></A> or
 778        <A HREF="../../../com/google/tts/TextToSpeechBeta.html#QUEUE_FLUSH"><CODE>QUEUE_FLUSH</CODE></A>.<DD><CODE>params</CODE> - The list of parameters to be used. Can be null if no
 779        parameters are given. They are specified using a (key, value) pair,
 780        where the key can be <A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html#KEY_PARAM_STREAM"><CODE>TextToSpeechBeta.Engine.KEY_PARAM_STREAM</CODE></A> or
 781        <A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html#KEY_PARAM_UTTERANCE_ID"><CODE>TextToSpeechBeta.Engine.KEY_PARAM_UTTERANCE_ID</CODE></A>.
 782<DT><B>Returns:</B><DD>Code indicating success or failure. See <A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR"><CODE>ERROR</CODE></A> and
 783         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>
 784</DD>
 785</DL>
 786<HR>
 787
 788<A NAME="playEarcon(java.lang.String, int, java.util.HashMap)"><!-- --></A><H3>
 789playEarcon</H3>
 790<PRE>
 791public int <B>playEarcon</B>(java.lang.String&nbsp;earcon,
 792                      int&nbsp;queueMode,
 793                      java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params)</PRE>
 794<DL>
 795<DD>Plays the earcon using the specified queueing mode and parameters.
 796<P>
 797<DD><DL>
 798<DT><B>Parameters:</B><DD><CODE>earcon</CODE> - The earcon that should be played<DD><CODE>queueMode</CODE> - <A HREF="../../../com/google/tts/TextToSpeechBeta.html#QUEUE_ADD"><CODE>QUEUE_ADD</CODE></A> or <A HREF="../../../com/google/tts/TextToSpeechBeta.html#QUEUE_FLUSH"><CODE>QUEUE_FLUSH</CODE></A>.<DD><CODE>params</CODE> - The list of parameters to be used. Can be null if no
 799        parameters are given. They are specified using a (key, value) pair,
 800        where the key can be <A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html#KEY_PARAM_STREAM"><CODE>TextToSpeechBeta.Engine.KEY_PARAM_STREAM</CODE></A> or
 801        <A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html#KEY_PARAM_UTTERANCE_ID"><CODE>TextToSpeechBeta.Engine.KEY_PARAM_UTTERANCE_ID</CODE></A>.
 802<DT><B>Returns:</B><DD>Code indicating success or failure. See <A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR"><CODE>ERROR</CODE></A> and
 803         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>
 804</DD>
 805</DL>
 806<HR>
 807
 808<A NAME="playSilence(long, int, java.util.HashMap)"><!-- --></A><H3>
 809playSilence</H3>
 810<PRE>
 811public int <B>playSilence</B>(long&nbsp;durationInMs,
 812                       int&nbsp;queueMode,
 813                       java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params)</PRE>
 814<DL>
 815<DD>Plays silence for the specified amount of time using the specified queue
 816 mode.
 817<P>
 818<DD><DL>
 819<DT><B>Parameters:</B><DD><CODE>durationInMs</CODE> - A long that indicates how long the silence should last.<DD><CODE>queueMode</CODE> - <A HREF="../../../com/google/tts/TextToSpeechBeta.html#QUEUE_ADD"><CODE>QUEUE_ADD</CODE></A> or <A HREF="../../../com/google/tts/TextToSpeechBeta.html#QUEUE_FLUSH"><CODE>QUEUE_FLUSH</CODE></A>.<DD><CODE>params</CODE> - The list of parameters to be used. Can be null if no
 820        parameters are given. They are specified using a (key, value) pair,
 821        where the key can be <A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html#KEY_PARAM_UTTERANCE_ID"><CODE>TextToSpeechBeta.Engine.KEY_PARAM_UTTERANCE_ID</CODE></A>.
 822<DT><B>Returns:</B><DD>Code indicating success or failure. See <A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR"><CODE>ERROR</CODE></A> and
 823         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>
 824</DD>
 825</DL>
 826<HR>
 827
 828<A NAME="isSpeaking()"><!-- --></A><H3>
 829isSpeaking</H3>
 830<PRE>
 831public boolean <B>isSpeaking</B>()</PRE>
 832<DL>
 833<DD>Returns whether or not the TextToSpeech engine is busy speaking.
 834<P>
 835<DD><DL>
 836
 837<DT><B>Returns:</B><DD>Whether or not the TextToSpeech engine is busy speaking.</DL>
 838</DD>
 839</DL>
 840<HR>
 841
 842<A NAME="stop()"><!-- --></A><H3>
 843stop</H3>
 844<PRE>
 845public int <B>stop</B>()</PRE>
 846<DL>
 847<DD>Interrupts the current utterance (whether played or rendered to file) and
 848 discards other utterances in the queue.
 849<P>
 850<DD><DL>
 851
 852<DT><B>Returns:</B><DD>Code indicating success or failure. See <A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR"><CODE>ERROR</CODE></A> and
 853         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>
 854</DD>
 855</DL>
 856<HR>
 857
 858<A NAME="setSpeechRate(float)"><!-- --></A><H3>
 859setSpeechRate</H3>
 860<PRE>
 861public int <B>setSpeechRate</B>(float&nbsp;speechRate)</PRE>
 862<DL>
 863<DD>Sets the speech rate for the TextToSpeech engine.
 864 
 865 This has no effect on any pre-recorded speech.
 866<P>
 867<DD><DL>
 868<DT><B>Parameters:</B><DD><CODE>speechRate</CODE> - The speech rate for the TextToSpeech engine. 1 is the
 869        normal speed, lower values slow down the speech (0.5 is half the
 870        normal speech rate), greater values accelerate it (2 is twice the
 871        normal speech rate).
 872<DT><B>Returns:</B><DD>Code indicating success or failure. See <A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR"><CODE>ERROR</CODE></A> and
 873         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>
 874</DD>
 875</DL>
 876<HR>
 877
 878<A NAME="setPitch(float)"><!-- --></A><H3>
 879setPitch</H3>
 880<PRE>
 881public int <B>setPitch</B>(float&nbsp;pitch)</PRE>
 882<DL>
 883<DD>Sets the speech pitch for the TextToSpeech engine.
 884 
 885 This has no effect on any pre-recorded speech.
 886<P>
 887<DD><DL>
 888<DT><B>Parameters:</B><DD><CODE>pitch</CODE> - The pitch for the TextToSpeech engine. 1 is the normal pitch,
 889        lower values lower the tone of the synthesized voice, greater values
 890        increase it.
 891<DT><B>Returns:</B><DD>Code indicating success or failure. See <A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR"><CODE>ERROR</CODE></A> and
 892         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>
 893</DD>
 894</DL>
 895<HR>
 896
 897<A NAME="setLanguage(java.util.Locale)"><!-- --></A><H3>
 898setLanguage</H3>
 899<PRE>
 900public int <B>setLanguage</B>(java.util.Locale&nbsp;loc)</PRE>
 901<DL>
 902<DD>Sets the language for the TextToSpeech engine. The TextToSpeech engine will
 903 try to use the closest match to the specified language as represented by
 904 the Locale, but there is no guarantee that the exact same Locale will be
 905 used. Use <A HREF="../../../com/google/tts/TextToSpeechBeta.html#isLanguageAvailable(java.util.Locale)"><CODE>isLanguageAvailable(Locale)</CODE></A> to check the level of
 906 support before choosing the language to use for the next utterances.
 907<P>
 908<DD><DL>
 909<DT><B>Parameters:</B><DD><CODE>loc</CODE> - The locale describing the language to be used.
 910<DT><B>Returns:</B><DD>code indicating the support status for the locale. See
 911         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_AVAILABLE"><CODE>LANG_AVAILABLE</CODE></A>, <A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_COUNTRY_AVAILABLE"><CODE>LANG_COUNTRY_AVAILABLE</CODE></A>,
 912         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_COUNTRY_VAR_AVAILABLE"><CODE>LANG_COUNTRY_VAR_AVAILABLE</CODE></A>, <A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_MISSING_DATA"><CODE>LANG_MISSING_DATA</CODE></A> and
 913         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_NOT_SUPPORTED"><CODE>LANG_NOT_SUPPORTED</CODE></A>.</DL>
 914</DD>
 915</DL>
 916<HR>
 917
 918<A NAME="getLanguage()"><!-- --></A><H3>
 919getLanguage</H3>
 920<PRE>
 921public java.util.Locale <B>getLanguage</B>()</PRE>
 922<DL>
 923<DD>Returns a Locale instance describing the language currently being used by
 924 the TextToSpeech engine.
 925<P>
 926<DD><DL>
 927
 928<DT><B>Returns:</B><DD>language, country (if any) and variant (if any) used by the engine
 929         stored in a Locale instance, or null is the TextToSpeech engine has
 930         failed.</DL>
 931</DD>
 932</DL>
 933<HR>
 934
 935<A NAME="isLanguageAvailable(java.util.Locale)"><!-- --></A><H3>
 936isLanguageAvailable</H3>
 937<PRE>
 938public int <B>isLanguageAvailable</B>(java.util.Locale&nbsp;loc)</PRE>
 939<DL>
 940<DD>Checks if the specified language as represented by the Locale is available
 941 and supported.
 942<P>
 943<DD><DL>
 944<DT><B>Parameters:</B><DD><CODE>loc</CODE> - The Locale describing the language to be used.
 945<DT><B>Returns:</B><DD>code indicating the support status for the locale. See
 946         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_AVAILABLE"><CODE>LANG_AVAILABLE</CODE></A>, <A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_COUNTRY_AVAILABLE"><CODE>LANG_COUNTRY_AVAILABLE</CODE></A>,
 947         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_COUNTRY_VAR_AVAILABLE"><CODE>LANG_COUNTRY_VAR_AVAILABLE</CODE></A>, <A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_MISSING_DATA"><CODE>LANG_MISSING_DATA</CODE></A> and
 948         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_NOT_SUPPORTED"><CODE>LANG_NOT_SUPPORTED</CODE></A>.</DL>
 949</DD>
 950</DL>
 951<HR>
 952
 953<A NAME="synthesizeToFile(java.lang.String, java.util.HashMap, java.lang.String)"><!-- --></A><H3>
 954synthesizeToFile</H3>
 955<PRE>
 956public int <B>synthesizeToFile</B>(java.lang.String&nbsp;text,
 957                            java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params,
 958                            java.lang.String&nbsp;filename)</PRE>
 959<DL>
 960<DD>Synthesizes the given text to a file using the specified parameters.
 961<P>
 962<DD><DL>
 963<DT><B>Parameters:</B><DD><CODE>text</CODE> - The String of text that should be synthesized<DD><CODE>params</CODE> - The list of parameters to be used. Can be null if no
 964        parameters are given. They are specified using a (key, value) pair,
 965        where the key can be <A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html#KEY_PARAM_UTTERANCE_ID"><CODE>TextToSpeechBeta.Engine.KEY_PARAM_UTTERANCE_ID</CODE></A>.<DD><CODE>filename</CODE> - The string that gives the full output filename; it should
 966        be something like "/sdcard/myappsounds/mysound.wav".
 967<DT><B>Returns:</B><DD>Code indicating success or failure. See <A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR"><CODE>ERROR</CODE></A> and
 968         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>
 969</DD>
 970</DL>
 971<HR>
 972
 973<A NAME="setOnUtteranceCompletedListener(com.google.tts.TextToSpeechBeta.OnUtteranceCompletedListener)"><!-- --></A><H3>
 974setOnUtteranceCompletedListener</H3>
 975<PRE>
 976public int <B>setOnUtteranceCompletedListener</B>(<A HREF="../../../com/google/tts/TextToSpeechBeta.OnUtteranceCompletedListener.html" title="interface in com.google.tts">TextToSpeechBeta.OnUtteranceCompletedListener</A>&nbsp;listener)</PRE>
 977<DL>
 978<DD>Sets the OnUtteranceCompletedListener that will fire when an utterance
 979 completes.
 980<P>
 981<DD><DL>
 982<DT><B>Parameters:</B><DD><CODE>listener</CODE> - The OnUtteranceCompletedListener
 983<DT><B>Returns:</B><DD>Code indicating success or failure. See <A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR"><CODE>ERROR</CODE></A> and
 984         <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>
 985</DD>
 986</DL>
 987<HR>
 988
 989<A NAME="isInstalled(Context)"><!-- --></A><H3>
 990isInstalled</H3>
 991<PRE>
 992public static boolean <B>isInstalled</B>(Context&nbsp;ctx)</PRE>
 993<DL>
 994<DD>Standalone TTS ONLY!
 995 
 996 Checks if the TTS service is installed or not
 997<P>
 998<DD><DL>
 999
1000<DT><B>Returns:</B><DD>A boolean that indicates whether the TTS service is installed</DL>
1001</DD>
1002</DL>
1003<!-- ========= END OF CLASS DATA ========= -->
1004<HR>
1005
1006
1007<!-- ======= START OF BOTTOM NAVBAR ====== -->
1008<A NAME="navbar_bottom"><!-- --></A>
1009<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1010<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1011<TR>
1012<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1013<A NAME="navbar_bottom_firstrow"><!-- --></A>
1014<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1015  <TR ALIGN="center" VALIGN="top">
1016  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../com/google/tts/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1017  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1018  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1019  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1020  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1021  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1022  </TR>
1023</TABLE>
1024</TD>
1025<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1026</EM>
1027</TD>
1028</TR>
1029
1030<TR>
1031<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1032&nbsp;PREV CLASS&nbsp;
1033&nbsp;<A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html" title="class in com.google.tts"><B>NEXT CLASS</B></A></FONT></TD>
1034<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1035  <A HREF="../../../index.html?com/google/tts/TextToSpeechBeta.html" target="_top"><B>FRAMES</B></A>  &nbsp;
1036&nbsp;<A HREF="TextToSpeechBeta.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
1037&nbsp;<SCRIPT type="text/javascript">
1038  <!--
1039  if(window==top) {
1040    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
1041  }
1042  //-->
1043</SCRIPT>
1044<NOSCRIPT>
1045  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
1046</NOSCRIPT>
1047
1048
1049</FONT></TD>
1050</TR>
1051<TR>
1052<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1053  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1054<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1055DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1056</TR>
1057</TABLE>
1058<A NAME="skip-navbar_bottom"></A>
1059<!-- ======== END OF BOTTOM NAVBAR ======= -->
1060
1061<HR>
1062
1063</BODY>
1064</HTML>