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