TTSEngine.html - This HTML code outputs a detailed document…

/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

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<!--NewPage-->

<HTML>

<HEAD>

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

<TITLE>

TTSEngine

</TITLE>



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



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



<SCRIPT type="text/javascript">

function windowTitle()

{

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

        parent.document.title="TTSEngine";

    }

}

</SCRIPT>

<NOSCRIPT>

</NOSCRIPT>



</HEAD>



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

<HR>





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

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

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

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

<TR>

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

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

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

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

  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../com/google/tts/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>

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

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

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

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

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

  </TR>

</TABLE>

</TD>

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

</EM>

</TD>

</TR>



<TR>

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

&nbsp;<A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts"><B>PREV CLASS</B></A>&nbsp;

&nbsp;<A HREF="../../../com/google/tts/TTSParams.html" title="enum in com.google.tts"><B>NEXT CLASS</B></A></FONT></TD>

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

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

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

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

  <!--

  if(window==top) {

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

  }

  //-->

</SCRIPT>

<NOSCRIPT>

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

</NOSCRIPT>





</FONT></TD>

</TR>

<TR>

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

  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>

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

DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>

</TR>

</TABLE>

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

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



<HR>

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

<H2>

<FONT SIZE="-1">

com.google.tts</FONT>

<BR>

Enum TTSEngine</H2>

<PRE>

java.lang.Object

  <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;

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

</PRE>

<DL>

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

</DL>

<HR>

<DL>

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

</PRE>



<P>

Enumerates the possible TTS engines to pass to the TTS.

<P>



<P>

<HR>



<P>

<!-- =========== ENUM CONSTANT SUMMARY =========== -->



<A NAME="enum_constant_summary"><!-- --></A>

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

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

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

<B>Enum Constant Summary</B></FONT></TH>

</TR>

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

<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#ESPEAK">ESPEAK</A></B></CODE>



<BR>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>

</TR>

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

<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#PICO">PICO</A></B></CODE>



<BR>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>

</TR>

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

<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#PRERECORDED_ONLY">PRERECORDED_ONLY</A></B></CODE>



<BR>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>

</TR>

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

<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#PRERECORDED_WITH_TTS">PRERECORDED_WITH_TTS</A></B></CODE>



<BR>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>

</TR>

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

<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#TTS_ONLY">TTS_ONLY</A></B></CODE>



<BR>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>

</TR>

</TABLE>

&nbsp;

<!-- ========== METHOD SUMMARY =========== -->



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

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

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

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

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

</TR>

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

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

<CODE>static&nbsp;<A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A></CODE></FONT></TD>

<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#valueOf(java.lang.String)">valueOf</A></B>(java.lang.String&nbsp;name)</CODE>



<BR>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the enum constant of this type with the specified name.</TD>

</TR>

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

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

<CODE>static&nbsp;<A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A>[]</CODE></FONT></TD>

<TD><CODE><B><A HREF="../../../com/google/tts/TTSEngine.html#values()">values</A></B>()</CODE>



<BR>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing the constants of this enum type, in
the order they are declared.</TD>

</TR>

</TABLE>

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

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

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

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

</TR>

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

<TD><CODE>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</CODE></TD>

</TR>

</TABLE>

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

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

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

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

</TR>

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

<TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD>

</TR>

</TABLE>

&nbsp;

<P>



<!-- ============ ENUM CONSTANT DETAIL =========== -->



<A NAME="enum_constant_detail"><!-- --></A>

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

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

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

<B>Enum Constant Detail</B></FONT></TH>

</TR>

</TABLE>



<A NAME="PRERECORDED_ONLY"><!-- --></A><H3>

PRERECORDED_ONLY</H3>

<PRE>

public static final <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> <B>PRERECORDED_ONLY</B></PRE>

<DL>

<DL>

</DL>

</DL>

<HR>



<A NAME="PRERECORDED_WITH_TTS"><!-- --></A><H3>

PRERECORDED_WITH_TTS</H3>

<PRE>

public static final <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> <B>PRERECORDED_WITH_TTS</B></PRE>

<DL>

<DL>

</DL>

</DL>

<HR>



<A NAME="TTS_ONLY"><!-- --></A><H3>

TTS_ONLY</H3>

<PRE>

public static final <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> <B>TTS_ONLY</B></PRE>

<DL>

<DL>

</DL>

</DL>

<HR>



<A NAME="ESPEAK"><!-- --></A><H3>

ESPEAK</H3>

<PRE>

public static final <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> <B>ESPEAK</B></PRE>

<DL>

<DL>

</DL>

</DL>

<HR>



<A NAME="PICO"><!-- --></A><H3>

PICO</H3>

<PRE>

public static final <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> <B>PICO</B></PRE>

<DL>

<DL>

</DL>

</DL>



<!-- ============ METHOD DETAIL ========== -->



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

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

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

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

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

</TR>

</TABLE>



<A NAME="values()"><!-- --></A><H3>

values</H3>

<PRE>

public static <A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A>[] <B>values</B>()</PRE>

<DL>

<DD>Returns an array containing the constants of this enum type, in
the order they are declared.  This method may be used to iterate
over the constants as follows:
<pre>
for (TTSEngine c : TTSEngine.values())
&nbsp;   System.out.println(c);
</pre>

<P>

<DD><DL>



<DT><B>Returns:</B><DD>an array containing the constants of this enum type, in
the order they are declared</DL>

</DD>

</DL>

<HR>



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

valueOf</H3>

<PRE>

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

<DL>

<DD>Returns the enum constant of this type with the specified name.
The string must match <I>exactly</I> an identifier used to declare an
enum constant in this type.  (Extraneous whitespace characters are 
not permitted.)

<P>

<DD><DL>

<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned.

<DT><B>Returns:</B><DD>the enum constant with the specified name

<DT><B>Throws:</B>

<DD><CODE>java.lang.IllegalArgumentException</CODE> - if this enum type has no constant
with the specified name

<DD><CODE>java.lang.NullPointerException</CODE> - if the argument is null</DL>

</DD>

</DL>

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

<HR>





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

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

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

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

<TR>

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

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

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

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

  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../com/google/tts/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>

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

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

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

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

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

  </TR>

</TABLE>

</TD>

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

</EM>

</TD>

</TR>



<TR>

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

&nbsp;<A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts"><B>PREV CLASS</B></A>&nbsp;

&nbsp;<A HREF="../../../com/google/tts/TTSParams.html" title="enum in com.google.tts"><B>NEXT CLASS</B></A></FONT></TD>

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

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

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

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

  <!--

  if(window==top) {

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

  }

  //-->

</SCRIPT>

<NOSCRIPT>

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

</NOSCRIPT>





</FONT></TD>

</TR>

<TR>

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

  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>

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

DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>

</TR>

</TABLE>

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

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



<HR>



</BODY>

</HTML>
Summary ✨

This HTML code outputs a detailed documentation page for a Java class, TTSEngine. It displays information about the class, including its package, fields, methods, and constants. The page includes navigation links to related classes, methods, and constants, as well as a summary of the class’s contents.
Alerts (28)

'onload=' Inline event handler detected; use addEventListener in external JS for separation of concerns
27
'<FONT' Deprecated HTML tag detected; use CSS for styling instead
40 41 42 43 44 45 55 58 76 78 88 118 158 162 170 205 264 322 323 324 325 326 327 337 340 358 360