git.gag.com Git - debian/freetts/blob - javadoc/com/sun/speech/engine/synthesis/BaseVoice.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 BaseVoice (FreeTTS 1.2)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="com.sun.speech.engine.synthesis.BaseVoice 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="BaseVoice (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/engine/synthesis/BaseSynthesizerQueueItem.html" title="class in com.sun.speech.engine.synthesis"><B>PREV CLASS</B></A>&nbsp;\r
  53 &nbsp;<A HREF="../../../../../com/sun/speech/engine/synthesis/JSMLParser.html" title="class in com.sun.speech.engine.synthesis"><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="BaseVoice.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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.engine.synthesis</FONT>\r
  85 <BR>\r
  86 Class BaseVoice</H2>\r
  87 <PRE>\r
  88 java.lang.Object\r
  89   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by">javax.speech.synthesis.Voice\r
  90       <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.engine.synthesis.BaseVoice</B>\r
  91 </PRE>\r
  92 <DL>\r
  93 <DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable</DD>\r
  94 </DL>\r
  95 <DL>\r
  96 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSVoice.html" title="class in com.sun.speech.freetts.jsapi">FreeTTSVoice</A></DD>\r
  97 </DL>\r
  98 <HR>\r
  99 <DL>\r
 100 <DT>public class <B>BaseVoice</B><DT>extends javax.speech.synthesis.Voice</DL>\r
 101 \r
 102 <P>\r
 103 Extends the JSAPI 1.0 <code>Voice</code> class to encapsulate
 104  engine-specific data.\r
 105 <P>\r
 106 \r
 107 <P>\r
 108 <HR>\r
 109 \r
 110 <P>\r
 111 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
 112 \r
 113 \r
 114 <!-- =========== FIELD SUMMARY =========== -->\r
 115 \r
 116 <A NAME="field_summary"><!-- --></A>
 117 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 118 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 119 <TD COLSPAN=2><FONT SIZE="+2">\r
 120 <B>Field Summary</B></FONT></TD>\r
 121 </TR>\r
 122 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 123 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 124 <CODE>protected &nbsp;float</CODE></FONT></TD>\r
 125 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#defaultPitch">defaultPitch</A></B></CODE>\r
 126 \r
 127 <BR>\r
 128 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The default pitch</TD>\r
 129 </TR>\r
 130 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 131 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 132 <CODE>protected &nbsp;float</CODE></FONT></TD>\r
 133 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#defaultPitchRange">defaultPitchRange</A></B></CODE>\r
 134 \r
 135 <BR>\r
 136 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The default pitch range</TD>\r
 137 </TR>\r
 138 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 139 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 140 <CODE>protected &nbsp;float</CODE></FONT></TD>\r
 141 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#defaultSpeakingRate">defaultSpeakingRate</A></B></CODE>\r
 142 \r
 143 <BR>\r
 144 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The default speaking rate</TD>\r
 145 </TR>\r
 146 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 147 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 148 <CODE>protected &nbsp;float</CODE></FONT></TD>\r
 149 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#defaultVolume">defaultVolume</A></B></CODE>\r
 150 \r
 151 <BR>\r
 152 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The default volume</TD>\r
 153 </TR>\r
 154 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 155 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 156 <CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>\r
 157 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#voiceId">voiceId</A></B></CODE>\r
 158 \r
 159 <BR>\r
 160 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The id of the voice</TD>\r
 161 </TR>\r
 162 </TABLE>\r
 163 &nbsp;<A NAME="fields_inherited_from_class_javax.speech.synthesis.Voice"><!-- --></A>
 164 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 165 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 166 <TD><B>Fields inherited from class javax.speech.synthesis.Voice</B></TD>\r
 167 </TR>\r
 168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 169 <TD><CODE>AGE_CHILD, AGE_DONT_CARE, AGE_MIDDLE_ADULT, AGE_NEUTRAL, AGE_OLDER_ADULT, AGE_TEENAGER, AGE_YOUNGER_ADULT, GENDER_DONT_CARE, GENDER_FEMALE, GENDER_MALE, GENDER_NEUTRAL</CODE></TD>\r
 170 </TR>\r
 171 </TABLE>\r
 172 &nbsp;\r
 173 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 174 \r
 175 <A NAME="constructor_summary"><!-- --></A>
 176 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 177 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 178 <TD COLSPAN=2><FONT SIZE="+2">\r
 179 <B>Constructor Summary</B></FONT></TD>\r
 180 </TR>\r
 181 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 182 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#BaseVoice(java.lang.String, java.lang.String, int, int, java.lang.String, float, float, float, float)">BaseVoice</A></B>(java.lang.String&nbsp;id,
 183           java.lang.String&nbsp;name,
 184           int&nbsp;gender,
 185           int&nbsp;age,
 186           java.lang.String&nbsp;style,
 187           float&nbsp;pitch,
 188           float&nbsp;pitchRange,
 189           float&nbsp;speakingRate,
 190           float&nbsp;volume)</CODE>\r
 191 \r
 192 <BR>\r
 193 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Class constructor.  </TD>\r
 194 </TR>\r
 195 </TABLE>\r
 196 &nbsp;\r
 197 <!-- ========== METHOD SUMMARY =========== -->\r
 198 \r
 199 <A NAME="method_summary"><!-- --></A>
 200 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 201 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 202 <TD COLSPAN=2><FONT SIZE="+2">\r
 203 <B>Method Summary</B></FONT></TD>\r
 204 </TR>\r
 205 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 207 <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>\r
 208 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#clone()">clone</A></B>()</CODE>\r
 209 \r
 210 <BR>\r
 211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a copy of this voice.</TD>\r
 212 </TR>\r
 213 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 215 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 216 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#getId()">getId</A></B>()</CODE>\r
 217 \r
 218 <BR>\r
 219 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the id for this voice.  </TD>\r
 220 </TR>\r
 221 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 223 <CODE>&nbsp;float</CODE></FONT></TD>\r
 224 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#getPitch()">getPitch</A></B>()</CODE>\r
 225 \r
 226 <BR>\r
 227 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the pitch for this voice</TD>\r
 228 </TR>\r
 229 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 231 <CODE>&nbsp;float</CODE></FONT></TD>\r
 232 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#getPitchRange()">getPitchRange</A></B>()</CODE>\r
 233 \r
 234 <BR>\r
 235 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the pitch range for this voice</TD>\r
 236 </TR>\r
 237 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 238 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 239 <CODE>&nbsp;float</CODE></FONT></TD>\r
 240 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#getSpeakingRate()">getSpeakingRate</A></B>()</CODE>\r
 241 \r
 242 <BR>\r
 243 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the speaking rate for this voice</TD>\r
 244 </TR>\r
 245 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 246 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 247 <CODE>&nbsp;float</CODE></FONT></TD>\r
 248 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#getVolume()">getVolume</A></B>()</CODE>\r
 249 \r
 250 <BR>\r
 251 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the volume for this voice</TD>\r
 252 </TR>\r
 253 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 254 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 255 <CODE>&nbsp;void</CODE></FONT></TD>\r
 256 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#setId(java.lang.String)">setId</A></B>(java.lang.String&nbsp;id)</CODE>\r
 257 \r
 258 <BR>\r
 259 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the id for this voice.</TD>\r
 260 </TR>\r
 261 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 262 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 263 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 264 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#toString()">toString</A></B>()</CODE>\r
 265 \r
 266 <BR>\r
 267 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts a Voice to a printable string.</TD>\r
 268 </TR>\r
 269 </TABLE>\r
 270 &nbsp;<A NAME="methods_inherited_from_class_javax.speech.synthesis.Voice"><!-- --></A>
 271 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 272 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 273 <TD><B>Methods inherited from class javax.speech.synthesis.Voice</B></TD>\r
 274 </TR>\r
 275 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 276 <TD><CODE>equals, getAge, getGender, getName, getStyle, match, setAge, setGender, setName, setStyle</CODE></TD>\r
 277 </TR>\r
 278 </TABLE>\r
 279 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 280 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 281 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 282 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
 283 </TR>\r
 284 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 285 <TD><CODE>finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>\r
 286 </TR>\r
 287 </TABLE>\r
 288 &nbsp;\r
 289 <P>\r
 290 \r
 291 <!-- ============ FIELD DETAIL =========== -->\r
 292 \r
 293 <A NAME="field_detail"><!-- --></A>
 294 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 295 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 296 <TD COLSPAN=1><FONT SIZE="+2">\r
 297 <B>Field Detail</B></FONT></TD>\r
 298 </TR>\r
 299 </TABLE>\r
 300 \r
 301 <A NAME="voiceId"><!-- --></A><H3>\r
 302 voiceId</H3>\r
 303 <PRE>\r
 304 protected java.lang.String <B>voiceId</B></PRE>\r
 305 <DL>\r
 306 <DD>The id of the voice\r
 307 <P>\r
 308 <DL>\r
 309 </DL>\r
 310 </DL>\r
 311 <HR>\r
 312 \r
 313 <A NAME="defaultPitch"><!-- --></A><H3>\r
 314 defaultPitch</H3>\r
 315 <PRE>\r
 316 protected float <B>defaultPitch</B></PRE>\r
 317 <DL>\r
 318 <DD>The default pitch\r
 319 <P>\r
 320 <DL>\r
 321 </DL>\r
 322 </DL>\r
 323 <HR>\r
 324 \r
 325 <A NAME="defaultPitchRange"><!-- --></A><H3>\r
 326 defaultPitchRange</H3>\r
 327 <PRE>\r
 328 protected float <B>defaultPitchRange</B></PRE>\r
 329 <DL>\r
 330 <DD>The default pitch range\r
 331 <P>\r
 332 <DL>\r
 333 </DL>\r
 334 </DL>\r
 335 <HR>\r
 336 \r
 337 <A NAME="defaultSpeakingRate"><!-- --></A><H3>\r
 338 defaultSpeakingRate</H3>\r
 339 <PRE>\r
 340 protected float <B>defaultSpeakingRate</B></PRE>\r
 341 <DL>\r
 342 <DD>The default speaking rate\r
 343 <P>\r
 344 <DL>\r
 345 </DL>\r
 346 </DL>\r
 347 <HR>\r
 348 \r
 349 <A NAME="defaultVolume"><!-- --></A><H3>\r
 350 defaultVolume</H3>\r
 351 <PRE>\r
 352 protected float <B>defaultVolume</B></PRE>\r
 353 <DL>\r
 354 <DD>The default volume\r
 355 <P>\r
 356 <DL>\r
 357 </DL>\r
 358 </DL>\r
 359 \r
 360 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 361 \r
 362 <A NAME="constructor_detail"><!-- --></A>
 363 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 364 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 365 <TD COLSPAN=1><FONT SIZE="+2">\r
 366 <B>Constructor Detail</B></FONT></TD>\r
 367 </TR>\r
 368 </TABLE>\r
 369 \r
 370 <A NAME="BaseVoice(java.lang.String, java.lang.String, int, int, java.lang.String, float, float, float, float)"><!-- --></A><H3>\r
 371 BaseVoice</H3>\r
 372 <PRE>\r
 373 public <B>BaseVoice</B>(java.lang.String&nbsp;id,
 374                  java.lang.String&nbsp;name,
 375                  int&nbsp;gender,
 376                  int&nbsp;age,
 377                  java.lang.String&nbsp;style,
 378                  float&nbsp;pitch,
 379                  float&nbsp;pitchRange,
 380                  float&nbsp;speakingRate,
 381                  float&nbsp;volume)</PRE>\r
 382 <DL>\r
 383 <DD>Class constructor.  The age and gender parameters are defined in
 384  <code>Voice</code>.\r
 385 <P>\r
 386 <DT><B>Parameters:</B><DD><CODE>id</CODE> - the id<DD><CODE>name</CODE> - the name<DD><CODE>gender</CODE> - the gender<DD><CODE>age</CODE> - the age<DD><CODE>style</CODE> - the style<DD><CODE>pitch</CODE> - the baseline pitch in Hertz<DD><CODE>pitchRange</CODE> - the pitch range in Hertz<DD><CODE>speakingRate</CODE> - the speaking rate in words per minute<DD><CODE>volume</CODE> - the volume expressed between 0.0 and 1.0,
 387    inclusive</DL>\r
 388 \r
 389 <!-- ============ METHOD DETAIL ========== -->\r
 390 \r
 391 <A NAME="method_detail"><!-- --></A>
 392 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 393 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 394 <TD COLSPAN=1><FONT SIZE="+2">\r
 395 <B>Method Detail</B></FONT></TD>\r
 396 </TR>\r
 397 </TABLE>\r
 398 \r
 399 <A NAME="getId()"><!-- --></A><H3>\r
 400 getId</H3>\r
 401 <PRE>\r
 402 public java.lang.String <B>getId</B>()</PRE>\r
 403 <DL>\r
 404 <DD>Gets the id for this voice.  Should be unique for a
 405  synthesizer.\r
 406 <P>\r
 407 <DD><DL>\r
 408
 409 <DT><B>Returns:</B><DD>the id for this voice<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#setId(java.lang.String)"><CODE>setId(java.lang.String)</CODE></A></DL>\r
 410 </DD>\r
 411 </DL>\r
 412 <HR>\r
 413 \r
 414 <A NAME="setId(java.lang.String)"><!-- --></A><H3>\r
 415 setId</H3>\r
 416 <PRE>\r
 417 public void <B>setId</B>(java.lang.String&nbsp;id)</PRE>\r
 418 <DL>\r
 419 <DD>Sets the id for this voice.\r
 420 <P>\r
 421 <DD><DL>\r
 422 <DT><B>Parameters:</B><DD><CODE>id</CODE> - the new id<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#getId()"><CODE>getId()</CODE></A></DL>\r
 423 </DD>\r
 424 </DL>\r
 425 <HR>\r
 426 \r
 427 <A NAME="getPitch()"><!-- --></A><H3>\r
 428 getPitch</H3>\r
 429 <PRE>\r
 430 public float <B>getPitch</B>()</PRE>\r
 431 <DL>\r
 432 <DD>Gets the pitch for this voice\r
 433 <P>\r
 434 <DD><DL>\r
 435
 436 <DT><B>Returns:</B><DD>the pitch</DL>\r
 437 </DD>\r
 438 </DL>\r
 439 <HR>\r
 440 \r
 441 <A NAME="getPitchRange()"><!-- --></A><H3>\r
 442 getPitchRange</H3>\r
 443 <PRE>\r
 444 public float <B>getPitchRange</B>()</PRE>\r
 445 <DL>\r
 446 <DD>Gets the pitch range for this voice\r
 447 <P>\r
 448 <DD><DL>\r
 449
 450 <DT><B>Returns:</B><DD>the pitch range</DL>\r
 451 </DD>\r
 452 </DL>\r
 453 <HR>\r
 454 \r
 455 <A NAME="getSpeakingRate()"><!-- --></A><H3>\r
 456 getSpeakingRate</H3>\r
 457 <PRE>\r
 458 public float <B>getSpeakingRate</B>()</PRE>\r
 459 <DL>\r
 460 <DD>Gets the speaking rate for this voice\r
 461 <P>\r
 462 <DD><DL>\r
 463
 464 <DT><B>Returns:</B><DD>the speaking rate</DL>\r
 465 </DD>\r
 466 </DL>\r
 467 <HR>\r
 468 \r
 469 <A NAME="getVolume()"><!-- --></A><H3>\r
 470 getVolume</H3>\r
 471 <PRE>\r
 472 public float <B>getVolume</B>()</PRE>\r
 473 <DL>\r
 474 <DD>Gets the volume for this voice\r
 475 <P>\r
 476 <DD><DL>\r
 477
 478 <DT><B>Returns:</B><DD>the volume</DL>\r
 479 </DD>\r
 480 </DL>\r
 481 <HR>\r
 482 \r
 483 <A NAME="clone()"><!-- --></A><H3>\r
 484 clone</H3>\r
 485 <PRE>\r
 486 public java.lang.Object <B>clone</B>()</PRE>\r
 487 <DL>\r
 488 <DD>Creates a copy of this voice.\r
 489 <P>\r
 490 <DD><DL>\r
 491
 492 <DT><B>Returns:</B><DD>a clone of this voice</DL>\r
 493 </DD>\r
 494 </DL>\r
 495 <HR>\r
 496 \r
 497 <A NAME="toString()"><!-- --></A><H3>\r
 498 toString</H3>\r
 499 <PRE>\r
 500 public java.lang.String <B>toString</B>()</PRE>\r
 501 <DL>\r
 502 <DD>Converts a Voice to a printable string.\r
 503 <P>\r
 504 <DD><DL>\r
 505 </DL>\r
 506 </DD>\r
 507 </DL>\r
 508 <!-- ========= END OF CLASS DATA ========= -->\r
 509 <HR>\r
 510 \r
 511
 512 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 513 <A NAME="navbar_bottom"><!-- --></A>
 514 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 515 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 516 <TR>\r
 517 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 518 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 519 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 520   <TR ALIGN="center" VALIGN="top">\r
 521   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 522   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 523   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 524   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 525   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 526   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 527   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 528   </TR>\r
 529 </TABLE>\r
 530 </TD>\r
 531 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 532 </EM>\r
 533 </TD>\r
 534 </TR>\r
 535 \r
 536 <TR>\r
 537 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 538 &nbsp;<A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerQueueItem.html" title="class in com.sun.speech.engine.synthesis"><B>PREV CLASS</B></A>&nbsp;\r
 539 &nbsp;<A HREF="../../../../../com/sun/speech/engine/synthesis/JSMLParser.html" title="class in com.sun.speech.engine.synthesis"><B>NEXT CLASS</B></A></FONT></TD>\r
 540 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 541   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 542 &nbsp;<A HREF="BaseVoice.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 543 &nbsp;<SCRIPT type="text/javascript">\r
 544   <!--\r
 545   if(window==top) {\r
 546     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 547   }\r
 548   //-->\r
 549 </SCRIPT>\r
 550 <NOSCRIPT>\r
 551   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 552 </NOSCRIPT>
 553 \r
 554 </FONT></TD>\r
 555 </TR>\r
 556 <TR>\r
 557 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 558   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 559 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 560 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 561 </TR>\r
 562 </TABLE>\r
 563 <A NAME="skip-navbar_bottom"></A>
 564 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 565 \r
 566 <HR>\r
 567 \r
 568 </BODY>\r
 569 </HTML>\r