git.gag.com Git - debian/freetts/blob - javadoc/com/sun/speech/freetts/VoiceDirectory.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:29 CET 2009 -->\r
   6 <TITLE>\r
   7 VoiceDirectory (FreeTTS 1.2)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.VoiceDirectory 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="VoiceDirectory (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;<A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
  53 &nbsp;<A HREF="../../../../com/sun/speech/freetts/VoiceManager.html" title="class in com.sun.speech.freetts"><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="VoiceDirectory.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</FONT>\r
  85 <BR>\r
  86 Class VoiceDirectory</H2>\r
  87 <PRE>\r
  88 java.lang.Object\r
  89   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.VoiceDirectory</B>\r
  90 </PRE>\r
  91 <DL>\r
  92 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../de/dfki/lt/freetts/en/us/MbrolaVoiceDirectory.html" title="class in de.dfki.lt.freetts.en.us">MbrolaVoiceDirectory</A></DD>\r
  93 </DL>\r
  94 <HR>\r
  95 <DL>\r
  96 <DT>public abstract class <B>VoiceDirectory</B><DT>extends java.lang.Object</DL>\r
  97 \r
  98 <P>\r
  99 Provides a means to access the voices that are stored in a jar
 100  file.  Every jar file that provides a voice must contain a subclass
 101  of VoiceDirectory.  The class must provide a main() function that
 102  calls dumpVoices() or performs an equivalent operation.  All
 103  subclasses of VoiceDirectory can be assumed to always be created by
 104  the default constructor (no arguments).
 105
 106  Any jar file that has a subclass of VoiceDirectory must define
 107  certain attributes in its Manifest.  "Main-class:" must refer to
 108  the subclass of VoiceDirectory. "Class-Path:" lists the other jar
 109  files upon which this is dependent.  For example,
 110  "cmu_us_kal.jar" may be dependent on "en_us.jar" for its lexicon.
 111  The Manifest must also have a "FreeTTSVoiceDefinition: true" entry.\r
 112 <P>\r
 113 \r
 114 <P>\r
 115 <DL>\r
 116 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts"><CODE>Voice</CODE></A>,
 117 <A HREF="../../../../com/sun/speech/freetts/VoiceManager.html" title="class in com.sun.speech.freetts"><CODE>VoiceManager</CODE></A></DL>\r
 118 <HR>\r
 119 \r
 120 <P>\r
 121 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
 122 \r
 123 \r
 124 <!-- =========== FIELD SUMMARY =========== -->\r
 125 \r
 126 \r
 127 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 128 \r
 129 <A NAME="constructor_summary"><!-- --></A>
 130 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 131 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 132 <TD COLSPAN=2><FONT SIZE="+2">\r
 133 <B>Constructor Summary</B></FONT></TD>\r
 134 </TR>\r
 135 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 136 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html#VoiceDirectory()">VoiceDirectory</A></B>()</CODE>\r
 137 \r
 138 <BR>\r
 139 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default constructor does nothing.  </TD>\r
 140 </TR>\r
 141 </TABLE>\r
 142 &nbsp;\r
 143 <!-- ========== METHOD SUMMARY =========== -->\r
 144 \r
 145 <A NAME="method_summary"><!-- --></A>
 146 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 147 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 148 <TD COLSPAN=2><FONT SIZE="+2">\r
 149 <B>Method Summary</B></FONT></TD>\r
 150 </TR>\r
 151 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 153 <CODE>abstract &nbsp;<A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A>[]</CODE></FONT></TD>\r
 154 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html#getVoices()">getVoices</A></B>()</CODE>\r
 155 \r
 156 <BR>\r
 157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Provide a means to access the voices in a voice jar file.  </TD>\r
 158 </TR>\r
 159 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 161 <CODE>static&nbsp;void</CODE></FONT></TD>\r
 162 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>\r
 163 \r
 164 <BR>\r
 165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The main function must be implemented by subclasses to print
 166  out information about provided voices.  </TD>\r
 167 </TR>\r
 168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 170 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 171 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html#toString()">toString</A></B>()</CODE>\r
 172 \r
 173 <BR>\r
 174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Print the information about voices contained in this voice
 175  directory to a String.</TD>\r
 176 </TR>\r
 177 </TABLE>\r
 178 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 179 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 180 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 181 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
 182 </TR>\r
 183 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 184 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>\r
 185 </TR>\r
 186 </TABLE>\r
 187 &nbsp;\r
 188 <P>\r
 189 \r
 190 <!-- ============ FIELD DETAIL =========== -->\r
 191 \r
 192 \r
 193 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 194 \r
 195 <A NAME="constructor_detail"><!-- --></A>
 196 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 197 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 198 <TD COLSPAN=1><FONT SIZE="+2">\r
 199 <B>Constructor Detail</B></FONT></TD>\r
 200 </TR>\r
 201 </TABLE>\r
 202 \r
 203 <A NAME="VoiceDirectory()"><!-- --></A><H3>\r
 204 VoiceDirectory</H3>\r
 205 <PRE>\r
 206 public <B>VoiceDirectory</B>()</PRE>\r
 207 <DL>\r
 208 <DD>Default constructor does nothing.  This may be overridden by
 209  subclasses, but it is not recommended.  This is the only
 210  constructor that will be called.\r
 211 <P>\r
 212 </DL>\r
 213 \r
 214 <!-- ============ METHOD DETAIL ========== -->\r
 215 \r
 216 <A NAME="method_detail"><!-- --></A>
 217 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 218 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 219 <TD COLSPAN=1><FONT SIZE="+2">\r
 220 <B>Method Detail</B></FONT></TD>\r
 221 </TR>\r
 222 </TABLE>\r
 223 \r
 224 <A NAME="getVoices()"><!-- --></A><H3>\r
 225 getVoices</H3>\r
 226 <PRE>\r
 227 public abstract <A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A>[] <B>getVoices</B>()</PRE>\r
 228 <DL>\r
 229 <DD>Provide a means to access the voices in a voice jar file.  The
 230  implementation of this function is up to the subclasses.\r
 231 <P>\r
 232 <DD><DL>\r
 233
 234 <DT><B>Returns:</B><DD>an array of Voice instances provided in the jar file</DL>\r
 235 </DD>\r
 236 </DL>\r
 237 <HR>\r
 238 \r
 239 <A NAME="toString()"><!-- --></A><H3>\r
 240 toString</H3>\r
 241 <PRE>\r
 242 public java.lang.String <B>toString</B>()</PRE>\r
 243 <DL>\r
 244 <DD>Print the information about voices contained in this voice
 245  directory to a String.\r
 246 <P>\r
 247 <DD><DL>\r
 248
 249 <DT><B>Returns:</B><DD>a String containing the information<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html#main(java.lang.String[])"><CODE>main(String[] args)</CODE></A></DL>\r
 250 </DD>\r
 251 </DL>\r
 252 <HR>\r
 253 \r
 254 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
 255 main</H3>\r
 256 <PRE>\r
 257 public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>\r
 258 <DL>\r
 259 <DD>The main function must be implemented by subclasses to print
 260  out information about provided voices.  For example, they may
 261  just call dumpVoices()\r
 262 <P>\r
 263 <DD><DL>\r
 264 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html#toString()"><CODE>toString()</CODE></A></DL>\r
 265 </DD>\r
 266 </DL>\r
 267 <!-- ========= END OF CLASS DATA ========= -->\r
 268 <HR>\r
 269 \r
 270
 271 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 272 <A NAME="navbar_bottom"><!-- --></A>
 273 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 274 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 275 <TR>\r
 276 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 277 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 278 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 279   <TR ALIGN="center" VALIGN="top">\r
 280   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 281   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 282   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 283   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 284   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 285   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 286   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 287   </TR>\r
 288 </TABLE>\r
 289 </TD>\r
 290 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 291 </EM>\r
 292 </TD>\r
 293 </TR>\r
 294 \r
 295 <TR>\r
 296 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 297 &nbsp;<A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
 298 &nbsp;<A HREF="../../../../com/sun/speech/freetts/VoiceManager.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>\r
 299 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 300   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 301 &nbsp;<A HREF="VoiceDirectory.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 302 &nbsp;<SCRIPT type="text/javascript">\r
 303   <!--\r
 304   if(window==top) {\r
 305     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 306   }\r
 307   //-->\r
 308 </SCRIPT>\r
 309 <NOSCRIPT>\r
 310   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 311 </NOSCRIPT>
 312 \r
 313 </FONT></TD>\r
 314 </TR>\r
 315 <TR>\r
 316 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 317   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
 318 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 319 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 320 </TR>\r
 321 </TABLE>\r
 322 <A NAME="skip-navbar_bottom"></A>
 323 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 324 \r
 325 <HR>\r
 326 \r
 327 </BODY>\r
 328 </HTML>\r