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

/documentation/tts/com/google/tts/TTSEngine.html

http://eyes-free.googlecode.com/
HTML | 370 lines | 306 code | 42 blank | 22 comment | 0 complexity | c154de83a4efd1369ba367bfccdbb6de 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>
  7TTSEngine
  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="TTSEngine";
 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;<A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts"><B>PREV CLASS</B></A>&nbsp;
 57&nbsp;<A HREF="../../../com/google/tts/TTSParams.html" title="enum 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/TTSEngine.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 60&nbsp;<A HREF="TTSEngine.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;NESTED&nbsp;|&nbsp;<A HREF="#enum_constant_summary">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 79DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&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>
 91Enum TTSEngine</H2>
 92<PRE>
 93java.lang.Object
 94  <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.lang.Enum&lt;<A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A>&gt;
 95      <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.google.tts.TTSEngine</B>
 96</PRE>
 97<DL>
 98<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Comparable&lt;<A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A>&gt;</DD>
 99</DL>
100<HR>
101<DL>
102<DT><PRE>public enum <B>TTSEngine</B><DT>extends java.lang.Enum&lt;<A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A>&gt;</DL>
103</PRE>
104
105<P>
106Enumerates the possible TTS engines to pass to the TTS.
107<P>
108
109<P>
110<HR>
111
112<P>
113<!-- =========== ENUM CONSTANT SUMMARY =========== -->
114
115<A NAME="enum_constant_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
119<B>Enum Constant Summary</B></FONT></TH>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#ESPEAK">ESPEAK</A></B></CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#PICO">PICO</A></B></CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#PRERECORDED_ONLY">PRERECORDED_ONLY</A></B></CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#PRERECORDED_WITH_TTS">PRERECORDED_WITH_TTS</A></B></CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#TTS_ONLY">TTS_ONLY</A></B></CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
150</TR>
151</TABLE>
152&nbsp;
153<!-- ========== METHOD SUMMARY =========== -->
154
155<A NAME="method_summary"><!-- --></A>
156<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
157<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
158<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
159<B>Method Summary</B></FONT></TH>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<CODE>static&nbsp;<A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A></CODE></FONT></TD>
164<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#valueOf(java.lang.String)">valueOf</A></B>(java.lang.String&nbsp;name)</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the enum constant of this type with the specified name.</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>static&nbsp;<A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A>[]</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#values()">values</A></B>()</CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing the constants of this enum type, in
176the order they are declared.</TD>
177</TR>
178</TABLE>
179&nbsp;<A NAME="methods_inherited_from_class_java.lang.Enum"><!-- --></A>
180<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
181<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
182<TH ALIGN="left"><B>Methods inherited from class java.lang.Enum</B></TH>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD><CODE>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</CODE></TD>
186</TR>
187</TABLE>
188&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
189<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
190<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
191<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
192</TR>
193<TR BGCOLOR="white" CLASS="TableRowColor">
194<TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
195</TR>
196</TABLE>
197&nbsp;
198<P>
199
200<!-- ============ ENUM CONSTANT DETAIL =========== -->
201
202<A NAME="enum_constant_detail"><!-- --></A>
203<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
204<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
205<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
206<B>Enum Constant Detail</B></FONT></TH>
207</TR>
208</TABLE>
209
210<A NAME="PRERECORDED_ONLY"><!-- --></A><H3>
211PRERECORDED_ONLY</H3>
212<PRE>
213public static final <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> <B>PRERECORDED_ONLY</B></PRE>
214<DL>
215<DL>
216</DL>
217</DL>
218<HR>
219
220<A NAME="PRERECORDED_WITH_TTS"><!-- --></A><H3>
221PRERECORDED_WITH_TTS</H3>
222<PRE>
223public static final <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> <B>PRERECORDED_WITH_TTS</B></PRE>
224<DL>
225<DL>
226</DL>
227</DL>
228<HR>
229
230<A NAME="TTS_ONLY"><!-- --></A><H3>
231TTS_ONLY</H3>
232<PRE>
233public static final <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> <B>TTS_ONLY</B></PRE>
234<DL>
235<DL>
236</DL>
237</DL>
238<HR>
239
240<A NAME="ESPEAK"><!-- --></A><H3>
241ESPEAK</H3>
242<PRE>
243public static final <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> <B>ESPEAK</B></PRE>
244<DL>
245<DL>
246</DL>
247</DL>
248<HR>
249
250<A NAME="PICO"><!-- --></A><H3>
251PICO</H3>
252<PRE>
253public static final <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> <B>PICO</B></PRE>
254<DL>
255<DL>
256</DL>
257</DL>
258
259<!-- ============ METHOD DETAIL ========== -->
260
261<A NAME="method_detail"><!-- --></A>
262<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
263<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
264<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
265<B>Method Detail</B></FONT></TH>
266</TR>
267</TABLE>
268
269<A NAME="values()"><!-- --></A><H3>
270values</H3>
271<PRE>
272public static <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A>[] <B>values</B>()</PRE>
273<DL>
274<DD>Returns an array containing the constants of this enum type, in
275the order they are declared.  This method may be used to iterate
276over the constants as follows:
277<pre>
278for (TTSEngine c : TTSEngine.values())
279&nbsp;   System.out.println(c);
280</pre>
281<P>
282<DD><DL>
283
284<DT><B>Returns:</B><DD>an array containing the constants of this enum type, in
285the order they are declared</DL>
286</DD>
287</DL>
288<HR>
289
290<A NAME="valueOf(java.lang.String)"><!-- --></A><H3>
291valueOf</H3>
292<PRE>
293public static <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> <B>valueOf</B>(java.lang.String&nbsp;name)</PRE>
294<DL>
295<DD>Returns the enum constant of this type with the specified name.
296The string must match <I>exactly</I> an identifier used to declare an
297enum constant in this type.  (Extraneous whitespace characters are 
298not permitted.)
299<P>
300<DD><DL>
301<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned.
302<DT><B>Returns:</B><DD>the enum constant with the specified name
303<DT><B>Throws:</B>
304<DD><CODE>java.lang.IllegalArgumentException</CODE> - if this enum type has no constant
305with the specified name
306<DD><CODE>java.lang.NullPointerException</CODE> - if the argument is null</DL>
307</DD>
308</DL>
309<!-- ========= END OF CLASS DATA ========= -->
310<HR>
311
312
313<!-- ======= START OF BOTTOM NAVBAR ====== -->
314<A NAME="navbar_bottom"><!-- --></A>
315<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
316<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
317<TR>
318<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
319<A NAME="navbar_bottom_firstrow"><!-- --></A>
320<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
321  <TR ALIGN="center" VALIGN="top">
322  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../com/google/tts/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
323  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
324  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
325  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
326  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
327  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
328  </TR>
329</TABLE>
330</TD>
331<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
332</EM>
333</TD>
334</TR>
335
336<TR>
337<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
338&nbsp;<A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts"><B>PREV CLASS</B></A>&nbsp;
339&nbsp;<A HREF="../../../com/google/tts/TTSParams.html" title="enum in com.google.tts"><B>NEXT CLASS</B></A></FONT></TD>
340<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
341  <A HREF="../../../index.html?com/google/tts/TTSEngine.html" target="_top"><B>FRAMES</B></A>  &nbsp;
342&nbsp;<A HREF="TTSEngine.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
343&nbsp;<SCRIPT type="text/javascript">
344  <!--
345  if(window==top) {
346    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
347  }
348  //-->
349</SCRIPT>
350<NOSCRIPT>
351  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
352</NOSCRIPT>
353
354
355</FONT></TD>
356</TR>
357<TR>
358<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
359  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#enum_constant_summary">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
360<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
361DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
362</TR>
363</TABLE>
364<A NAME="skip-navbar_bottom"></A>
365<!-- ======== END OF BOTTOM NAVBAR ======= -->
366
367<HR>
368
369</BODY>
370</HTML>