1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:29 CET 2009 -->
\r
7 BaseSynthesizerProperties (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.engine.synthesis.BaseSynthesizerProperties class">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="BaseSynthesizerProperties (FreeTTS 1.2)";
\r
23 <BODY BGCOLOR="white" onload="windowTitle();">
\r
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
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> </TD>
\r
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
52 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerQueueItem.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>
\r
56 <A HREF="BaseSynthesizerProperties.html" target="_top"><B>NO FRAMES</B></A>
\r
57 <SCRIPT type="text/javascript">
\r
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
72 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->
\r
81 <!-- ======== START OF CLASS DATA ======== -->
\r
84 com.sun.speech.engine.synthesis</FONT>
\r
86 Class BaseSynthesizerProperties</H2>
\r
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine">com.sun.speech.engine.BaseEngineProperties</A>
\r
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.engine.synthesis.BaseSynthesizerProperties</B>
\r
93 <DT><B>All Implemented Interfaces:</B> <DD>javax.speech.EngineProperties, <A HREF="../../../../../com/sun/speech/engine/SpeechEventDispatcher.html" title="interface in com.sun.speech.engine">SpeechEventDispatcher</A>, javax.speech.synthesis.SynthesizerProperties</DD>
\r
97 <DT>public class <B>BaseSynthesizerProperties</B><DT>extends <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine">BaseEngineProperties</A><DT>implements javax.speech.synthesis.SynthesizerProperties</DL>
\r
100 Supports the JSAPI 1.0 <code>SynthesizerProperties</code>
101 interface. The properties of a <code>Synthesizer</code> are:
116 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
119 <!-- =========== FIELD SUMMARY =========== -->
\r
121 <A NAME="field_summary"><!-- --></A>
122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
124 <TD COLSPAN=2><FONT SIZE="+2">
\r
125 <B>Field Summary</B></FONT></TD>
\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
129 <CODE>protected float</CODE></FONT></TD>
\r
130 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#currentPitch">currentPitch</A></B></CODE>
\r
133 The current pitch.</TD>
\r
135 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
137 <CODE>protected float</CODE></FONT></TD>
\r
138 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#currentPitchRange">currentPitchRange</A></B></CODE>
\r
141 The current pitch range.</TD>
\r
143 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
145 <CODE>protected float</CODE></FONT></TD>
\r
146 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#currentSpeakingRate">currentSpeakingRate</A></B></CODE>
\r
149 The current speaking rate.</TD>
\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
153 <CODE>protected javax.speech.synthesis.Voice</CODE></FONT></TD>
\r
154 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#currentVoice">currentVoice</A></B></CODE>
\r
157 The current voice.</TD>
\r
159 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
161 <CODE>protected float</CODE></FONT></TD>
\r
162 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#currentVolume">currentVolume</A></B></CODE>
\r
165 The current volume.</TD>
\r
167 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
169 <CODE>protected float</CODE></FONT></TD>
\r
170 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#defaultPitch">defaultPitch</A></B></CODE>
\r
173 The default pitch.</TD>
\r
175 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
177 <CODE>protected float</CODE></FONT></TD>
\r
178 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#defaultPitchRange">defaultPitchRange</A></B></CODE>
\r
181 The default pitch range.</TD>
\r
183 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
185 <CODE>protected float</CODE></FONT></TD>
\r
186 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#defaultSpeakingRate">defaultSpeakingRate</A></B></CODE>
\r
189 The default specking rate.</TD>
\r
191 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
192 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
193 <CODE>protected javax.speech.synthesis.Voice</CODE></FONT></TD>
\r
194 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#defaultVoice">defaultVoice</A></B></CODE>
\r
197 The default voice.</TD>
\r
199 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
200 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
201 <CODE>protected float</CODE></FONT></TD>
\r
202 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#defaultVolume">defaultVolume</A></B></CODE>
\r
205 The default volume.</TD>
\r
208 <A NAME="fields_inherited_from_class_com.sun.speech.engine.BaseEngineProperties"><!-- --></A>
209 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
210 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
211 <TD><B>Fields inherited from class com.sun.speech.engine.<A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine">BaseEngineProperties</A></B></TD>
\r
213 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
214 <TD><CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html#propertyChangeListeners">propertyChangeListeners</A></CODE></TD>
\r
218 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
220 <A NAME="constructor_summary"><!-- --></A>
221 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
222 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
223 <TD COLSPAN=2><FONT SIZE="+2">
\r
224 <B>Constructor Summary</B></FONT></TD>
\r
226 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
227 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#BaseSynthesizerProperties()">BaseSynthesizerProperties</A></B>()</CODE>
\r
230 Class constructor.</TD>
\r
232 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
233 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#BaseSynthesizerProperties(javax.speech.synthesis.Voice, float, float, float, float)">BaseSynthesizerProperties</A></B>(javax.speech.synthesis.Voice defaultVoice,
234 float defaultPitch,
235 float defaultPitchRange,
236 float defaultSpeakingRate,
237 float defaultVolume)</CODE>
\r
240 Creates a new <code>BaseSynthesizerProperties</code> with the
241 given default values.</TD>
\r
245 <!-- ========== METHOD SUMMARY =========== -->
\r
247 <A NAME="method_summary"><!-- --></A>
248 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
249 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
250 <TD COLSPAN=2><FONT SIZE="+2">
\r
251 <B>Method Summary</B></FONT></TD>
\r
253 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
254 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
255 <CODE> float</CODE></FONT></TD>
\r
256 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#getPitch()">getPitch</A></B>()</CODE>
\r
259 Gets the baseline pitch for synthesis.</TD>
\r
261 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
262 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
263 <CODE> float</CODE></FONT></TD>
\r
264 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#getPitchRange()">getPitchRange</A></B>()</CODE>
\r
267 Gets the pitch range for synthesis.</TD>
\r
269 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
270 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
271 <CODE> float</CODE></FONT></TD>
\r
272 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#getSpeakingRate()">getSpeakingRate</A></B>()</CODE>
\r
275 Gets the current target speaking rate in words per minute.</TD>
\r
277 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
278 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
279 <CODE> javax.speech.synthesis.Voice</CODE></FONT></TD>
\r
280 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#getVoice()">getVoice</A></B>()</CODE>
\r
283 Gets the current synthesizer voice.</TD>
\r
285 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
286 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
287 <CODE> float</CODE></FONT></TD>
\r
288 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#getVolume()">getVolume</A></B>()</CODE>
\r
291 Gets the current volume.</TD>
\r
293 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
294 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
295 <CODE> void</CODE></FONT></TD>
\r
296 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#reset()">reset</A></B>()</CODE>
\r
299 Resets all properties to their default values.</TD>
\r
301 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
302 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
303 <CODE> void</CODE></FONT></TD>
\r
304 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#setPitch(float)">setPitch</A></B>(float hertz)</CODE>
\r
307 Sets the baseline pitch for the current synthesis voice.</TD>
\r
309 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
310 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
311 <CODE> void</CODE></FONT></TD>
\r
312 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#setPitchRange(float)">setPitchRange</A></B>(float hertz)</CODE>
\r
315 Sets the pitch range for the current synthesis voice.</TD>
\r
317 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
318 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
319 <CODE> void</CODE></FONT></TD>
\r
320 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#setSpeakingRate(float)">setSpeakingRate</A></B>(float wpm)</CODE>
\r
323 Sets the target speaking rate in words per minute.</TD>
\r
325 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
326 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
327 <CODE> void</CODE></FONT></TD>
\r
328 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#setVoice(javax.speech.synthesis.Voice)">setVoice</A></B>(javax.speech.synthesis.Voice voice)</CODE>
\r
331 Sets the current synthesizer voice.</TD>
\r
333 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
334 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
335 <CODE> void</CODE></FONT></TD>
\r
336 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#setVolume(float)">setVolume</A></B>(float volume)</CODE>
\r
339 Sets the volume.</TD>
\r
342 <A NAME="methods_inherited_from_class_com.sun.speech.engine.BaseEngineProperties"><!-- --></A>
343 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
344 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
345 <TD><B>Methods inherited from class com.sun.speech.engine.<A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine">BaseEngineProperties</A></B></TD>
\r
347 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
348 <TD><CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html#addPropertyChangeListener(java.beans.PropertyChangeListener)">addPropertyChangeListener</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html#dispatchSpeechEvent(javax.speech.SpeechEvent)">dispatchSpeechEvent</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html#firePropertyChangeEvent(java.beans.PropertyChangeEvent)">firePropertyChangeEvent</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html#getControlComponent()">getControlComponent</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html#postPropertyChangeEvent(java.lang.String, boolean, boolean)">postPropertyChangeEvent</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html#postPropertyChangeEvent(java.lang.String, float, float)">postPropertyChangeEvent</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html#postPropertyChangeEvent(java.lang.String, int, int)">postPropertyChangeEvent</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html#postPropertyChangeEvent(java.lang.String, java.lang.Object, java.lang.Object)">postPropertyChangeEvent</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html#removePropertyChangeListener(java.beans.PropertyChangeListener)">removePropertyChangeListener</A></CODE></TD>
\r
351 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
352 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
353 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
354 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
356 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
357 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
360 <A NAME="methods_inherited_from_class_javax.speech.EngineProperties"><!-- --></A>
361 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
362 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
363 <TD><B>Methods inherited from interface javax.speech.EngineProperties</B></TD>
\r
365 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
366 <TD><CODE>addPropertyChangeListener, getControlComponent, removePropertyChangeListener</CODE></TD>
\r
372 <!-- ============ FIELD DETAIL =========== -->
\r
374 <A NAME="field_detail"><!-- --></A>
375 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
376 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
377 <TD COLSPAN=1><FONT SIZE="+2">
\r
378 <B>Field Detail</B></FONT></TD>
\r
382 <A NAME="defaultVoice"><!-- --></A><H3>
\r
385 protected javax.speech.synthesis.Voice <B>defaultVoice</B></PRE>
\r
387 <DD>The default voice.
\r
394 <A NAME="defaultPitch"><!-- --></A><H3>
\r
397 protected float <B>defaultPitch</B></PRE>
\r
399 <DD>The default pitch.
\r
406 <A NAME="defaultPitchRange"><!-- --></A><H3>
\r
407 defaultPitchRange</H3>
\r
409 protected float <B>defaultPitchRange</B></PRE>
\r
411 <DD>The default pitch range.
\r
418 <A NAME="defaultSpeakingRate"><!-- --></A><H3>
\r
419 defaultSpeakingRate</H3>
\r
421 protected float <B>defaultSpeakingRate</B></PRE>
\r
423 <DD>The default specking rate.
\r
430 <A NAME="defaultVolume"><!-- --></A><H3>
\r
433 protected float <B>defaultVolume</B></PRE>
\r
435 <DD>The default volume.
\r
442 <A NAME="currentVoice"><!-- --></A><H3>
\r
445 protected javax.speech.synthesis.Voice <B>currentVoice</B></PRE>
\r
447 <DD>The current voice.
\r
454 <A NAME="currentPitch"><!-- --></A><H3>
\r
457 protected float <B>currentPitch</B></PRE>
\r
459 <DD>The current pitch.
\r
466 <A NAME="currentPitchRange"><!-- --></A><H3>
\r
467 currentPitchRange</H3>
\r
469 protected float <B>currentPitchRange</B></PRE>
\r
471 <DD>The current pitch range.
\r
478 <A NAME="currentSpeakingRate"><!-- --></A><H3>
\r
479 currentSpeakingRate</H3>
\r
481 protected float <B>currentSpeakingRate</B></PRE>
\r
483 <DD>The current speaking rate.
\r
490 <A NAME="currentVolume"><!-- --></A><H3>
\r
493 protected float <B>currentVolume</B></PRE>
\r
495 <DD>The current volume.
\r
501 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
503 <A NAME="constructor_detail"><!-- --></A>
504 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
505 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
506 <TD COLSPAN=1><FONT SIZE="+2">
\r
507 <B>Constructor Detail</B></FONT></TD>
\r
511 <A NAME="BaseSynthesizerProperties()"><!-- --></A><H3>
\r
512 BaseSynthesizerProperties</H3>
\r
514 public <B>BaseSynthesizerProperties</B>()</PRE>
\r
516 <DD>Class constructor.
\r
521 <A NAME="BaseSynthesizerProperties(javax.speech.synthesis.Voice, float, float, float, float)"><!-- --></A><H3>
\r
522 BaseSynthesizerProperties</H3>
\r
524 public <B>BaseSynthesizerProperties</B>(javax.speech.synthesis.Voice defaultVoice,
525 float defaultPitch,
526 float defaultPitchRange,
527 float defaultSpeakingRate,
528 float defaultVolume)</PRE>
\r
530 <DD>Creates a new <code>BaseSynthesizerProperties</code> with the
531 given default values.
\r
533 <DT><B>Parameters:</B><DD><CODE>defaultVoice</CODE> - the default voice<DD><CODE>defaultPitch</CODE> - the default pitch<DD><CODE>defaultPitchRange</CODE> - the default pitch range<DD><CODE>defaultSpeakingRate</CODE> - the default speaking rate<DD><CODE>defaultVolume</CODE> - the default volume</DL>
\r
535 <!-- ============ METHOD DETAIL ========== -->
\r
537 <A NAME="method_detail"><!-- --></A>
538 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
539 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
540 <TD COLSPAN=1><FONT SIZE="+2">
\r
541 <B>Method Detail</B></FONT></TD>
\r
545 <A NAME="reset()"><!-- --></A><H3>
\r
548 public void <B>reset</B>()</PRE>
\r
550 <DD>Resets all properties to their default values.
\r
553 <DT><B>Specified by:</B><DD><CODE>reset</CODE> in interface <CODE>javax.speech.EngineProperties</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html#reset()">reset</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine">BaseEngineProperties</A></CODE></DL>
\r
561 <A NAME="getVoice()"><!-- --></A><H3>
\r
564 public javax.speech.synthesis.Voice <B>getVoice</B>()</PRE>
\r
566 <DD>Gets the current synthesizer voice.
\r
569 <DT><B>Specified by:</B><DD><CODE>getVoice</CODE> in interface <CODE>javax.speech.synthesis.SynthesizerProperties</CODE></DL>
\r
573 <DT><B>Returns:</B><DD>the current synthesizer voice.<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#setVoice(javax.speech.synthesis.Voice)"><CODE>setVoice(javax.speech.synthesis.Voice)</CODE></A></DL>
\r
578 <A NAME="setVoice(javax.speech.synthesis.Voice)"><!-- --></A><H3>
\r
581 public void <B>setVoice</B>(javax.speech.synthesis.Voice voice)
582 throws java.beans.PropertyVetoException</PRE>
\r
584 <DD>Sets the current synthesizer voice.
\r
587 <DT><B>Specified by:</B><DD><CODE>setVoice</CODE> in interface <CODE>javax.speech.synthesis.SynthesizerProperties</CODE></DL>
\r
590 <DT><B>Parameters:</B><DD><CODE>voice</CODE> - the new voice
592 <DD><CODE>java.beans.PropertyVetoException</CODE> - if the voice cannot be set to
593 the given value<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#getVoice()"><CODE>getVoice()</CODE></A></DL>
\r
598 <A NAME="getPitch()"><!-- --></A><H3>
\r
601 public float <B>getPitch</B>()</PRE>
\r
603 <DD>Gets the baseline pitch for synthesis.
\r
606 <DT><B>Specified by:</B><DD><CODE>getPitch</CODE> in interface <CODE>javax.speech.synthesis.SynthesizerProperties</CODE></DL>
\r
610 <DT><B>Returns:</B><DD>the baseline pitch in Hertz<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#setPitch(float)"><CODE>setPitch(float)</CODE></A></DL>
\r
615 <A NAME="setPitch(float)"><!-- --></A><H3>
\r
618 public void <B>setPitch</B>(float hertz)
619 throws java.beans.PropertyVetoException</PRE>
\r
621 <DD>Sets the baseline pitch for the current synthesis voice.
\r
624 <DT><B>Specified by:</B><DD><CODE>setPitch</CODE> in interface <CODE>javax.speech.synthesis.SynthesizerProperties</CODE></DL>
\r
627 <DT><B>Parameters:</B><DD><CODE>hertz</CODE> - the new baseline pitch in Hertz
629 <DD><CODE>java.beans.PropertyVetoException</CODE> - if the baseline pitch cannot be
630 set to the given value<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#getPitch()"><CODE>getPitch()</CODE></A></DL>
\r
635 <A NAME="getPitchRange()"><!-- --></A><H3>
\r
638 public float <B>getPitchRange</B>()</PRE>
\r
640 <DD>Gets the pitch range for synthesis.
\r
643 <DT><B>Specified by:</B><DD><CODE>getPitchRange</CODE> in interface <CODE>javax.speech.synthesis.SynthesizerProperties</CODE></DL>
\r
647 <DT><B>Returns:</B><DD>the current pitch range in Hertz<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#setPitchRange(float)"><CODE>setPitchRange(float)</CODE></A></DL>
\r
652 <A NAME="setPitchRange(float)"><!-- --></A><H3>
\r
655 public void <B>setPitchRange</B>(float hertz)
656 throws java.beans.PropertyVetoException</PRE>
\r
658 <DD>Sets the pitch range for the current synthesis voice.
\r
661 <DT><B>Specified by:</B><DD><CODE>setPitchRange</CODE> in interface <CODE>javax.speech.synthesis.SynthesizerProperties</CODE></DL>
\r
664 <DT><B>Parameters:</B><DD><CODE>hertz</CODE> - the new range in Hertz
666 <DD><CODE>java.beans.PropertyVetoException</CODE> - if the pitch range cannot be set
667 to the given value<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#getPitchRange()"><CODE>getPitchRange()</CODE></A></DL>
\r
672 <A NAME="getSpeakingRate()"><!-- --></A><H3>
\r
673 getSpeakingRate</H3>
\r
675 public float <B>getSpeakingRate</B>()</PRE>
\r
677 <DD>Gets the current target speaking rate in words per minute.
\r
680 <DT><B>Specified by:</B><DD><CODE>getSpeakingRate</CODE> in interface <CODE>javax.speech.synthesis.SynthesizerProperties</CODE></DL>
\r
684 <DT><B>Returns:</B><DD>the current target speaking rate in words per minute.<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#getSpeakingRate()"><CODE>getSpeakingRate()</CODE></A></DL>
\r
689 <A NAME="setSpeakingRate(float)"><!-- --></A><H3>
\r
690 setSpeakingRate</H3>
\r
692 public void <B>setSpeakingRate</B>(float wpm)
693 throws java.beans.PropertyVetoException</PRE>
\r
695 <DD>Sets the target speaking rate in words per minute.
\r
698 <DT><B>Specified by:</B><DD><CODE>setSpeakingRate</CODE> in interface <CODE>javax.speech.synthesis.SynthesizerProperties</CODE></DL>
\r
701 <DT><B>Parameters:</B><DD><CODE>wpm</CODE> - the new speaking rate in words per minute
703 <DD><CODE>java.beans.PropertyVetoException</CODE> - if the speaking rate cannot be
704 set to the given value<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#getSpeakingRate()"><CODE>getSpeakingRate()</CODE></A></DL>
\r
709 <A NAME="getVolume()"><!-- --></A><H3>
\r
712 public float <B>getVolume</B>()</PRE>
\r
714 <DD>Gets the current volume.
\r
717 <DT><B>Specified by:</B><DD><CODE>getVolume</CODE> in interface <CODE>javax.speech.synthesis.SynthesizerProperties</CODE></DL>
\r
721 <DT><B>Returns:</B><DD>the current volume expressed as a <code>float</code>
722 0.0 and 1.0, inclusive<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#setVolume(float)"><CODE>setVolume(float)</CODE></A></DL>
\r
727 <A NAME="setVolume(float)"><!-- --></A><H3>
\r
730 public void <B>setVolume</B>(float volume)
731 throws java.beans.PropertyVetoException</PRE>
\r
733 <DD>Sets the volume.
\r
736 <DT><B>Specified by:</B><DD><CODE>setVolume</CODE> in interface <CODE>javax.speech.synthesis.SynthesizerProperties</CODE></DL>
\r
739 <DT><B>Parameters:</B><DD><CODE>volume</CODE> - the new volume expressed as a <code>float</code>
740 0.0 and 1.0, inclusive
742 <DD><CODE>java.beans.PropertyVetoException</CODE> - if the volume cannot be
743 set to the given value<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html#getVolume()"><CODE>getVolume()</CODE></A></DL>
\r
746 <!-- ========= END OF CLASS DATA ========= -->
\r
750 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
751 <A NAME="navbar_bottom"><!-- --></A>
752 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
753 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
755 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
756 <A NAME="navbar_bottom_firstrow"><!-- --></A>
757 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
758 <TR ALIGN="center" VALIGN="top">
\r
759 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
760 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
761 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
762 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
763 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
764 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
765 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
769 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
775 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
776 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis"><B>PREV CLASS</B></A>
\r
777 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerQueueItem.html" title="class in com.sun.speech.engine.synthesis"><B>NEXT CLASS</B></A></FONT></TD>
\r
778 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
779 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
780 <A HREF="BaseSynthesizerProperties.html" target="_top"><B>NO FRAMES</B></A>
\r
781 <SCRIPT type="text/javascript">
\r
784 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
789 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
795 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
796 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
797 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
798 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
801 <A NAME="skip-navbar_bottom"></A>
802 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r