git.gag.com Git - debian/freetts/blob - javadoc/com/sun/speech/freetts/jsapi/FreeTTSEngineCentral.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!--NewPage-->\r
   3 <HTML>\r
   4 <HEAD>\r
   5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:30 CET 2009 -->\r
   6 <TITLE>\r
   7 FreeTTSEngineCentral (FreeTTS 1.2)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.jsapi.FreeTTSEngineCentral class">\r
  11 \r
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">\r
  13 \r
  14 <SCRIPT type="text/javascript">\r
  15 function windowTitle()\r
  16 {\r
  17     parent.document.title="FreeTTSEngineCentral (FreeTTS 1.2)";\r
  18 }\r
  19 </SCRIPT>\r
  20 \r
  21 </HEAD>\r
  22 \r
  23 <BODY BGCOLOR="white" onload="windowTitle();">\r
  24 \r
  25
  26 <!-- ========= START OF TOP NAVBAR ======= -->\r
  27 <A NAME="navbar_top"><!-- --></A>
  28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
  30 <TR>\r
  31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
  32 <A NAME="navbar_top_firstrow"><!-- --></A>
  33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
  34   <TR ALIGN="center" VALIGN="top">\r
  35   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
  36   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
  37   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
  39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
  42   </TR>\r
  43 </TABLE>\r
  44 </TD>\r
  45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
  46 </EM>\r
  47 </TD>\r
  48 </TR>\r
  49 \r
  50 <TR>\r
  51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  52 &nbsp;PREV CLASS&nbsp;\r
  53 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html" title="class in com.sun.speech.freetts.jsapi"><B>NEXT CLASS</B></A></FONT></TD>\r
  54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  55   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  56 &nbsp;<A HREF="FreeTTSEngineCentral.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  57 &nbsp;<SCRIPT type="text/javascript">\r
  58   <!--\r
  59   if(window==top) {\r
  60     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  61   }\r
  62   //-->\r
  63 </SCRIPT>\r
  64 <NOSCRIPT>\r
  65   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
  66 </NOSCRIPT>
  67 \r
  68 </FONT></TD>\r
  69 </TR>\r
  70 <TR>\r
  71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  72   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  74 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  75 </TR>\r
  76 </TABLE>\r
  77 <A NAME="skip-navbar_top"></A>
  78 <!-- ========= END OF TOP NAVBAR ========= -->\r
  79 \r
  80 <HR>\r
  81 <!-- ======== START OF CLASS DATA ======== -->\r
  82 <H2>\r
  83 <FONT SIZE="-1">\r
  84 com.sun.speech.freetts.jsapi</FONT>\r
  85 <BR>\r
  86 Class FreeTTSEngineCentral</H2>\r
  87 <PRE>\r
  88 java.lang.Object\r
  89   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.jsapi.FreeTTSEngineCentral</B>\r
  90 </PRE>\r
  91 <DL>\r
  92 <DT><B>All Implemented Interfaces:</B> <DD>javax.speech.EngineCentral</DD>\r
  93 </DL>\r
  94 <HR>\r
  95 <DL>\r
  96 <DT>public class <B>FreeTTSEngineCentral</B><DT>extends java.lang.Object<DT>implements javax.speech.EngineCentral</DL>\r
  97 \r
  98 <P>\r
  99 Supports the EngineCentral JSAPI 1.0 interface for the
 100  FreeTTSSynthesizer.  To use a FreeTTSSynthesizer, you should place
 101  a line into the speech.properties file as so:
 102
 103  <pre>
 104  FreeTTSSynthEngineCentral=com.sun.speech.freetts.jsapi.FreeTTSEngineCentral
 105  </pre>\r
 106 <P>\r
 107 \r
 108 <P>\r
 109 <HR>\r
 110 \r
 111 <P>\r
 112 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
 113 \r
 114 \r
 115 <!-- =========== FIELD SUMMARY =========== -->\r
 116 \r
 117 \r
 118 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 119 \r
 120 <A NAME="constructor_summary"><!-- --></A>
 121 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 122 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 123 <TD COLSPAN=2><FONT SIZE="+2">\r
 124 <B>Constructor Summary</B></FONT></TD>\r
 125 </TR>\r
 126 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 127 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSEngineCentral.html#FreeTTSEngineCentral()">FreeTTSEngineCentral</A></B>()</CODE>\r
 128 \r
 129 <BR>\r
 130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a FreeTTSEngineCentral</TD>\r
 131 </TR>\r
 132 </TABLE>\r
 133 &nbsp;\r
 134 <!-- ========== METHOD SUMMARY =========== -->\r
 135 \r
 136 <A NAME="method_summary"><!-- --></A>
 137 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 138 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 139 <TD COLSPAN=2><FONT SIZE="+2">\r
 140 <B>Method Summary</B></FONT></TD>\r
 141 </TR>\r
 142 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 144 <CODE>&nbsp;javax.speech.EngineList</CODE></FONT></TD>\r
 145 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSEngineCentral.html#createEngineList(javax.speech.EngineModeDesc)">createEngineList</A></B>(javax.speech.EngineModeDesc&nbsp;require)</CODE>\r
 146 \r
 147 <BR>\r
 148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list containing references to all matching
 149  synthesizers.  </TD>\r
 150 </TR>\r
 151 </TABLE>\r
 152 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 153 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 154 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 155 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
 156 </TR>\r
 157 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 158 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
 159 </TR>\r
 160 </TABLE>\r
 161 &nbsp;\r
 162 <P>\r
 163 \r
 164 <!-- ============ FIELD DETAIL =========== -->\r
 165 \r
 166 \r
 167 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 168 \r
 169 <A NAME="constructor_detail"><!-- --></A>
 170 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 171 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 172 <TD COLSPAN=1><FONT SIZE="+2">\r
 173 <B>Constructor Detail</B></FONT></TD>\r
 174 </TR>\r
 175 </TABLE>\r
 176 \r
 177 <A NAME="FreeTTSEngineCentral()"><!-- --></A><H3>\r
 178 FreeTTSEngineCentral</H3>\r
 179 <PRE>\r
 180 public <B>FreeTTSEngineCentral</B>()
 181                      throws java.lang.Exception</PRE>\r
 182 <DL>\r
 183 <DD>Creates a FreeTTSEngineCentral\r
 184 <P>\r
 185 </DL>\r
 186 \r
 187 <!-- ============ METHOD DETAIL ========== -->\r
 188 \r
 189 <A NAME="method_detail"><!-- --></A>
 190 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 191 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 192 <TD COLSPAN=1><FONT SIZE="+2">\r
 193 <B>Method Detail</B></FONT></TD>\r
 194 </TR>\r
 195 </TABLE>\r
 196 \r
 197 <A NAME="createEngineList(javax.speech.EngineModeDesc)"><!-- --></A><H3>\r
 198 createEngineList</H3>\r
 199 <PRE>\r
 200 public javax.speech.EngineList <B>createEngineList</B>(javax.speech.EngineModeDesc&nbsp;require)</PRE>\r
 201 <DL>\r
 202 <DD>Returns a list containing references to all matching
 203  synthesizers.  The mapping of FreeTTS VoiceDirectories and
 204  Voices to JSAPI Synthesizers and Voices is as follows:
 205
 206  <p><ul>
 207  <li>Each FreeTTS VoiceDirectory specifies the list of FreeTTS
 208  Voices supported by that directory.  Each Voice in that
 209  directory specifies its name (e.g., "kevin" "kevin16" "alan"),
 210  domain (e.g., "general" or "time") and locale (e.g., Locale.US).
 211  <li>For all FreeTTS Voices from all VoiceDirectories discovered
 212  by the VoiceManager, this method will group the Voices
 213  according to those that have both a common locale and domain
 214  (e.g, all "general" domain voices for the US local will be
 215  grouped together).
 216  <li>For each group of voices that shares a common locale and
 217  domain, this method generates a new JSAPI SynthesizerModeDesc
 218  with the following attributes:
 219    <ul>
 220    <li>The engine name is of the form: "FreeTTS &lt;locale>
 221    &lt;domain> synthesizer"  For example, "FreeTTS en_us general
 222    synthesizer"
 223    <li>The locale is the locale shared by all the voices (e.g.,
 224    Locale.US)
 225    <li>The mode name is the domain shared by all the voices
 226    (e.g., "general").
 227    </ul>
 228  <li>The JSAPI Voices for each resulting Synthesizer will have
 229  the name of the FreeTTS Voice (e.g. "kevin" "kevin16").
 230  </ul>\r
 231 <P>\r
 232 <DD><DL>\r
 233 <DT><B>Specified by:</B><DD><CODE>createEngineList</CODE> in interface <CODE>javax.speech.EngineCentral</CODE></DL>\r
 234 </DD>\r
 235 <DD><DL>\r
 236 <DT><B>Parameters:</B><DD><CODE>require</CODE> - an engine mode that describes the desired
 237                         synthesizer
 238 <DT><B>Returns:</B><DD>an engineList containing matching engines, or null if
 239                 no matching engines are found</DL>\r
 240 </DD>\r
 241 </DL>\r
 242 <!-- ========= END OF CLASS DATA ========= -->\r
 243 <HR>\r
 244 \r
 245
 246 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 247 <A NAME="navbar_bottom"><!-- --></A>
 248 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 249 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 250 <TR>\r
 251 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 252 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 253 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 254   <TR ALIGN="center" VALIGN="top">\r
 255   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 256   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 257   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 258   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 259   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 260   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 261   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 262   </TR>\r
 263 </TABLE>\r
 264 </TD>\r
 265 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 266 </EM>\r
 267 </TD>\r
 268 </TR>\r
 269 \r
 270 <TR>\r
 271 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 272 &nbsp;PREV CLASS&nbsp;\r
 273 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html" title="class in com.sun.speech.freetts.jsapi"><B>NEXT CLASS</B></A></FONT></TD>\r
 274 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 275   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 276 &nbsp;<A HREF="FreeTTSEngineCentral.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 277 &nbsp;<SCRIPT type="text/javascript">\r
 278   <!--\r
 279   if(window==top) {\r
 280     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 281   }\r
 282   //-->\r
 283 </SCRIPT>\r
 284 <NOSCRIPT>\r
 285   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 286 </NOSCRIPT>
 287 \r
 288 </FONT></TD>\r
 289 </TR>\r
 290 <TR>\r
 291 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 292   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 293 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 294 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 295 </TR>\r
 296 </TABLE>\r
 297 <A NAME="skip-navbar_bottom"></A>
 298 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 299 \r
 300 <HR>\r
 301 \r
 302 </BODY>\r
 303 </HTML>\r