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

  2. <!--NewPage-->

    3. 

  3. <HTML>

    4. 

  4. <HEAD>

    5. 

  5. <!-- Generated by javadoc (build 1.6.0_16) on Fri Oct 09 19:06:10 PDT 2009 -->

    6. 

  6. <TITLE>

    7. 

  7. TextToSpeechBeta

    8. 

  8. </TITLE>

    9. 

  9. 

    10. 

  10. <META NAME="date" CONTENT="2009-10-09">

    11. 

  11. 

    12. 

  12. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

    13. 

  13. 

    14. 

  14. <SCRIPT type="text/javascript">

    15. 

  15. function windowTitle()

    16. 

  16. {

    17. 

  17.     if (location.href.indexOf('is-external=true') == -1) {

    18. 

  18.         parent.document.title="TextToSpeechBeta";

    19. 

  19.     }

    20. 

  20. }

    21. 

  21. </SCRIPT>

    22. 

  22. <NOSCRIPT>

    23. 

  23. </NOSCRIPT>

    24. 

  24. 

    25. 

  25. </HEAD>

    26. 

  26. 

    27. 

  27. <BODY BGCOLOR="white" onload="windowTitle();">

    28. 

  28. <HR>

    29. 

  29. 

    30. 

  30. 

    31. 

  31. <!-- ========= START OF TOP NAVBAR ======= -->

    32. 

  32. <A NAME="navbar_top"><!-- --></A>

    33. 

  33. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>

    34. 

  34. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">

    35. 

  35. <TR>

    36. 

  36. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">

    37. 

  37. <A NAME="navbar_top_firstrow"><!-- --></A>

    38. 

  38. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">

    39. 

  39.   <TR ALIGN="center" VALIGN="top">

    40. 

  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. 

  41.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>

    42. 

  42.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>

    43. 

  43.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>

    44. 

  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>

    45. 

  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>

    46. 

  46.   </TR>

    47. 

  47. </TABLE>

    48. 

  48. </TD>

    49. 

  49. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>

    50. 

  50. </EM>

    51. 

  51. </TD>

    52. 

  52. </TR>

    53. 

  53. 

    54. 

  54. <TR>

    55. 

  55. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">

    56. 

  56. &nbsp;PREV CLASS&nbsp;

    57. 

  57. &nbsp;<A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html" title="class in com.google.tts"><B>NEXT CLASS</B></A></FONT></TD>

    58. 

  58. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">

    59. 

  59.   <A HREF="../../../index.html?com/google/tts/TextToSpeechBeta.html" target="_top"><B>FRAMES</B></A>  &nbsp;

    60. 

  60. &nbsp;<A HREF="TextToSpeechBeta.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;

    61. 

  61. &nbsp;<SCRIPT type="text/javascript">

    62. 

  62.   <!--

    63. 

  63.   if(window==top) {

    64. 

  64.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');

    65. 

  65.   }

    66. 

  66.   //-->

    67. 

  67. </SCRIPT>

    68. 

  68. <NOSCRIPT>

    69. 

  69.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>

    70. 

  70. </NOSCRIPT>

    71. 

  71. 

    72. 

  72. 

    73. 

  73. </FONT></TD>

    74. 

  74. </TR>

    75. 

  75. <TR>

    76. 

  76. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">

    77. 

  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. 

  78. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">

    79. 

  79. DETAIL:&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. 

  80. </TR>

    81. 

  81. </TABLE>

    82. 

  82. <A NAME="skip-navbar_top"></A>

    83. 

  83. <!-- ========= END OF TOP NAVBAR ========= -->

    84. 

  84. 

    85. 

  85. <HR>

    86. 

  86. <!-- ======== START OF CLASS DATA ======== -->

    87. 

  87. <H2>

    88. 

  88. <FONT SIZE="-1">

    89. 

  89. com.google.tts</FONT>

    90. 

  90. <BR>

    91. 

  91. Class TextToSpeechBeta</H2>

    92. 

  92. <PRE>

    93. 

  93. java.lang.Object

    94. 

  94.   <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">TextToSpeech

    95. 

  95.       <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.google.tts.TextToSpeechBeta</B>

    96. 

  96. </PRE>

    97. 

  97. <HR>

    98. 

  98. <DL>

    99. 

  99. <DT><PRE>public class <B>TextToSpeechBeta</B><DT>extends TextToSpeech</DL>

    100. 

  100. </PRE>

    101. 

  101. 

    102. 

  102. <P>

    103. 

  103. Synthesizes speech from text for immediate playback or to create a sound
    104. 

  104.  file.
    105. 

  105.  <p>
    106. 

  106.  A TextToSpeech instance can only be used to synthesize text once it has
    107. 

  107.  completed its initialization. Implement the
    108. 

  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. 

  109.  the initialization.<br>
    110. 

  110.  When you are done using the TextToSpeech instance, call the
    111. 

  111.  <A HREF="../../../com/google/tts/TextToSpeechBeta.html#shutdown()"><CODE>shutdown()</CODE></A> method to release the native resources used by the
    112. 

  112.  TextToSpeech engine.

    113. 

  113. <P>

    114. 

  114. 

    115. 

  115. <P>

    116. 

  116. <HR>

    117. 

  117. 

    118. 

  118. <P>

    119. 

  119. <!-- ======== NESTED CLASS SUMMARY ======== -->

    120. 

  120. 

    121. 

  121. <A NAME="nested_class_summary"><!-- --></A>

    122. 

  122. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">

    123. 

  123. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">

    124. 

  124. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">

    125. 

  125. <B>Nested Class Summary</B></FONT></TH>

    126. 

  126. </TR>

    127. 

  127. <TR BGCOLOR="white" CLASS="TableRowColor">

    128. 

  128. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    129. 

  129. <CODE>&nbsp;class</CODE></FONT></TD>

    130. 

  130. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html" title="class in com.google.tts">TextToSpeechBeta.Engine</A></B></CODE>

    131. 

  131. 

    132. 

  132. <BR>

    133. 

  133. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Internal constants for the TextToSpeech functionality</TD>

    134. 

  134. </TR>

    135. 

  135. <TR BGCOLOR="white" CLASS="TableRowColor">

    136. 

  136. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    137. 

  137. <CODE>static&nbsp;interface</CODE></FONT></TD>

    138. 

  138. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.OnInitListener.html" title="interface in com.google.tts">TextToSpeechBeta.OnInitListener</A></B></CODE>

    139. 

  139. 

    140. 

  140. <BR>

    141. 

  141. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Interface definition of a callback to be invoked indicating the completion
    142. 

  142.  of the TextToSpeech engine initialization.</TD>

    143. 

  143. </TR>

    144. 

  144. <TR BGCOLOR="white" CLASS="TableRowColor">

    145. 

  145. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    146. 

  146. <CODE>static&nbsp;interface</CODE></FONT></TD>

    147. 

  147. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.OnUtteranceCompletedListener.html" title="interface in com.google.tts">TextToSpeechBeta.OnUtteranceCompletedListener</A></B></CODE>

    148. 

  148. 

    149. 

  149. <BR>

    150. 

  150. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Interface definition of a callback to be invoked indicating the
    151. 

  151.  TextToSpeech engine has completed synthesizing an utterance with an
    152. 

  152.  utterance ID set.</TD>

    153. 

  153. </TR>

    154. 

  154. </TABLE>

    155. 

  155. &nbsp;<!-- =========== FIELD SUMMARY =========== -->

    156. 

  156. 

    157. 

  157. <A NAME="field_summary"><!-- --></A>

    158. 

  158. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">

    159. 

  159. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">

    160. 

  160. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">

    161. 

  161. <B>Field Summary</B></FONT></TH>

    162. 

  162. </TR>

    163. 

  163. <TR BGCOLOR="white" CLASS="TableRowColor">

    164. 

  164. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    165. 

  165. <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>

    166. 

  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. 

  167. 

    168. 

  168. <BR>

    169. 

  169. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Broadcast Action: The TextToSpeech synthesizer has completed processing of
    170. 

  170.  all the text in the speech queue.</TD>

    171. 

  171. </TR>

    172. 

  172. <TR BGCOLOR="white" CLASS="TableRowColor">

    173. 

  173. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    174. 

  174. <CODE>static&nbsp;int</CODE></FONT></TD>

    175. 

  175. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#ERROR">ERROR</A></B></CODE>

    176. 

  176. 

    177. 

  177. <BR>

    178. 

  178. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes a generic operation failure.</TD>

    179. 

  179. </TR>

    180. 

  180. <TR BGCOLOR="white" CLASS="TableRowColor">

    181. 

  181. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    182. 

  182. <CODE>static&nbsp;int</CODE></FONT></TD>

    183. 

  183. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_AVAILABLE">LANG_AVAILABLE</A></B></CODE>

    184. 

  184. 

    185. 

  185. <BR>

    186. 

  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. 

  187.  the country and variant.</TD>

    188. 

  188. </TR>

    189. 

  189. <TR BGCOLOR="white" CLASS="TableRowColor">

    190. 

  190. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    191. 

  191. <CODE>static&nbsp;int</CODE></FONT></TD>

    192. 

  192. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_COUNTRY_AVAILABLE">LANG_COUNTRY_AVAILABLE</A></B></CODE>

    193. 

  193. 

    194. 

  194. <BR>

    195. 

  195. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes the language is available for the language and country specified by
    196. 

  196.  the locale, but not the variant.</TD>

    197. 

  197. </TR>

    198. 

  198. <TR BGCOLOR="white" CLASS="TableRowColor">

    199. 

  199. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    200. 

  200. <CODE>static&nbsp;int</CODE></FONT></TD>

    201. 

  201. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_COUNTRY_VAR_AVAILABLE">LANG_COUNTRY_VAR_AVAILABLE</A></B></CODE>

    202. 

  202. 

    203. 

  203. <BR>

    204. 

  204. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes the language is available exactly as specified by the locale.</TD>

    205. 

  205. </TR>

    206. 

  206. <TR BGCOLOR="white" CLASS="TableRowColor">

    207. 

  207. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    208. 

  208. <CODE>static&nbsp;int</CODE></FONT></TD>

    209. 

  209. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_MISSING_DATA">LANG_MISSING_DATA</A></B></CODE>

    210. 

  210. 

    211. 

  211. <BR>

    212. 

  212. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes the language data is missing.</TD>

    213. 

  213. </TR>

    214. 

  214. <TR BGCOLOR="white" CLASS="TableRowColor">

    215. 

  215. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    216. 

  216. <CODE>static&nbsp;int</CODE></FONT></TD>

    217. 

  217. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_NOT_SUPPORTED">LANG_NOT_SUPPORTED</A></B></CODE>

    218. 

  218. 

    219. 

  219. <BR>

    220. 

  220. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes the language is not supported.</TD>

    221. 

  221. </TR>

    222. 

  222. <TR BGCOLOR="white" CLASS="TableRowColor">

    223. 

  223. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    224. 

  224. <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>

    225. 

  225. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#NOT_ON_PLATFORM_TTS">NOT_ON_PLATFORM_TTS</A></B></CODE>

    226. 

  226. 

    227. 

  227. <BR>

    228. 

  228. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>

    229. 

  229. </TR>

    230. 

  230. <TR BGCOLOR="white" CLASS="TableRowColor">

    231. 

  231. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    232. 

  232. <CODE>static&nbsp;int</CODE></FONT></TD>

    233. 

  233. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#QUEUE_ADD">QUEUE_ADD</A></B></CODE>

    234. 

  234. 

    235. 

  235. <BR>

    236. 

  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. 

  237. </TR>

    238. 

  238. <TR BGCOLOR="white" CLASS="TableRowColor">

    239. 

  239. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    240. 

  240. <CODE>static&nbsp;int</CODE></FONT></TD>

    241. 

  241. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#QUEUE_FLUSH">QUEUE_FLUSH</A></B></CODE>

    242. 

  242. 

    243. 

  243. <BR>

    244. 

  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. 

  245.  text to be synthesized) are dropped and replaced by the new entry.</TD>

    246. 

  246. </TR>

    247. 

  247. <TR BGCOLOR="white" CLASS="TableRowColor">

    248. 

  248. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    249. 

  249. <CODE>static&nbsp;int</CODE></FONT></TD>

    250. 

  250. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS">SUCCESS</A></B></CODE>

    251. 

  251. 

    252. 

  252. <BR>

    253. 

  253. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Denotes a successful operation.</TD>

    254. 

  254. </TR>

    255. 

  255. <TR BGCOLOR="white" CLASS="TableRowColor">

    256. 

  256. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    257. 

  257. <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>

    258. 

  258. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#USING_PLATFORM_TTS">USING_PLATFORM_TTS</A></B></CODE>

    259. 

  259. 

    260. 

  260. <BR>

    261. 

  261. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>

    262. 

  262. </TR>

    263. 

  263. </TABLE>

    264. 

  264. &nbsp;

    265. 

  265. <!-- ======== CONSTRUCTOR SUMMARY ======== -->

    266. 

  266. 

    267. 

  267. <A NAME="constructor_summary"><!-- --></A>

    268. 

  268. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">

    269. 

  269. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">

    270. 

  270. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">

    271. 

  271. <B>Constructor Summary</B></FONT></TH>

    272. 

  272. </TR>

    273. 

  273. <TR BGCOLOR="white" CLASS="TableRowColor">

    274. 

  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. 

  275.                  <A HREF="../../../com/google/tts/TextToSpeechBeta.OnInitListener.html" title="interface in com.google.tts">TextToSpeechBeta.OnInitListener</A>&nbsp;listener)</CODE>

    276. 

  276. 

    277. 

  277. <BR>

    278. 

  278. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The constructor for the TextToSpeech class.</TD>

    279. 

  279. </TR>

    280. 

  280. </TABLE>

    281. 

  281. &nbsp;

    282. 

  282. <!-- ========== METHOD SUMMARY =========== -->

    283. 

  283. 

    284. 

  284. <A NAME="method_summary"><!-- --></A>

    285. 

  285. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">

    286. 

  286. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">

    287. 

  287. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">

    288. 

  288. <B>Method Summary</B></FONT></TH>

    289. 

  289. </TR>

    290. 

  290. <TR BGCOLOR="white" CLASS="TableRowColor">

    291. 

  291. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    292. 

  292. <CODE>&nbsp;int</CODE></FONT></TD>

    293. 

  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. 

  294.           java.lang.String&nbsp;filename)</CODE>

    295. 

  295. 

    296. 

  296. <BR>

    297. 

  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. 

  298. </TR>

    299. 

  299. <TR BGCOLOR="white" CLASS="TableRowColor">

    300. 

  300. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    301. 

  301. <CODE>&nbsp;int</CODE></FONT></TD>

    302. 

  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. 

  303.           java.lang.String&nbsp;packagename,

    304. 

  304.           int&nbsp;resourceId)</CODE>

    305. 

  305. 

    306. 

  306. <BR>

    307. 

  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. 

  308. </TR>

    309. 

  309. <TR BGCOLOR="white" CLASS="TableRowColor">

    310. 

  310. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    311. 

  311. <CODE>&nbsp;int</CODE></FONT></TD>

    312. 

  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. 

  313.           java.lang.String&nbsp;filename)</CODE>

    314. 

  314. 

    315. 

  315. <BR>

    316. 

  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. 

  317. </TR>

    318. 

  318. <TR BGCOLOR="white" CLASS="TableRowColor">

    319. 

  319. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    320. 

  320. <CODE>&nbsp;int</CODE></FONT></TD>

    321. 

  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. 

  322.           java.lang.String&nbsp;packagename,

    323. 

  323.           int&nbsp;resourceId)</CODE>

    324. 

  324. 

    325. 

  325. <BR>

    326. 

  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. 

  327. </TR>

    328. 

  328. <TR BGCOLOR="white" CLASS="TableRowColor">

    329. 

  329. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    330. 

  330. <CODE>&nbsp;java.util.Locale</CODE></FONT></TD>

    331. 

  331. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#getLanguage()">getLanguage</A></B>()</CODE>

    332. 

  332. 

    333. 

  333. <BR>

    334. 

  334. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a Locale instance describing the language currently being used by
    335. 

  335.  the TextToSpeech engine.</TD>

    336. 

  336. </TR>

    337. 

  337. <TR BGCOLOR="white" CLASS="TableRowColor">

    338. 

  338. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    339. 

  339. <CODE>static&nbsp;boolean</CODE></FONT></TD>

    340. 

  340. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#isInstalled(Context)">isInstalled</A></B>(Context&nbsp;ctx)</CODE>

    341. 

  341. 

    342. 

  342. <BR>

    343. 

  343. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Standalone TTS ONLY!
    344. 

  344.  
    345. 

  345.  Checks if the TTS service is installed or not</TD>

    346. 

  346. </TR>

    347. 

  347. <TR BGCOLOR="white" CLASS="TableRowColor">

    348. 

  348. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    349. 

  349. <CODE>&nbsp;int</CODE></FONT></TD>

    350. 

  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. 

  351. 

    352. 

  352. <BR>

    353. 

  353. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks if the specified language as represented by the Locale is available
    354. 

  354.  and supported.</TD>

    355. 

  355. </TR>

    356. 

  356. <TR BGCOLOR="white" CLASS="TableRowColor">

    357. 

  357. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    358. 

  358. <CODE>&nbsp;boolean</CODE></FONT></TD>

    359. 

  359. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#isSpeaking()">isSpeaking</A></B>()</CODE>

    360. 

  360. 

    361. 

  361. <BR>

    362. 

  362. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether or not the TextToSpeech engine is busy speaking.</TD>

    363. 

  363. </TR>

    364. 

  364. <TR BGCOLOR="white" CLASS="TableRowColor">

    365. 

  365. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    366. 

  366. <CODE>&nbsp;int</CODE></FONT></TD>

    367. 

  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. 

  368.            int&nbsp;queueMode,

    369. 

  369.            java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params)</CODE>

    370. 

  370. 

    371. 

  371. <BR>

    372. 

  372. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Plays the earcon using the specified queueing mode and parameters.</TD>

    373. 

  373. </TR>

    374. 

  374. <TR BGCOLOR="white" CLASS="TableRowColor">

    375. 

  375. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    376. 

  376. <CODE>&nbsp;int</CODE></FONT></TD>

    377. 

  377. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#playSilence(long, int, java.util.HashMap)">playSilence</A></B>(long&nbsp;durationInMs,

    378. 

  378.             int&nbsp;queueMode,

    379. 

  379.             java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params)</CODE>

    380. 

  380. 

    381. 

  381. <BR>

    382. 

  382. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Plays silence for the specified amount of time using the specified queue
    383. 

  383.  mode.</TD>

    384. 

  384. </TR>

    385. 

  385. <TR BGCOLOR="white" CLASS="TableRowColor">

    386. 

  386. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    387. 

  387. <CODE>&nbsp;int</CODE></FONT></TD>

    388. 

  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. 

  389. 

    390. 

  390. <BR>

    391. 

  391. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the language for the TextToSpeech engine.</TD>

    392. 

  392. </TR>

    393. 

  393. <TR BGCOLOR="white" CLASS="TableRowColor">

    394. 

  394. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    395. 

  395. <CODE>&nbsp;int</CODE></FONT></TD>

    396. 

  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. 

  397. 

    398. 

  398. <BR>

    399. 

  399. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the OnUtteranceCompletedListener that will fire when an utterance
    400. 

  400.  completes.</TD>

    401. 

  401. </TR>

    402. 

  402. <TR BGCOLOR="white" CLASS="TableRowColor">

    403. 

  403. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    404. 

  404. <CODE>&nbsp;int</CODE></FONT></TD>

    405. 

  405. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#setPitch(float)">setPitch</A></B>(float&nbsp;pitch)</CODE>

    406. 

  406. 

    407. 

  407. <BR>

    408. 

  408. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the speech pitch for the TextToSpeech engine.</TD>

    409. 

  409. </TR>

    410. 

  410. <TR BGCOLOR="white" CLASS="TableRowColor">

    411. 

  411. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    412. 

  412. <CODE>&nbsp;int</CODE></FONT></TD>

    413. 

  413. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#setSpeechRate(float)">setSpeechRate</A></B>(float&nbsp;speechRate)</CODE>

    414. 

  414. 

    415. 

  415. <BR>

    416. 

  416. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the speech rate for the TextToSpeech engine.</TD>

    417. 

  417. </TR>

    418. 

  418. <TR BGCOLOR="white" CLASS="TableRowColor">

    419. 

  419. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    420. 

  420. <CODE>&nbsp;void</CODE></FONT></TD>

    421. 

  421. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#shutdown()">shutdown</A></B>()</CODE>

    422. 

  422. 

    423. 

  423. <BR>

    424. 

  424. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Releases the resources used by the TextToSpeech engine.</TD>

    425. 

  425. </TR>

    426. 

  426. <TR BGCOLOR="white" CLASS="TableRowColor">

    427. 

  427. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    428. 

  428. <CODE>&nbsp;int</CODE></FONT></TD>

    429. 

  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. 

  430.       int&nbsp;queueMode,

    431. 

  431.       java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params)</CODE>

    432. 

  432. 

    433. 

  433. <BR>

    434. 

  434. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Speaks the string using the specified queuing strategy and speech
    435. 

  435.  parameters.</TD>

    436. 

  436. </TR>

    437. 

  437. <TR BGCOLOR="white" CLASS="TableRowColor">

    438. 

  438. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    439. 

  439. <CODE>&nbsp;int</CODE></FONT></TD>

    440. 

  440. <TD><CODE><B><A HREF="../../../com/google/tts/TextToSpeechBeta.html#stop()">stop</A></B>()</CODE>

    441. 

  441. 

    442. 

  442. <BR>

    443. 

  443. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Interrupts the current utterance (whether played or rendered to file) and
    444. 

  444.  discards other utterances in the queue.</TD>

    445. 

  445. </TR>

    446. 

  446. <TR BGCOLOR="white" CLASS="TableRowColor">

    447. 

  447. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">

    448. 

  448. <CODE>&nbsp;int</CODE></FONT></TD>

    449. 

  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. 

  450.                  java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params,

    451. 

  451.                  java.lang.String&nbsp;filename)</CODE>

    452. 

  452. 

    453. 

  453. <BR>

    454. 

  454. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Synthesizes the given text to a file using the specified parameters.</TD>

    455. 

  455. </TR>

    456. 

  456. </TABLE>

    457. 

  457. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>

    458. 

  458. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">

    459. 

  459. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">

    460. 

  460. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>

    461. 

  461. </TR>

    462. 

  462. <TR BGCOLOR="white" CLASS="TableRowColor">

    463. 

  463. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>

    464. 

  464. </TR>

    465. 

  465. </TABLE>

    466. 

  466. &nbsp;

    467. 

  467. <P>

    468. 

  468. 

    469. 

  469. <!-- ============ FIELD DETAIL =========== -->

    470. 

  470. 

    471. 

  471. <A NAME="field_detail"><!-- --></A>

    472. 

  472. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">

    473. 

  473. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">

    474. 

  474. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">

    475. 

  475. <B>Field Detail</B></FONT></TH>

    476. 

  476. </TR>

    477. 

  477. </TABLE>

    478. 

  478. 

    479. 

  479. <A NAME="USING_PLATFORM_TTS"><!-- --></A><H3>

    480. 

  480. USING_PLATFORM_TTS</H3>

    481. 

  481. <PRE>

    482. 

  482. public static final java.lang.String <B>USING_PLATFORM_TTS</B></PRE>

    483. 

  483. <DL>

    484. 

  484. <DL>

    485. 

  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. 

  486. </DL>

    487. 

  487. <HR>

    488. 

  488. 

    489. 

  489. <A NAME="NOT_ON_PLATFORM_TTS"><!-- --></A><H3>

    490. 

  490. NOT_ON_PLATFORM_TTS</H3>

    491. 

  491. <PRE>

    492. 

  492. public static final java.lang.String <B>NOT_ON_PLATFORM_TTS</B></PRE>

    493. 

  493. <DL>

    494. 

  494. <DL>

    495. 

  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. 

  496. </DL>

    497. 

  497. <HR>

    498. 

  498. 

    499. 

  499. <A NAME="SUCCESS"><!-- --></A><H3>

    500. 

  500. SUCCESS</H3>

    501. 

  501. <PRE>

    502. 

  502. public static final int <B>SUCCESS</B></PRE>

    503. 

  503. <DL>

    504. 

  504. <DD>Denotes a successful operation.

    505. 

  505. <P>

    506. 

  506. <DL>

    507. 

  507. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.SUCCESS">Constant Field Values</A></DL>

    508. 

  508. </DL>

    509. 

  509. <HR>

    510. 

  510. 

    511. 

  511. <A NAME="ERROR"><!-- --></A><H3>

    512. 

  512. ERROR</H3>

    513. 

  513. <PRE>

    514. 

  514. public static final int <B>ERROR</B></PRE>

    515. 

  515. <DL>

    516. 

  516. <DD>Denotes a generic operation failure.

    517. 

  517. <P>

    518. 

  518. <DL>

    519. 

  519. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.ERROR">Constant Field Values</A></DL>

    520. 

  520. </DL>

    521. 

  521. <HR>

    522. 

  522. 

    523. 

  523. <A NAME="QUEUE_FLUSH"><!-- --></A><H3>

    524. 

  524. QUEUE_FLUSH</H3>

    525. 

  525. <PRE>

    526. 

  526. public static final int <B>QUEUE_FLUSH</B></PRE>

    527. 

  527. <DL>

    528. 

  528. <DD>Queue mode where all entries in the playback queue (media to be played and
    529. 

  529.  text to be synthesized) are dropped and replaced by the new entry.

    530. 

  530. <P>

    531. 

  531. <DL>

    532. 

  532. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.QUEUE_FLUSH">Constant Field Values</A></DL>

    533. 

  533. </DL>

    534. 

  534. <HR>

    535. 

  535. 

    536. 

  536. <A NAME="QUEUE_ADD"><!-- --></A><H3>

    537. 

  537. QUEUE_ADD</H3>

    538. 

  538. <PRE>

    539. 

  539. public static final int <B>QUEUE_ADD</B></PRE>

    540. 

  540. <DL>

    541. 

  541. <DD>Queue mode where the new entry is added at the end of the playback queue.

    542. 

  542. <P>

    543. 

  543. <DL>

    544. 

  544. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.QUEUE_ADD">Constant Field Values</A></DL>

    545. 

  545. </DL>

    546. 

  546. <HR>

    547. 

  547. 

    548. 

  548. <A NAME="LANG_COUNTRY_VAR_AVAILABLE"><!-- --></A><H3>

    549. 

  549. LANG_COUNTRY_VAR_AVAILABLE</H3>

    550. 

  550. <PRE>

    551. 

  551. public static final int <B>LANG_COUNTRY_VAR_AVAILABLE</B></PRE>

    552. 

  552. <DL>

    553. 

  553. <DD>Denotes the language is available exactly as specified by the locale.

    554. 

  554. <P>

    555. 

  555. <DL>

    556. 

  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. 

  557. </DL>

    558. 

  558. <HR>

    559. 

  559. 

    560. 

  560. <A NAME="LANG_COUNTRY_AVAILABLE"><!-- --></A><H3>

    561. 

  561. LANG_COUNTRY_AVAILABLE</H3>

    562. 

  562. <PRE>

    563. 

  563. public static final int <B>LANG_COUNTRY_AVAILABLE</B></PRE>

    564. 

  564. <DL>

    565. 

  565. <DD>Denotes the language is available for the language and country specified by
    566. 

  566.  the locale, but not the variant.

    567. 

  567. <P>

    568. 

  568. <DL>

    569. 

  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. 

  570. </DL>

    571. 

  571. <HR>

    572. 

  572. 

    573. 

  573. <A NAME="LANG_AVAILABLE"><!-- --></A><H3>

    574. 

  574. LANG_AVAILABLE</H3>

    575. 

  575. <PRE>

    576. 

  576. public static final int <B>LANG_AVAILABLE</B></PRE>

    577. 

  577. <DL>

    578. 

  578. <DD>Denotes the language is available for the language by the locale, but not
    579. 

  579.  the country and variant.

    580. 

  580. <P>

    581. 

  581. <DL>

    582. 

  582. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.google.tts.TextToSpeechBeta.LANG_AVAILABLE">Constant Field Values</A></DL>

    583. 

  583. </DL>

    584. 

  584. <HR>

    585. 

  585. 

    586. 

  586. <A NAME="LANG_MISSING_DATA"><!-- --></A><H3>

    587. 

  587. LANG_MISSING_DATA</H3>

    588. 

  588. <PRE>

    589. 

  589. public static final int <B>LANG_MISSING_DATA</B></PRE>

    590. 

  590. <DL>

    591. 

  591. <DD>Denotes the language data is missing.

    592. 

  592. <P>

    593. 

  593. <DL>

    594. 

  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. 

  595. </DL>

    596. 

  596. <HR>

    597. 

  597. 

    598. 

  598. <A NAME="LANG_NOT_SUPPORTED"><!-- --></A><H3>

    599. 

  599. LANG_NOT_SUPPORTED</H3>

    600. 

  600. <PRE>

    601. 

  601. public static final int <B>LANG_NOT_SUPPORTED</B></PRE>

    602. 

  602. <DL>

    603. 

  603. <DD>Denotes the language is not supported.

    604. 

  604. <P>

    605. 

  605. <DL>

    606. 

  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. 

  607. </DL>

    608. 

  608. <HR>

    609. 

  609. 

    610. 

  610. <A NAME="ACTION_TTS_QUEUE_PROCESSING_COMPLETED"><!-- --></A><H3>

    611. 

  611. ACTION_TTS_QUEUE_PROCESSING_COMPLETED</H3>

    612. 

  612. <PRE>

    613. 

  613. public static final java.lang.String <B>ACTION_TTS_QUEUE_PROCESSING_COMPLETED</B></PRE>

    614. 

  614. <DL>

    615. 

  615. <DD>Broadcast Action: The TextToSpeech synthesizer has completed processing of
    616. 

  616.  all the text in the speech queue.

    617. 

  617. <P>

    618. 

  618. <DL>

    619. 

  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. 

  620. </DL>

    621. 

  621. 

    622. 

  622. <!-- ========= CONSTRUCTOR DETAIL ======== -->

    623. 

  623. 

    624. 

  624. <A NAME="constructor_detail"><!-- --></A>

    625. 

  625. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">

    626. 

  626. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">

    627. 

  627. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">

    628. 

  628. <B>Constructor Detail</B></FONT></TH>

    629. 

  629. </TR>

    630. 

  630. </TABLE>

    631. 

  631. 

    632. 

  632. <A NAME="TextToSpeechBeta(Context, com.google.tts.TextToSpeechBeta.OnInitListener)"><!-- --></A><H3>

    633. 

  633. TextToSpeechBeta</H3>

    634. 

  634. <PRE>

    635. 

  635. public <B>TextToSpeechBeta</B>(Context&nbsp;context,

    636. 

  636.                         <A HREF="../../../com/google/tts/TextToSpeechBeta.OnInitListener.html" title="interface in com.google.tts">TextToSpeechBeta.OnInitListener</A>&nbsp;listener)</PRE>

    637. 

  637. <DL>

    638. 

  638. <DD>The constructor for the TextToSpeech class. This will also initialize the
    639. 

  639.  associated TextToSpeech engine if it isn't already running.

    640. 

  640. <P>

    641. 

  641. <DL>

    642. 

  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. 

  643.         called when the TextToSpeech engine has initialized.</DL>

    644. 

  644. </DL>

    645. 

  645. 

    646. 

  646. <!-- ============ METHOD DETAIL ========== -->

    647. 

  647. 

    648. 

  648. <A NAME="method_detail"><!-- --></A>

    649. 

  649. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">

    650. 

  650. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">

    651. 

  651. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">

    652. 

  652. <B>Method Detail</B></FONT></TH>

    653. 

  653. </TR>

    654. 

  654. </TABLE>

    655. 

  655. 

    656. 

  656. <A NAME="shutdown()"><!-- --></A><H3>

    657. 

  657. shutdown</H3>

    658. 

  658. <PRE>

    659. 

  659. public void <B>shutdown</B>()</PRE>

    660. 

  660. <DL>

    661. 

  661. <DD>Releases the resources used by the TextToSpeech engine. It is good practice
    662. 

  662.  for instance to call this method in the onDestroy() method of an Activity
    663. 

  663.  so the TextToSpeech engine can be cleanly stopped.

    664. 

  664. <P>

    665. 

  665. <DD><DL>

    666. 

  666. </DL>

    667. 

  667. </DD>

    668. 

  668. </DL>

    669. 

  669. <HR>

    670. 

  670. 

    671. 

  671. <A NAME="addSpeech(java.lang.String, java.lang.String, int)"><!-- --></A><H3>

    672. 

  672. addSpeech</H3>

    673. 

  673. <PRE>

    674. 

  674. public int <B>addSpeech</B>(java.lang.String&nbsp;text,

    675. 

  675.                      java.lang.String&nbsp;packagename,

    676. 

  676.                      int&nbsp;resourceId)</PRE>

    677. 

  677. <DL>

    678. 

  678. <DD>Adds a mapping between a string of text and a sound resource in a package.
    679. 

  679.  After a call to this method, subsequent calls to
    680. 

  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. 

  681.  if it is available, or synthesize the text it is missing.

    682. 

  682. <P>

    683. 

  683. <DD><DL>

    684. 

  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. 

  685.         the resource. If the resource is in your own application (this is
    686. 

  686.         the most common case), then put the packagename of your application
    687. 

  687.         here.<br/>
    688. 

  688.         Example: <b>"com.google.marvin.compass"</b><br/>
    689. 

  689.         The packagename can be found in the AndroidManifest.xml of your
    690. 

  690.         application.
    691. 

  691.         <p>
    692. 

  692.         <code>&lt;manifest xmlns:android=&quot;...&quot;
    693. 

  693.       package=&quot;<b>com.google.marvin.compass</b>&quot;&gt;</code>
    694. 

  694.         </p><DD><CODE>resourceId</CODE> - Example: <code>R.raw.south_south_east</code>

    695. 

  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. 

  696.          <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>

    697. 

  697. </DD>

    698. 

  698. </DL>

    699. 

  699. <HR>

    700. 

  700. 

    701. 

  701. <A NAME="addSpeech(java.lang.String, java.lang.String)"><!-- --></A><H3>

    702. 

  702. addSpeech</H3>

    703. 

  703. <PRE>

    704. 

  704. public int <B>addSpeech</B>(java.lang.String&nbsp;text,

    705. 

  705.                      java.lang.String&nbsp;filename)</PRE>

    706. 

  706. <DL>

    707. 

  707. <DD>Adds a mapping between a string of text and a sound file. Using this, it is
    708. 

  708.  possible to add custom pronounciations for a string of text. After a call
    709. 

  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. 

  710.  will play the specified sound resource if it is available, or synthesize
    711. 

  711.  the text it is missing.

    712. 

  712. <P>

    713. 

  713. <DD><DL>

    714. 

  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. 

  715.         "/sdcard/mysounds/hello.wav")

    716. 

  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. 

  717.          <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>

    718. 

  718. </DD>

    719. 

  719. </DL>

    720. 

  720. <HR>

    721. 

  721. 

    722. 

  722. <A NAME="addEarcon(java.lang.String, java.lang.String, int)"><!-- --></A><H3>

    723. 

  723. addEarcon</H3>

    724. 

  724. <PRE>

    725. 

  725. public int <B>addEarcon</B>(java.lang.String&nbsp;earcon,

    726. 

  726.                      java.lang.String&nbsp;packagename,

    727. 

  727.                      int&nbsp;resourceId)</PRE>

    728. 

  728. <DL>

    729. 

  729. <DD>Adds a mapping between a string of text and a sound resource in a package.
    730. 

  730.  Use this to add custom earcons.

    731. 

  731. <P>

    732. 

  732. <DD><DL>

    733. 

  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. 

  734.         resource. This can for instance be the package name of your own
    735. 

  735.         application. Example: <b>"com.google.marvin.compass"</b><br/>
    736. 

  736.         The package name can be found in the AndroidManifest.xml of the
    737. 

  737.         application containing the resource.
    738. 

  738.         <p>
    739. 

  739.         <code>&lt;manifest xmlns:android=&quot;...&quot;
    740. 

  740.       package=&quot;<b>com.google.marvin.compass</b>&quot;&gt;</code>
    741. 

  741.         </p><DD><CODE>resourceId</CODE> - Example: <code>R.raw.tick_snd</code>

    742. 

  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. 

  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. 

  744. </DD>

    745. 

  745. </DL>

    746. 

  746. <HR>

    747. 

  747. 

    748. 

  748. <A NAME="addEarcon(java.lang.String, java.lang.String)"><!-- --></A><H3>

    749. 

  749. addEarcon</H3>

    750. 

  750. <PRE>

    751. 

  751. public int <B>addEarcon</B>(java.lang.String&nbsp;earcon,

    752. 

  752.                      java.lang.String&nbsp;filename)</PRE>

    753. 

  753. <DL>

    754. 

  754. <DD>Adds a mapping between a string of text and a sound file. Use this to add
    755. 

  755.  custom earcons.

    756. 

  756. <P>

    757. 

  757. <DD><DL>

    758. 

  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. 

  759.         "/sdcard/mysounds/tick.wav")

    760. 

  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. 

  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. 

  762. </DD>

    763. 

  763. </DL>

    764. 

  764. <HR>

    765. 

  765. 

    766. 

  766. <A NAME="speak(java.lang.String, int, java.util.HashMap)"><!-- --></A><H3>

    767. 

  767. speak</H3>

    768. 

  768. <PRE>

    769. 

  769. public int <B>speak</B>(java.lang.String&nbsp;text,

    770. 

  770.                  int&nbsp;queueMode,

    771. 

  771.                  java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params)</PRE>

    772. 

  772. <DL>

    773. 

  773. <DD>Speaks the string using the specified queuing strategy and speech
    774. 

  774.  parameters.

    775. 

  775. <P>

    776. 

  776. <DD><DL>

    777. 

  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. 

  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. 

  779.         parameters are given. They are specified using a (key, value) pair,
    780. 

  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. 

  781.         <A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html#KEY_PARAM_UTTERANCE_ID"><CODE>TextToSpeechBeta.Engine.KEY_PARAM_UTTERANCE_ID</CODE></A>.

    782. 

  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. 

  783.          <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>

    784. 

  784. </DD>

    785. 

  785. </DL>

    786. 

  786. <HR>

    787. 

  787. 

    788. 

  788. <A NAME="playEarcon(java.lang.String, int, java.util.HashMap)"><!-- --></A><H3>

    789. 

  789. playEarcon</H3>

    790. 

  790. <PRE>

    791. 

  791. public int <B>playEarcon</B>(java.lang.String&nbsp;earcon,

    792. 

  792.                       int&nbsp;queueMode,

    793. 

  793.                       java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params)</PRE>

    794. 

  794. <DL>

    795. 

  795. <DD>Plays the earcon using the specified queueing mode and parameters.

    796. 

  796. <P>

    797. 

  797. <DD><DL>

    798. 

  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. 

  799.         parameters are given. They are specified using a (key, value) pair,
    800. 

  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. 

  801.         <A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html#KEY_PARAM_UTTERANCE_ID"><CODE>TextToSpeechBeta.Engine.KEY_PARAM_UTTERANCE_ID</CODE></A>.

    802. 

  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. 

  803.          <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>

    804. 

  804. </DD>

    805. 

  805. </DL>

    806. 

  806. <HR>

    807. 

  807. 

    808. 

  808. <A NAME="playSilence(long, int, java.util.HashMap)"><!-- --></A><H3>

    809. 

  809. playSilence</H3>

    810. 

  810. <PRE>

    811. 

  811. public int <B>playSilence</B>(long&nbsp;durationInMs,

    812. 

  812.                        int&nbsp;queueMode,

    813. 

  813.                        java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params)</PRE>

    814. 

  814. <DL>

    815. 

  815. <DD>Plays silence for the specified amount of time using the specified queue
    816. 

  816.  mode.

    817. 

  817. <P>

    818. 

  818. <DD><DL>

    819. 

  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. 

  820.         parameters are given. They are specified using a (key, value) pair,
    821. 

  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. 

  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. 

  823.          <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>

    824. 

  824. </DD>

    825. 

  825. </DL>

    826. 

  826. <HR>

    827. 

  827. 

    828. 

  828. <A NAME="isSpeaking()"><!-- --></A><H3>

    829. 

  829. isSpeaking</H3>

    830. 

  830. <PRE>

    831. 

  831. public boolean <B>isSpeaking</B>()</PRE>

    832. 

  832. <DL>

    833. 

  833. <DD>Returns whether or not the TextToSpeech engine is busy speaking.

    834. 

  834. <P>

    835. 

  835. <DD><DL>

    836. 

  836. 

    837. 

  837. <DT><B>Returns:</B><DD>Whether or not the TextToSpeech engine is busy speaking.</DL>

    838. 

  838. </DD>

    839. 

  839. </DL>

    840. 

  840. <HR>

    841. 

  841. 

    842. 

  842. <A NAME="stop()"><!-- --></A><H3>

    843. 

  843. stop</H3>

    844. 

  844. <PRE>

    845. 

  845. public int <B>stop</B>()</PRE>

    846. 

  846. <DL>

    847. 

  847. <DD>Interrupts the current utterance (whether played or rendered to file) and
    848. 

  848.  discards other utterances in the queue.

    849. 

  849. <P>

    850. 

  850. <DD><DL>

    851. 

  851. 

    852. 

  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. 

  853.          <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>

    854. 

  854. </DD>

    855. 

  855. </DL>

    856. 

  856. <HR>

    857. 

  857. 

    858. 

  858. <A NAME="setSpeechRate(float)"><!-- --></A><H3>

    859. 

  859. setSpeechRate</H3>

    860. 

  860. <PRE>

    861. 

  861. public int <B>setSpeechRate</B>(float&nbsp;speechRate)</PRE>

    862. 

  862. <DL>

    863. 

  863. <DD>Sets the speech rate for the TextToSpeech engine.
    864. 

  864.  
    865. 

  865.  This has no effect on any pre-recorded speech.

    866. 

  866. <P>

    867. 

  867. <DD><DL>

    868. 

  868. <DT><B>Parameters:</B><DD><CODE>speechRate</CODE> - The speech rate for the TextToSpeech engine. 1 is the
    869. 

  869.         normal speed, lower values slow down the speech (0.5 is half the
    870. 

  870.         normal speech rate), greater values accelerate it (2 is twice the
    871. 

  871.         normal speech rate).

    872. 

  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. 

  873.          <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>

    874. 

  874. </DD>

    875. 

  875. </DL>

    876. 

  876. <HR>

    877. 

  877. 

    878. 

  878. <A NAME="setPitch(float)"><!-- --></A><H3>

    879. 

  879. setPitch</H3>

    880. 

  880. <PRE>

    881. 

  881. public int <B>setPitch</B>(float&nbsp;pitch)</PRE>

    882. 

  882. <DL>

    883. 

  883. <DD>Sets the speech pitch for the TextToSpeech engine.
    884. 

  884.  
    885. 

  885.  This has no effect on any pre-recorded speech.

    886. 

  886. <P>

    887. 

  887. <DD><DL>

    888. 

  888. <DT><B>Parameters:</B><DD><CODE>pitch</CODE> - The pitch for the TextToSpeech engine. 1 is the normal pitch,
    889. 

  889.         lower values lower the tone of the synthesized voice, greater values
    890. 

  890.         increase it.

    891. 

  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. 

  892.          <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>

    893. 

  893. </DD>

    894. 

  894. </DL>

    895. 

  895. <HR>

    896. 

  896. 

    897. 

  897. <A NAME="setLanguage(java.util.Locale)"><!-- --></A><H3>

    898. 

  898. setLanguage</H3>

    899. 

  899. <PRE>

    900. 

  900. public int <B>setLanguage</B>(java.util.Locale&nbsp;loc)</PRE>

    901. 

  901. <DL>

    902. 

  902. <DD>Sets the language for the TextToSpeech engine. The TextToSpeech engine will
    903. 

  903.  try to use the closest match to the specified language as represented by
    904. 

  904.  the Locale, but there is no guarantee that the exact same Locale will be
    905. 

  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. 

  906.  support before choosing the language to use for the next utterances.

    907. 

  907. <P>

    908. 

  908. <DD><DL>

    909. 

  909. <DT><B>Parameters:</B><DD><CODE>loc</CODE> - The locale describing the language to be used.

    910. 

  910. <DT><B>Returns:</B><DD>code indicating the support status for the locale. See
    911. 

  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. 

  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. 

  913.          <A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_NOT_SUPPORTED"><CODE>LANG_NOT_SUPPORTED</CODE></A>.</DL>

    914. 

  914. </DD>

    915. 

  915. </DL>

    916. 

  916. <HR>

    917. 

  917. 

    918. 

  918. <A NAME="getLanguage()"><!-- --></A><H3>

    919. 

  919. getLanguage</H3>

    920. 

  920. <PRE>

    921. 

  921. public java.util.Locale <B>getLanguage</B>()</PRE>

    922. 

  922. <DL>

    923. 

  923. <DD>Returns a Locale instance describing the language currently being used by
    924. 

  924.  the TextToSpeech engine.

    925. 

  925. <P>

    926. 

  926. <DD><DL>

    927. 

  927. 

    928. 

  928. <DT><B>Returns:</B><DD>language, country (if any) and variant (if any) used by the engine
    929. 

  929.          stored in a Locale instance, or null is the TextToSpeech engine has
    930. 

  930.          failed.</DL>

    931. 

  931. </DD>

    932. 

  932. </DL>

    933. 

  933. <HR>

    934. 

  934. 

    935. 

  935. <A NAME="isLanguageAvailable(java.util.Locale)"><!-- --></A><H3>

    936. 

  936. isLanguageAvailable</H3>

    937. 

  937. <PRE>

    938. 

  938. public int <B>isLanguageAvailable</B>(java.util.Locale&nbsp;loc)</PRE>

    939. 

  939. <DL>

    940. 

  940. <DD>Checks if the specified language as represented by the Locale is available
    941. 

  941.  and supported.

    942. 

  942. <P>

    943. 

  943. <DD><DL>

    944. 

  944. <DT><B>Parameters:</B><DD><CODE>loc</CODE> - The Locale describing the language to be used.

    945. 

  945. <DT><B>Returns:</B><DD>code indicating the support status for the locale. See
    946. 

  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. 

  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. 

  948.          <A HREF="../../../com/google/tts/TextToSpeechBeta.html#LANG_NOT_SUPPORTED"><CODE>LANG_NOT_SUPPORTED</CODE></A>.</DL>

    949. 

  949. </DD>

    950. 

  950. </DL>

    951. 

  951. <HR>

    952. 

  952. 

    953. 

  953. <A NAME="synthesizeToFile(java.lang.String, java.util.HashMap, java.lang.String)"><!-- --></A><H3>

    954. 

  954. synthesizeToFile</H3>

    955. 

  955. <PRE>

    956. 

  956. public int <B>synthesizeToFile</B>(java.lang.String&nbsp;text,

    957. 

  957.                             java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;params,

    958. 

  958.                             java.lang.String&nbsp;filename)</PRE>

    959. 

  959. <DL>

    960. 

  960. <DD>Synthesizes the given text to a file using the specified parameters.

    961. 

  961. <P>

    962. 

  962. <DD><DL>

    963. 

  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. 

  964.         parameters are given. They are specified using a (key, value) pair,
    965. 

  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. 

  966.         be something like "/sdcard/myappsounds/mysound.wav".

    967. 

  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. 

  968.          <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>

    969. 

  969. </DD>

    970. 

  970. </DL>

    971. 

  971. <HR>

    972. 

  972. 

    973. 

  973. <A NAME="setOnUtteranceCompletedListener(com.google.tts.TextToSpeechBeta.OnUtteranceCompletedListener)"><!-- --></A><H3>

    974. 

  974. setOnUtteranceCompletedListener</H3>

    975. 

  975. <PRE>

    976. 

  976. public 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. 

  977. <DL>

    978. 

  978. <DD>Sets the OnUtteranceCompletedListener that will fire when an utterance
    979. 

  979.  completes.

    980. 

  980. <P>

    981. 

  981. <DD><DL>

    982. 

  982. <DT><B>Parameters:</B><DD><CODE>listener</CODE> - The OnUtteranceCompletedListener

    983. 

  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. 

  984.          <A HREF="../../../com/google/tts/TextToSpeechBeta.html#SUCCESS"><CODE>SUCCESS</CODE></A>.</DL>

    985. 

  985. </DD>

    986. 

  986. </DL>

    987. 

  987. <HR>

    988. 

  988. 

    989. 

  989. <A NAME="isInstalled(Context)"><!-- --></A><H3>

    990. 

  990. isInstalled</H3>

    991. 

  991. <PRE>

    992. 

  992. public static boolean <B>isInstalled</B>(Context&nbsp;ctx)</PRE>

    993. 

  993. <DL>

    994. 

  994. <DD>Standalone TTS ONLY!
    995. 

  995.  
    996. 

  996.  Checks if the TTS service is installed or not

    997. 

  997. <P>

    998. 

  998. <DD><DL>

    999. 

  999. 

    1000. 

  1000. <DT><B>Returns:</B><DD>A boolean that indicates whether the TTS service is installed</DL>

    1001. 

  1001. </DD>

    1002. 

  1002. </DL>

    1003. 

  1003. <!-- ========= END OF CLASS DATA ========= -->

    1004. 

  1004. <HR>

    1005. 

  1005. 

    1006. 

  1006. 

    1007. 

  1007. <!-- ======= START OF BOTTOM NAVBAR ====== -->

    1008. 

  1008. <A NAME="navbar_bottom"><!-- --></A>

    1009. 

  1009. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>

    1010. 

  1010. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">

    1011. 

  1011. <TR>

    1012. 

  1012. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">

    1013. 

  1013. <A NAME="navbar_bottom_firstrow"><!-- --></A>

    1014. 

  1014. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">

    1015. 

  1015.   <TR ALIGN="center" VALIGN="top">

    1016. 

  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. 

  1017.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>

    1018. 

  1018.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>

    1019. 

  1019.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>

    1020. 

  1020.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>

    1021. 

  1021.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>

    1022. 

  1022.   </TR>

    1023. 

  1023. </TABLE>

    1024. 

  1024. </TD>

    1025. 

  1025. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>

    1026. 

  1026. </EM>

    1027. 

  1027. </TD>

    1028. 

  1028. </TR>

    1029. 

  1029. 

    1030. 

  1030. <TR>

    1031. 

  1031. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">

    1032. 

  1032. &nbsp;PREV CLASS&nbsp;

    1033. 

  1033. &nbsp;<A HREF="../../../com/google/tts/TextToSpeechBeta.Engine.html" title="class in com.google.tts"><B>NEXT CLASS</B></A></FONT></TD>

    1034. 

  1034. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">

    1035. 

  1035.   <A HREF="../../../index.html?com/google/tts/TextToSpeechBeta.html" target="_top"><B>FRAMES</B></A>  &nbsp;

    1036. 

  1036. &nbsp;<A HREF="TextToSpeechBeta.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;

    1037. 

  1037. &nbsp;<SCRIPT type="text/javascript">

    1038. 

  1038.   <!--

    1039. 

  1039.   if(window==top) {

    1040. 

  1040.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');

    1041. 

  1041.   }

    1042. 

  1042.   //-->

    1043. 

  1043. </SCRIPT>

    1044. 

  1044. <NOSCRIPT>

    1045. 

  1045.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>

    1046. 

  1046. </NOSCRIPT>

    1047. 

  1047. 

    1048. 

  1048. 

    1049. 

  1049. </FONT></TD>

    1050. 

  1050. </TR>

    1051. 

  1051. <TR>

    1052. 

  1052. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">

    1053. 

  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. 

  1054. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">

    1055. 

  1055. DETAIL:&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. 

  1056. </TR>

    1057. 

  1057. </TABLE>

    1058. 

  1058. <A NAME="skip-navbar_bottom"></A>

    1059. 

  1059. <!-- ======== END OF BOTTOM NAVBAR ======= -->

    1060. 

  1060. 

    1061. 

  1061. <HR>

    1062. 

  1062. 

    1063. 

  1063. </BODY>

    1064. 

  1064. </HTML>
    1065.