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
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.Voice 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="Voice (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/freetts/Utterance.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.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>
\r
56 <A HREF="Voice.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.freetts</FONT>
\r
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.Voice</B>
\r
92 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/sun/speech/freetts/Dumpable.html" title="interface in com.sun.speech.freetts">Dumpable</A>, <A HREF="../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface in com.sun.speech.freetts">UtteranceProcessor</A></DD>
\r
95 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/sun/speech/freetts/en/us/CMUVoice.html" title="class in com.sun.speech.freetts.en.us">CMUVoice</A></DD>
\r
99 <DT>public abstract class <B>Voice</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface in com.sun.speech.freetts">UtteranceProcessor</A>, <A HREF="../../../../com/sun/speech/freetts/Dumpable.html" title="interface in com.sun.speech.freetts">Dumpable</A></DL>
\r
102 Performs text-to-speech using a series of
103 <code>UtteranceProcessors</code>. It is the main conduit to the FreeTTS
104 speech synthesizer. It can perform TTS on ASCII text,
105 a JSML document, an <code>InputStream</code>, or a
106 <code>FreeTTSSpeakable</code>, by invoking the method <code>speak</code>.
108 <p>Before a Voice can perform TTS, it must have a
109 <code>Lexicon</code>, from which it gets the vocabulary, and
110 an <code>AudioPlayer</code>, to which it sends the synthesized output.
112 <p><b>Example</b> (using the <code>CMUDiphoneVoice</code>,
113 <code>CMULexicon</code> and <code>JavaClipAudioPlayer</code>):
116 Voice voice = new CMUDiphoneVoice();
119 voice.setLexicon(new CMULexicon());
121 // sets the AudioPlayer
122 voice.setAudioPlayer(new JavaClipAudioPlayer());
128 voice.speak("I can talk forever without getting tired!");
132 <p>A user can override the AudioPlayer to use by defining the
133 "com.sun.speech.freetts.voice.defaultAudioPlayer" system property.
134 The value of this property must be the name of a class that
135 implements the AudioPlayer interface, and which also has a no-arg
141 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/VoiceManager.html" title="class in com.sun.speech.freetts"><CODE>VoiceManager</CODE></A>,
142 <A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html" title="class in com.sun.speech.freetts"><CODE>VoiceDirectory</CODE></A></DL>
\r
146 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
149 <!-- =========== FIELD SUMMARY =========== -->
\r
151 <A NAME="field_summary"><!-- --></A>
152 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
153 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
154 <TD COLSPAN=2><FONT SIZE="+2">
\r
155 <B>Field Summary</B></FONT></TD>
\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
159 <CODE>static java.lang.String</CODE></FONT></TD>
\r
160 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#DATABASE_NAME">DATABASE_NAME</A></B></CODE>
\r
163 Constant that describes the name of the unit database used by
166 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
168 <CODE>static java.lang.String</CODE></FONT></TD>
\r
169 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#DEFAULT_AUDIO_PLAYER">DEFAULT_AUDIO_PLAYER</A></B></CODE>
\r
172 Feature name for the default AudioPlayer class to use.</TD>
\r
174 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
176 <CODE>static java.lang.String</CODE></FONT></TD>
\r
177 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#DEFAULT_AUDIO_PLAYER_DEFAULT">DEFAULT_AUDIO_PLAYER_DEFAULT</A></B></CODE>
\r
180 The default class to use for the DEFAULT_AUDIO_PLAYER.</TD>
\r
182 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
184 <CODE>static java.lang.String</CODE></FONT></TD>
\r
185 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#FEATURE_JOIN_TYPE">FEATURE_JOIN_TYPE</A></B></CODE>
\r
188 Feature name for the join type string.</TD>
\r
190 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
191 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
192 <CODE>static java.lang.String</CODE></FONT></TD>
\r
193 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#FEATURE_SILENCE">FEATURE_SILENCE</A></B></CODE>
\r
196 Feature name for the silence phone string.</TD>
\r
198 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
199 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
200 <CODE>static java.lang.String</CODE></FONT></TD>
\r
201 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#PROP_PREFIX">PROP_PREFIX</A></B></CODE>
\r
204 Prefix for System property names.</TD>
\r
208 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
210 <A NAME="constructor_summary"><!-- --></A>
211 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
212 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
213 <TD COLSPAN=2><FONT SIZE="+2">
\r
214 <B>Constructor Summary</B></FONT></TD>
\r
216 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
217 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#Voice()">Voice</A></B>()</CODE>
\r
220 Creates a new Voice. </TD>
\r
222 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
223 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#Voice(java.lang.String, com.sun.speech.freetts.Gender, com.sun.speech.freetts.Age, java.lang.String, java.util.Locale, java.lang.String, java.lang.String)">Voice</A></B>(java.lang.String name,
224 <A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A> gender,
225 <A HREF="../../../../com/sun/speech/freetts/Age.html" title="class in com.sun.speech.freetts">Age</A> age,
226 java.lang.String description,
227 java.util.Locale locale,
228 java.lang.String domain,
229 java.lang.String organization)</CODE>
\r
232 Creates a new Voice like above, except that it also
233 stores the properties of the voice.</TD>
\r
237 <!-- ========== METHOD SUMMARY =========== -->
\r
239 <A NAME="method_summary"><!-- --></A>
240 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
241 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
242 <TD COLSPAN=2><FONT SIZE="+2">
\r
243 <B>Method Summary</B></FONT></TD>
\r
245 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
246 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
247 <CODE> void</CODE></FONT></TD>
\r
248 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#addFeatureProcessor(java.lang.String, com.sun.speech.freetts.FeatureProcessor)">addFeatureProcessor</A></B>(java.lang.String name,
249 <A HREF="../../../../com/sun/speech/freetts/FeatureProcessor.html" title="interface in com.sun.speech.freetts">FeatureProcessor</A> fp)</CODE>
\r
252 Adds a language/voice specific Feature Processor to the set of
253 FeatureProcessors supported by this voice.</TD>
\r
255 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
256 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
257 <CODE> void</CODE></FONT></TD>
\r
258 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#allocate()">allocate</A></B>()</CODE>
\r
261 Allocate this Voice. </TD>
\r
263 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
264 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
265 <CODE>static <A HREF="../../../../com/sun/speech/freetts/OutputQueue.html" title="class in com.sun.speech.freetts">OutputQueue</A></CODE></FONT></TD>
\r
266 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#createOutputThread()">createOutputThread</A></B>()</CODE>
\r
269 Creates an output thread that will asynchronously
270 output utterances that are generated by this voice (and other
273 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
274 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
275 <CODE> void</CODE></FONT></TD>
\r
276 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#deallocate()">deallocate</A></B>()</CODE>
\r
279 Shuts down the voice processing.</TD>
\r
281 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
282 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
283 <CODE> void</CODE></FONT></TD>
\r
284 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#dump(java.io.PrintWriter, int, java.lang.String)">dump</A></B>(java.io.PrintWriter output,
286 java.lang.String title)</CODE>
\r
289 Dumps the voice in textual form.</TD>
\r
291 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
292 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
293 <CODE> void</CODE></FONT></TD>
\r
294 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#dumpProcessors(java.io.PrintWriter, int, java.lang.String)">dumpProcessors</A></B>(java.io.PrintWriter output,
296 java.lang.String title)</CODE>
\r
299 Dumps the voice processors.</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/freetts/Voice.html#endBatch()">endBatch</A></B>()</CODE>
\r
307 Ends a batch of utterances.</TD>
\r
309 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
310 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
311 <CODE> <A HREF="../../../../com/sun/speech/freetts/Age.html" title="class in com.sun.speech.freetts">Age</A></CODE></FONT></TD>
\r
312 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getAge()">getAge</A></B>()</CODE>
\r
315 Get the age of this voice.</TD>
\r
317 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
318 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
319 <CODE>protected abstract <A HREF="../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface in com.sun.speech.freetts">UtteranceProcessor</A></CODE></FONT></TD>
\r
320 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getAudioOutput()">getAudioOutput</A></B>()</CODE>
\r
323 Returns the AudioOutput processor to be used by this voice.
326 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
327 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
328 <CODE> <A HREF="../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></FONT></TD>
\r
329 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getAudioPlayer()">getAudioPlayer</A></B>()</CODE>
\r
332 Gets the audio player associated with this voice. </TD>
\r
334 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
335 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
336 <CODE> <A HREF="../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></FONT></TD>
\r
337 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getDefaultAudioPlayer()">getDefaultAudioPlayer</A></B>()</CODE>
\r
340 Gets the default audio player for this voice. </TD>
\r
342 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
343 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
344 <CODE> java.lang.String</CODE></FONT></TD>
\r
345 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getDescription()">getDescription</A></B>()</CODE>
\r
348 Get the description of this voice.</TD>
\r
350 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
351 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
352 <CODE> java.lang.String</CODE></FONT></TD>
\r
353 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getDomain()">getDomain</A></B>()</CODE>
\r
356 Get the domain of this voice.</TD>
\r
358 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
359 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
360 <CODE> float</CODE></FONT></TD>
\r
361 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getDurationStretch()">getDurationStretch</A></B>()</CODE>
\r
364 Gets the duration Stretch</TD>
\r
366 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
367 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
368 <CODE> <A HREF="../../../../com/sun/speech/freetts/FeatureProcessor.html" title="interface in com.sun.speech.freetts">FeatureProcessor</A></CODE></FONT></TD>
\r
369 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getFeatureProcessor(java.lang.String)">getFeatureProcessor</A></B>(java.lang.String name)</CODE>
\r
372 Returns a language/voice specific Feature Processor.</TD>
\r
374 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
375 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
376 <CODE> <A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A></CODE></FONT></TD>
\r
377 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getFeatures()">getFeatures</A></B>()</CODE>
\r
380 Returns the feature set associated with this voice.</TD>
\r
382 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
383 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
384 <CODE> <A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A></CODE></FONT></TD>
\r
385 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getGender()">getGender</A></B>()</CODE>
\r
388 Get the gender of this voice.</TD>
\r
390 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
391 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
392 <CODE> <A HREF="../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A></CODE></FONT></TD>
\r
393 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getLexicon()">getLexicon</A></B>()</CODE>
\r
396 Gets the lexicon for this voice.</TD>
\r
398 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
399 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
400 <CODE> java.util.Locale</CODE></FONT></TD>
\r
401 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getLocale()">getLocale</A></B>()</CODE>
\r
404 Get the locale of this voice.</TD>
\r
406 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
407 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
408 <CODE> java.lang.String</CODE></FONT></TD>
\r
409 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getName()">getName</A></B>()</CODE>
\r
412 Get the name of this voice.</TD>
\r
414 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
415 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
416 <CODE> java.lang.String</CODE></FONT></TD>
\r
417 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getOrganization()">getOrganization</A></B>()</CODE>
\r
420 Gets the organization which created this voice. </TD>
\r
422 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
423 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
424 <CODE> <A HREF="../../../../com/sun/speech/freetts/OutputQueue.html" title="class in com.sun.speech.freetts">OutputQueue</A></CODE></FONT></TD>
\r
425 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getOutputQueue()">getOutputQueue</A></B>()</CODE>
\r
428 Returns the output queue associated with this voice.</TD>
\r
430 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
431 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
432 <CODE> java.lang.String</CODE></FONT></TD>
\r
433 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getPhoneFeature(java.lang.String, java.lang.String)">getPhoneFeature</A></B>(java.lang.String phone,
434 java.lang.String featureName)</CODE>
\r
437 Given a phoneme and a feature name, returns the feature.</TD>
\r
439 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
440 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
441 <CODE> float</CODE></FONT></TD>
\r
442 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getPitch()">getPitch</A></B>()</CODE>
\r
445 Retreives the baseline pitch.</TD>
\r
447 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
448 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
449 <CODE> float</CODE></FONT></TD>
\r
450 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getPitchRange()">getPitchRange</A></B>()</CODE>
\r
453 Gets the pitch range.</TD>
\r
455 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
456 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
457 <CODE> float</CODE></FONT></TD>
\r
458 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getPitchShift()">getPitchShift</A></B>()</CODE>
\r
461 Gets the pitch shift.</TD>
\r
463 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
464 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
465 <CODE> float</CODE></FONT></TD>
\r
466 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getRate()">getRate</A></B>()</CODE>
\r
469 Gets the rate of speech.</TD>
\r
471 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
472 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
473 <CODE>protected java.net.URL</CODE></FONT></TD>
\r
474 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getResource(java.lang.String)">getResource</A></B>(java.lang.String resource)</CODE>
\r
477 Get a resource for this voice.
480 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
481 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
482 <CODE> java.lang.String</CODE></FONT></TD>
\r
483 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getRunTitle()">getRunTitle</A></B>()</CODE>
\r
486 Gets the title for this run.</TD>
\r
488 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
489 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
490 <CODE> java.lang.String</CODE></FONT></TD>
\r
491 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getStyle()">getStyle</A></B>()</CODE>
\r
494 Gets the voice style. </TD>
\r
496 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
497 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
498 <CODE>abstract <A HREF="../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A></CODE></FONT></TD>
\r
499 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getTokenizer()">getTokenizer</A></B>()</CODE>
\r
502 Returns the tokenizer associated with this voice.</TD>
\r
504 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
505 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
506 <CODE> java.util.List</CODE></FONT></TD>
\r
507 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getUtteranceProcessors()">getUtteranceProcessors</A></B>()</CODE>
\r
510 Return the list of UtteranceProcessor instances. </TD>
\r
512 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
513 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
514 <CODE> float</CODE></FONT></TD>
\r
515 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getVolume()">getVolume</A></B>()</CODE>
\r
518 Gets the volume.</TD>
\r
520 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
521 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
522 <CODE> java.lang.String</CODE></FONT></TD>
\r
523 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#getWaveDumpFile()">getWaveDumpFile</A></B>()</CODE>
\r
526 Gets the dumpfile for this voice.</TD>
\r
528 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
529 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
530 <CODE> boolean</CODE></FONT></TD>
\r
531 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#isDetailedMetrics()">isDetailedMetrics</A></B>()</CODE>
\r
534 Gets the state of the detailedMetrics mode.</TD>
\r
536 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
537 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
538 <CODE> boolean</CODE></FONT></TD>
\r
539 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#isDumpRelations()">isDumpRelations</A></B>()</CODE>
\r
542 Gets the state of the dumpRelations mode.</TD>
\r
544 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
545 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
546 <CODE> boolean</CODE></FONT></TD>
\r
547 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#isDumpUtterance()">isDumpUtterance</A></B>()</CODE>
\r
550 Gets the state of the dumpUtterance mode.</TD>
\r
552 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
553 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
554 <CODE> boolean</CODE></FONT></TD>
\r
555 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#isLoaded()">isLoaded</A></B>()</CODE>
\r
558 Returns true if this voice is loaded.</TD>
\r
560 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
561 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
562 <CODE> boolean</CODE></FONT></TD>
\r
563 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#isMetrics()">isMetrics</A></B>()</CODE>
\r
566 Gets the state of the metrics mode.</TD>
\r
568 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
569 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
570 <CODE> void</CODE></FONT></TD>
\r
571 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#load()">load</A></B>()</CODE>
\r
574 <B>Deprecated.</B> <I>As of FreeTTS 1.2, replaced by <A HREF="../../../../com/sun/speech/freetts/Voice.html#allocate()"><CODE>allocate()</CODE></A>.</I></TD>
\r
576 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
577 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
578 <CODE>protected abstract void</CODE></FONT></TD>
\r
579 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#loader()">loader</A></B>()</CODE>
\r
582 Loads voice specific data. </TD>
\r
584 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
585 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
586 <CODE>protected java.lang.StringBuffer</CODE></FONT></TD>
\r
587 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#processNode(org.w3c.dom.Node, java.lang.StringBuffer)">processNode</A></B>(org.w3c.dom.Node n,
588 java.lang.StringBuffer buf)</CODE>
\r
591 Adds text for just this node and returns any text that might
592 be needed to undo the effects of this node after it is
595 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
596 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
597 <CODE> void</CODE></FONT></TD>
\r
598 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#processUtterance(com.sun.speech.freetts.Utterance)">processUtterance</A></B>(<A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A> u)</CODE>
\r
601 Processes the given Utterance by passing it to each
602 UtteranceProcessor managed by this Voice. </TD>
\r
604 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
605 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
606 <CODE>protected void</CODE></FONT></TD>
\r
607 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setAge(com.sun.speech.freetts.Age)">setAge</A></B>(<A HREF="../../../../com/sun/speech/freetts/Age.html" title="class in com.sun.speech.freetts">Age</A> age)</CODE>
\r
610 Set the age of this voice.</TD>
\r
612 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
613 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
614 <CODE> void</CODE></FONT></TD>
\r
615 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setAudioPlayer(com.sun.speech.freetts.audio.AudioPlayer)">setAudioPlayer</A></B>(<A HREF="../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A> player)</CODE>
\r
618 Sets the audio player associated with this voice. </TD>
\r
620 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
621 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
622 <CODE>protected void</CODE></FONT></TD>
\r
623 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String description)</CODE>
\r
626 Set the description of this voice.</TD>
\r
628 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
629 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
630 <CODE> void</CODE></FONT></TD>
\r
631 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setDetailedMetrics(boolean)">setDetailedMetrics</A></B>(boolean detailedMetrics)</CODE>
\r
634 Sets the state of the detailedMetrics mode.</TD>
\r
636 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
637 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
638 <CODE>protected void</CODE></FONT></TD>
\r
639 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setDomain(java.lang.String)">setDomain</A></B>(java.lang.String domain)</CODE>
\r
642 Set the domain of this voice.</TD>
\r
644 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
645 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
646 <CODE> void</CODE></FONT></TD>
\r
647 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setDumpRelations(boolean)">setDumpRelations</A></B>(boolean dumpRelations)</CODE>
\r
650 Sets the state of the dumpRelations mode.</TD>
\r
652 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
653 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
654 <CODE> void</CODE></FONT></TD>
\r
655 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setDumpUtterance(boolean)">setDumpUtterance</A></B>(boolean dumpUtterance)</CODE>
\r
658 Sets the state of the dumpUtterance mode.</TD>
\r
660 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
661 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
662 <CODE> void</CODE></FONT></TD>
\r
663 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setDurationStretch(float)">setDurationStretch</A></B>(float stretch)</CODE>
\r
666 Sets the duration stretch</TD>
\r
668 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
669 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
670 <CODE>protected void</CODE></FONT></TD>
\r
671 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setGender(com.sun.speech.freetts.Gender)">setGender</A></B>(<A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A> gender)</CODE>
\r
674 Set the gender of this voice.</TD>
\r
676 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
677 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
678 <CODE> void</CODE></FONT></TD>
\r
679 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setLexicon(com.sun.speech.freetts.lexicon.Lexicon)">setLexicon</A></B>(<A HREF="../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A> lexicon)</CODE>
\r
682 Sets the lexicon to be used by this voice.</TD>
\r
684 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
685 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
686 <CODE>protected void</CODE></FONT></TD>
\r
687 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setLoaded(boolean)">setLoaded</A></B>(boolean loaded)</CODE>
\r
690 Sets the loaded state</TD>
\r
692 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
693 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
694 <CODE>protected void</CODE></FONT></TD>
\r
695 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setLocale(java.util.Locale)">setLocale</A></B>(java.util.Locale locale)</CODE>
\r
698 Set the locale of this voice.</TD>
\r
700 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
701 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
702 <CODE> void</CODE></FONT></TD>
\r
703 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setMetrics(boolean)">setMetrics</A></B>(boolean metrics)</CODE>
\r
706 Sets the metrics mode.</TD>
\r
708 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
709 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
710 <CODE>protected void</CODE></FONT></TD>
\r
711 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setName(java.lang.String)">setName</A></B>(java.lang.String name)</CODE>
\r
714 Set the name of this voice.
717 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
718 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
719 <CODE>protected void</CODE></FONT></TD>
\r
720 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setOrganization(java.lang.String)">setOrganization</A></B>(java.lang.String organization)</CODE>
\r
723 Sets the organization which created this voice. </TD>
\r
725 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
726 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
727 <CODE> void</CODE></FONT></TD>
\r
728 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setOutputQueue(com.sun.speech.freetts.OutputQueue)">setOutputQueue</A></B>(<A HREF="../../../../com/sun/speech/freetts/OutputQueue.html" title="class in com.sun.speech.freetts">OutputQueue</A> queue)</CODE>
\r
731 Sets the output queue for this voice. </TD>
\r
733 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
734 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
735 <CODE> void</CODE></FONT></TD>
\r
736 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setPitch(float)">setPitch</A></B>(float hertz)</CODE>
\r
739 Sets the baseline pitch.</TD>
\r
741 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
742 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
743 <CODE> void</CODE></FONT></TD>
\r
744 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setPitchRange(float)">setPitchRange</A></B>(float range)</CODE>
\r
747 Sets the pitch range.</TD>
\r
749 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
750 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
751 <CODE> void</CODE></FONT></TD>
\r
752 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setPitchShift(float)">setPitchShift</A></B>(float shift)</CODE>
\r
755 Sets the pitch shift</TD>
\r
757 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
758 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
759 <CODE> void</CODE></FONT></TD>
\r
760 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setRate(float)">setRate</A></B>(float wpm)</CODE>
\r
763 Sets the rate of speech.</TD>
\r
765 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
766 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
767 <CODE> void</CODE></FONT></TD>
\r
768 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setRunTitle(java.lang.String)">setRunTitle</A></B>(java.lang.String runTitle)</CODE>
\r
771 Sets the title for this run.</TD>
\r
773 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
774 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
775 <CODE> void</CODE></FONT></TD>
\r
776 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setStyle(java.lang.String)">setStyle</A></B>(java.lang.String style)</CODE>
\r
779 Sets the voice style. </TD>
\r
781 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
782 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
783 <CODE> void</CODE></FONT></TD>
\r
784 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setVolume(float)">setVolume</A></B>(float vol)</CODE>
\r
787 Sets the volume.</TD>
\r
789 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
790 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
791 <CODE> void</CODE></FONT></TD>
\r
792 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#setWaveDumpFile(java.lang.String)">setWaveDumpFile</A></B>(java.lang.String waveDumpFile)</CODE>
\r
795 Sets the dumpfile for this voice.</TD>
\r
797 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
798 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
799 <CODE> boolean</CODE></FONT></TD>
\r
800 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#speak(org.w3c.dom.Document)">speak</A></B>(org.w3c.dom.Document doc)</CODE>
\r
803 Speaks the given document.</TD>
\r
805 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
806 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
807 <CODE> boolean</CODE></FONT></TD>
\r
808 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#speak(com.sun.speech.freetts.FreeTTSSpeakable)">speak</A></B>(<A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A> speakable)</CODE>
\r
811 Speak the given queue item. </TD>
\r
813 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
814 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
815 <CODE> boolean</CODE></FONT></TD>
\r
816 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#speak(java.io.InputStream)">speak</A></B>(java.io.InputStream inputStream)</CODE>
\r
819 Speaks the input stream.</TD>
\r
821 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
822 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
823 <CODE> boolean</CODE></FONT></TD>
\r
824 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#speak(java.lang.String)">speak</A></B>(java.lang.String text)</CODE>
\r
827 Speaks the given text.</TD>
\r
829 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
830 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
831 <CODE> void</CODE></FONT></TD>
\r
832 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#startBatch()">startBatch</A></B>()</CODE>
\r
835 Starts a batch of utterances. </TD>
\r
837 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
838 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
839 <CODE> java.lang.String</CODE></FONT></TD>
\r
840 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Voice.html#toString()">toString</A></B>()</CODE>
\r
843 Returns the name of this Voice.</TD>
\r
846 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
847 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
848 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
849 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
851 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
852 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
858 <!-- ============ FIELD DETAIL =========== -->
\r
860 <A NAME="field_detail"><!-- --></A>
861 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
862 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
863 <TD COLSPAN=1><FONT SIZE="+2">
\r
864 <B>Field Detail</B></FONT></TD>
\r
868 <A NAME="DATABASE_NAME"><!-- --></A><H3>
\r
871 public static final java.lang.String <B>DATABASE_NAME</B></PRE>
\r
873 <DD>Constant that describes the name of the unit database used by
877 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.freetts.Voice.DATABASE_NAME">Constant Field Values</A></DL>
\r
881 <A NAME="PROP_PREFIX"><!-- --></A><H3>
\r
884 public static final java.lang.String <B>PROP_PREFIX</B></PRE>
\r
886 <DD>Prefix for System property names.
\r
889 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.freetts.Voice.PROP_PREFIX">Constant Field Values</A></DL>
\r
893 <A NAME="FEATURE_SILENCE"><!-- --></A><H3>
\r
894 FEATURE_SILENCE</H3>
\r
896 public static final java.lang.String <B>FEATURE_SILENCE</B></PRE>
\r
898 <DD>Feature name for the silence phone string.
\r
901 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.freetts.Voice.FEATURE_SILENCE">Constant Field Values</A></DL>
\r
905 <A NAME="FEATURE_JOIN_TYPE"><!-- --></A><H3>
\r
906 FEATURE_JOIN_TYPE</H3>
\r
908 public static final java.lang.String <B>FEATURE_JOIN_TYPE</B></PRE>
\r
910 <DD>Feature name for the join type string.
\r
913 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.freetts.Voice.FEATURE_JOIN_TYPE">Constant Field Values</A></DL>
\r
917 <A NAME="DEFAULT_AUDIO_PLAYER"><!-- --></A><H3>
\r
918 DEFAULT_AUDIO_PLAYER</H3>
\r
920 public static final java.lang.String <B>DEFAULT_AUDIO_PLAYER</B></PRE>
\r
922 <DD>Feature name for the default AudioPlayer class to use.
\r
925 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.freetts.Voice.DEFAULT_AUDIO_PLAYER">Constant Field Values</A></DL>
\r
929 <A NAME="DEFAULT_AUDIO_PLAYER_DEFAULT"><!-- --></A><H3>
\r
930 DEFAULT_AUDIO_PLAYER_DEFAULT</H3>
\r
932 public static final java.lang.String <B>DEFAULT_AUDIO_PLAYER_DEFAULT</B></PRE>
\r
934 <DD>The default class to use for the DEFAULT_AUDIO_PLAYER.
\r
937 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.freetts.Voice.DEFAULT_AUDIO_PLAYER_DEFAULT">Constant Field Values</A></DL>
\r
940 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
942 <A NAME="constructor_detail"><!-- --></A>
943 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
944 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
945 <TD COLSPAN=1><FONT SIZE="+2">
\r
946 <B>Constructor Detail</B></FONT></TD>
\r
950 <A NAME="Voice()"><!-- --></A><H3>
\r
953 public <B>Voice</B>()</PRE>
\r
955 <DD>Creates a new Voice. Utterances are sent to an
956 output queue to be rendered as audio. Utterances are placed
957 on the queue by an output thread. This
958 queue is usually created via a call to 'createOutputThread,'
959 which creates a thread that waits on the queue and sends the
960 output to the audio player associated with this voice. If
961 the queue is null, the output is rendered in the calling
964 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Voice.html#createOutputThread()"><CODE>createOutputThread()</CODE></A></DL>
\r
967 <A NAME="Voice(java.lang.String, com.sun.speech.freetts.Gender, com.sun.speech.freetts.Age, java.lang.String, java.util.Locale, java.lang.String, java.lang.String)"><!-- --></A><H3>
\r
970 public <B>Voice</B>(java.lang.String name,
971 <A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A> gender,
972 <A HREF="../../../../com/sun/speech/freetts/Age.html" title="class in com.sun.speech.freetts">Age</A> age,
973 java.lang.String description,
974 java.util.Locale locale,
975 java.lang.String domain,
976 java.lang.String organization)</PRE>
\r
978 <DD>Creates a new Voice like above, except that it also
979 stores the properties of the voice.
\r
981 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the voice<DD><CODE>gender</CODE> - the gender of the voice<DD><CODE>age</CODE> - the age of the voice<DD><CODE>description</CODE> - a human-readable string providing a
982 description that can be displayed for the users.<DD><CODE>locale</CODE> - the locale of the voice<DD><CODE>domain</CODE> - the domain of this voice. For example,<DD><CODE>organization</CODE> - the organization which created the voice
983 "general", "time", or
984 "weather".<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Voice.html#Voice()"><CODE>Voice()</CODE></A></DL>
\r
986 <!-- ============ METHOD DETAIL ========== -->
\r
988 <A NAME="method_detail"><!-- --></A>
989 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
990 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
991 <TD COLSPAN=1><FONT SIZE="+2">
\r
992 <B>Method Detail</B></FONT></TD>
\r
996 <A NAME="speak(java.lang.String)"><!-- --></A><H3>
\r
999 public boolean <B>speak</B>(java.lang.String text)</PRE>
\r
1001 <DD>Speaks the given text.
\r
1007 <DT><B>Parameters:</B><DD><CODE>text</CODE> - the text to speak
1008 <DT><B>Returns:</B><DD><code>true</code> if the given text is spoken properly;
1009 otherwise <code>false</code></DL>
\r
1014 <A NAME="speak(org.w3c.dom.Document)"><!-- --></A><H3>
\r
1017 public boolean <B>speak</B>(org.w3c.dom.Document doc)</PRE>
\r
1019 <DD>Speaks the given document.
\r
1025 <DT><B>Parameters:</B><DD><CODE>doc</CODE> - the JSML document to speak
1026 <DT><B>Returns:</B><DD><code>true</code> if the given document is spoken properly;
1027 otherwise <code>false</code></DL>
\r
1032 <A NAME="speak(java.io.InputStream)"><!-- --></A><H3>
\r
1035 public boolean <B>speak</B>(java.io.InputStream inputStream)</PRE>
\r
1037 <DD>Speaks the input stream.
\r
1043 <DT><B>Parameters:</B><DD><CODE>inputStream</CODE> - the inputStream to speak
1044 <DT><B>Returns:</B><DD><code>true</code> if the given input stream is spoken properly;
1045 otherwise <code>false</code></DL>
\r
1050 <A NAME="speak(com.sun.speech.freetts.FreeTTSSpeakable)"><!-- --></A><H3>
\r
1053 public boolean <B>speak</B>(<A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts">FreeTTSSpeakable</A> speakable)</PRE>
\r
1055 <DD>Speak the given queue item. This is a synchronous method that
1056 does not return until the speakable is completely
1057 spoken or has been cancelled.
\r
1063 <DT><B>Parameters:</B><DD><CODE>speakable</CODE> - the item to speak
1064 <DT><B>Returns:</B><DD><code>true</code> if the utterance was spoken properly,
1065 <code>false</code> otherwise</DL>
\r
1070 <A NAME="load()"><!-- --></A><H3>
\r
1073 public void <B>load</B>()</PRE>
\r
1075 <DD><B>Deprecated.</B> <I>As of FreeTTS 1.2, replaced by <A HREF="../../../../com/sun/speech/freetts/Voice.html#allocate()"><CODE>allocate()</CODE></A>.</I>
\r
1086 <A NAME="allocate()"><!-- --></A><H3>
\r
1089 public void <B>allocate</B>()</PRE>
\r
1091 <DD>Allocate this Voice. It loads the lexicon and the
1092 audio output handler, and creates an audio output thread by
1093 invoking <code>createOutputThread()</code>, if
1094 one is not already created. It then calls the <code>loader()</code>
1095 method to load Voice-specific data, which include utterance processors.
\r
1106 <A NAME="isLoaded()"><!-- --></A><H3>
\r
1109 public boolean <B>isLoaded</B>()</PRE>
\r
1111 <DD>Returns true if this voice is loaded.
\r
1118 <DT><B>Returns:</B><DD><code>true</code> if the voice is loaded;
1119 otherwise <code>false</code></DL>
\r
1124 <A NAME="setLoaded(boolean)"><!-- --></A><H3>
\r
1127 protected void <B>setLoaded</B>(boolean loaded)</PRE>
\r
1129 <DD>Sets the loaded state
\r
1135 <DT><B>Parameters:</B><DD><CODE>loaded</CODE> - the new loaded state
1136 otherwise <code>false</code></DL>
\r
1141 <A NAME="processUtterance(com.sun.speech.freetts.Utterance)"><!-- --></A><H3>
\r
1142 processUtterance</H3>
\r
1144 public void <B>processUtterance</B>(<A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A> u)
1145 throws <A HREF="../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></PRE>
\r
1147 <DD>Processes the given Utterance by passing it to each
1148 UtteranceProcessor managed by this Voice. The
1149 UtteranceProcessors are called in the order they were added to
1153 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/UtteranceProcessor.html#processUtterance(com.sun.speech.freetts.Utterance)">processUtterance</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface in com.sun.speech.freetts">UtteranceProcessor</A></CODE></DL>
\r
1156 <DT><B>Parameters:</B><DD><CODE>u</CODE> - the Utterance to process
1158 <DD><CODE><A HREF="../../../../com/sun/speech/freetts/ProcessException.html" title="class in com.sun.speech.freetts">ProcessException</A></CODE> - if an exception occurred while performing
1159 operations on the Utterance</DL>
\r
1164 <A NAME="createOutputThread()"><!-- --></A><H3>
\r
1165 createOutputThread</H3>
\r
1167 public static <A HREF="../../../../com/sun/speech/freetts/OutputQueue.html" title="class in com.sun.speech.freetts">OutputQueue</A> <B>createOutputThread</B>()</PRE>
\r
1169 <DD>Creates an output thread that will asynchronously
1170 output utterances that are generated by this voice (and other
1178 <DT><B>Returns:</B><DD>the queue where utterances should be placed.</DL>
\r
1183 <A NAME="getTokenizer()"><!-- --></A><H3>
\r
1186 public abstract <A HREF="../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts">Tokenizer</A> <B>getTokenizer</B>()</PRE>
\r
1188 <DD>Returns the tokenizer associated with this voice.
\r
1195 <DT><B>Returns:</B><DD>the tokenizer</DL>
\r
1200 <A NAME="getUtteranceProcessors()"><!-- --></A><H3>
\r
1201 getUtteranceProcessors</H3>
\r
1203 public java.util.List <B>getUtteranceProcessors</B>()</PRE>
\r
1205 <DD>Return the list of UtteranceProcessor instances. Applications
1206 should use this to obtain and modify the contents of the
1207 UtteranceProcessor list.
\r
1214 <DT><B>Returns:</B><DD>a List containing UtteranceProcessor instances</DL>
\r
1219 <A NAME="getFeatures()"><!-- --></A><H3>
\r
1222 public <A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts">FeatureSet</A> <B>getFeatures</B>()</PRE>
\r
1224 <DD>Returns the feature set associated with this voice.
\r
1231 <DT><B>Returns:</B><DD>the feature set.</DL>
\r
1236 <A NAME="startBatch()"><!-- --></A><H3>
\r
1239 public void <B>startBatch</B>()</PRE>
\r
1241 <DD>Starts a batch of utterances. Utterances are sometimes
1242 batched in groups for timing purposes.
\r
1248 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Voice.html#endBatch()"><CODE>endBatch()</CODE></A></DL>
\r
1253 <A NAME="endBatch()"><!-- --></A><H3>
\r
1256 public void <B>endBatch</B>()</PRE>
\r
1258 <DD>Ends a batch of utterances.
\r
1264 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Voice.html#startBatch()"><CODE>startBatch()</CODE></A></DL>
\r
1269 <A NAME="setOutputQueue(com.sun.speech.freetts.OutputQueue)"><!-- --></A><H3>
\r
1270 setOutputQueue</H3>
\r
1272 public void <B>setOutputQueue</B>(<A HREF="../../../../com/sun/speech/freetts/OutputQueue.html" title="class in com.sun.speech.freetts">OutputQueue</A> queue)</PRE>
\r
1274 <DD>Sets the output queue for this voice. If no output queue is set
1275 for the voice when the voice is loaded, a queue and thread will
1276 be created when the voice is loaded. If the outputQueue is set
1277 by an external entity by calling setOutputQueue, the caller is
1278 responsible for shutting down the output thread. That is, if
1279 you call 'setOutputQueue' then you are responsible for shutting
1280 down the output thread on your own. This is necessary since the
1281 output queue may be shared by a number of voices.
1283 <p>Utterances are placed on the
1284 queue to be output by an output thread. This queue is
1285 usually created via a call to 'createOutputThread' which
1286 creates a thread that waits on the queue and sends the
1287 output to the audio player associated with this voice. If
1288 the queue is null, the output is rendered in the calling
1295 <DT><B>Parameters:</B><DD><CODE>queue</CODE> - the output queue</DL>
\r
1300 <A NAME="getOutputQueue()"><!-- --></A><H3>
\r
1301 getOutputQueue</H3>
\r
1303 public <A HREF="../../../../com/sun/speech/freetts/OutputQueue.html" title="class in com.sun.speech.freetts">OutputQueue</A> <B>getOutputQueue</B>()</PRE>
\r
1305 <DD>Returns the output queue associated with this voice.
\r
1312 <DT><B>Returns:</B><DD>the output queue associated with this voice</DL>
\r
1317 <A NAME="loader()"><!-- --></A><H3>
\r
1320 protected abstract void <B>loader</B>()
1321 throws java.io.IOException</PRE>
\r
1323 <DD>Loads voice specific data. Subclasses of voice should
1324 implement this to perform class specific loading.
\r
1332 <DD><CODE>java.io.IOException</CODE></DL>
\r
1337 <A NAME="processNode(org.w3c.dom.Node, java.lang.StringBuffer)"><!-- --></A><H3>
\r
1340 protected java.lang.StringBuffer <B>processNode</B>(org.w3c.dom.Node n,
1341 java.lang.StringBuffer buf)</PRE>
\r
1343 <DD>Adds text for just this node and returns any text that might
1344 be needed to undo the effects of this node after it is
1351 <DT><B>Parameters:</B><DD><CODE>n</CODE> - the node to traverse in depth-first order<DD><CODE>buf</CODE> - the buffer to append text to
1352 <DT><B>Returns:</B><DD>a <code>String</code> containing text to undo the
1353 effects of the node</DL>
\r
1358 <A NAME="dump(java.io.PrintWriter, int, java.lang.String)"><!-- --></A><H3>
\r
1361 public void <B>dump</B>(java.io.PrintWriter output,
1363 java.lang.String title)</PRE>
\r
1365 <DD>Dumps the voice in textual form.
\r
1368 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/Dumpable.html#dump(java.io.PrintWriter, int, java.lang.String)">dump</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/Dumpable.html" title="interface in com.sun.speech.freetts">Dumpable</A></CODE></DL>
\r
1371 <DT><B>Parameters:</B><DD><CODE>output</CODE> - where to send the formatted output<DD><CODE>pad</CODE> - the initial padding<DD><CODE>title</CODE> - the title to print when dumping out</DL>
\r
1376 <A NAME="dumpProcessors(java.io.PrintWriter, int, java.lang.String)"><!-- --></A><H3>
\r
1377 dumpProcessors</H3>
\r
1379 public void <B>dumpProcessors</B>(java.io.PrintWriter output,
1381 java.lang.String title)</PRE>
\r
1383 <DD>Dumps the voice processors.
\r
1389 <DT><B>Parameters:</B><DD><CODE>output</CODE> - where to send the formatted output<DD><CODE>pad</CODE> - the initial padding<DD><CODE>title</CODE> - the title to print when dumping out</DL>
\r
1394 <A NAME="getFeatureProcessor(java.lang.String)"><!-- --></A><H3>
\r
1395 getFeatureProcessor</H3>
\r
1397 public <A HREF="../../../../com/sun/speech/freetts/FeatureProcessor.html" title="interface in com.sun.speech.freetts">FeatureProcessor</A> <B>getFeatureProcessor</B>(java.lang.String name)</PRE>
\r
1399 <DD>Returns a language/voice specific Feature Processor.
\r
1405 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the processor
1406 <DT><B>Returns:</B><DD>the processor associated with the name or null if none
1407 could be found</DL>
\r
1412 <A NAME="addFeatureProcessor(java.lang.String, com.sun.speech.freetts.FeatureProcessor)"><!-- --></A><H3>
\r
1413 addFeatureProcessor</H3>
\r
1415 public void <B>addFeatureProcessor</B>(java.lang.String name,
1416 <A HREF="../../../../com/sun/speech/freetts/FeatureProcessor.html" title="interface in com.sun.speech.freetts">FeatureProcessor</A> fp)</PRE>
\r
1418 <DD>Adds a language/voice specific Feature Processor to the set of
1419 FeatureProcessors supported by this voice.
\r
1425 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the processor<DD><CODE>fp</CODE> - the processor</DL>
\r
1430 <A NAME="isMetrics()"><!-- --></A><H3>
\r
1433 public boolean <B>isMetrics</B>()</PRE>
\r
1435 <DD>Gets the state of the metrics mode.
\r
1442 <DT><B>Returns:</B><DD>true if metrics mode is on</DL>
\r
1447 <A NAME="setMetrics(boolean)"><!-- --></A><H3>
\r
1450 public void <B>setMetrics</B>(boolean metrics)</PRE>
\r
1452 <DD>Sets the metrics mode.
\r
1458 <DT><B>Parameters:</B><DD><CODE>metrics</CODE> - true if metrics mode should be on</DL>
\r
1463 <A NAME="isDetailedMetrics()"><!-- --></A><H3>
\r
1464 isDetailedMetrics</H3>
\r
1466 public boolean <B>isDetailedMetrics</B>()</PRE>
\r
1468 <DD>Gets the state of the detailedMetrics mode.
\r
1475 <DT><B>Returns:</B><DD>true if detailedMetrics mode is on</DL>
\r
1480 <A NAME="setDetailedMetrics(boolean)"><!-- --></A><H3>
\r
1481 setDetailedMetrics</H3>
\r
1483 public void <B>setDetailedMetrics</B>(boolean detailedMetrics)</PRE>
\r
1485 <DD>Sets the state of the detailedMetrics mode.
\r
1491 <DT><B>Parameters:</B><DD><CODE>detailedMetrics</CODE> - true if detailedMetrics mode should be on</DL>
\r
1496 <A NAME="isDumpUtterance()"><!-- --></A><H3>
\r
1497 isDumpUtterance</H3>
\r
1499 public boolean <B>isDumpUtterance</B>()</PRE>
\r
1501 <DD>Gets the state of the dumpUtterance mode.
\r
1508 <DT><B>Returns:</B><DD>true if dumpUtterance mode is on</DL>
\r
1513 <A NAME="setDumpUtterance(boolean)"><!-- --></A><H3>
\r
1514 setDumpUtterance</H3>
\r
1516 public void <B>setDumpUtterance</B>(boolean dumpUtterance)</PRE>
\r
1518 <DD>Sets the state of the dumpUtterance mode.
\r
1524 <DT><B>Parameters:</B><DD><CODE>dumpUtterance</CODE> - true if dumpUtterance mode should be on</DL>
\r
1529 <A NAME="isDumpRelations()"><!-- --></A><H3>
\r
1530 isDumpRelations</H3>
\r
1532 public boolean <B>isDumpRelations</B>()</PRE>
\r
1534 <DD>Gets the state of the dumpRelations mode.
\r
1541 <DT><B>Returns:</B><DD>true if dumpRelations mode is on</DL>
\r
1546 <A NAME="setDumpRelations(boolean)"><!-- --></A><H3>
\r
1547 setDumpRelations</H3>
\r
1549 public void <B>setDumpRelations</B>(boolean dumpRelations)</PRE>
\r
1551 <DD>Sets the state of the dumpRelations mode.
\r
1557 <DT><B>Parameters:</B><DD><CODE>dumpRelations</CODE> - true if dumpRelations mode should be on</DL>
\r
1562 <A NAME="setRunTitle(java.lang.String)"><!-- --></A><H3>
\r
1565 public void <B>setRunTitle</B>(java.lang.String runTitle)</PRE>
\r
1567 <DD>Sets the title for this run.
\r
1573 <DT><B>Parameters:</B><DD><CODE>runTitle</CODE> - the title for the run</DL>
\r
1578 <A NAME="getRunTitle()"><!-- --></A><H3>
\r
1581 public java.lang.String <B>getRunTitle</B>()</PRE>
\r
1583 <DD>Gets the title for this run.
\r
1590 <DT><B>Returns:</B><DD>the title for the run</DL>
\r
1595 <A NAME="getPhoneFeature(java.lang.String, java.lang.String)"><!-- --></A><H3>
\r
1596 getPhoneFeature</H3>
\r
1598 public java.lang.String <B>getPhoneFeature</B>(java.lang.String phone,
1599 java.lang.String featureName)</PRE>
\r
1601 <DD>Given a phoneme and a feature name, returns the feature.
\r
1607 <DT><B>Parameters:</B><DD><CODE>phone</CODE> - the phoneme of interest<DD><CODE>featureName</CODE> - the name of the feature of interest
1608 <DT><B>Returns:</B><DD>the feature with the given name</DL>
\r
1613 <A NAME="deallocate()"><!-- --></A><H3>
\r
1616 public void <B>deallocate</B>()</PRE>
\r
1618 <DD>Shuts down the voice processing.
\r
1629 <A NAME="setPitch(float)"><!-- --></A><H3>
\r
1632 public void <B>setPitch</B>(float hertz)</PRE>
\r
1634 <DD>Sets the baseline pitch.
\r
1640 <DT><B>Parameters:</B><DD><CODE>hertz</CODE> - the baseline pitch in hertz</DL>
\r
1645 <A NAME="getPitch()"><!-- --></A><H3>
\r
1648 public float <B>getPitch</B>()</PRE>
\r
1650 <DD>Retreives the baseline pitch.
\r
1657 <DT><B>Returns:</B><DD>the baseline pitch in hertz</DL>
\r
1662 <A NAME="setPitchRange(float)"><!-- --></A><H3>
\r
1663 setPitchRange</H3>
\r
1665 public void <B>setPitchRange</B>(float range)</PRE>
\r
1667 <DD>Sets the pitch range.
\r
1673 <DT><B>Parameters:</B><DD><CODE>range</CODE> - the range in hertz</DL>
\r
1678 <A NAME="getPitchRange()"><!-- --></A><H3>
\r
1679 getPitchRange</H3>
\r
1681 public float <B>getPitchRange</B>()</PRE>
\r
1683 <DD>Gets the pitch range.
\r
1690 <DT><B>Returns:</B><DD>the range in hertz</DL>
\r
1695 <A NAME="setPitchShift(float)"><!-- --></A><H3>
\r
1696 setPitchShift</H3>
\r
1698 public void <B>setPitchShift</B>(float shift)</PRE>
\r
1700 <DD>Sets the pitch shift
\r
1706 <DT><B>Parameters:</B><DD><CODE>shift</CODE> - the pitch shift (1.0 is no shift)</DL>
\r
1711 <A NAME="getPitchShift()"><!-- --></A><H3>
\r
1712 getPitchShift</H3>
\r
1714 public float <B>getPitchShift</B>()</PRE>
\r
1716 <DD>Gets the pitch shift.
\r
1723 <DT><B>Returns:</B><DD>the pitch shift</DL>
\r
1728 <A NAME="setDurationStretch(float)"><!-- --></A><H3>
\r
1729 setDurationStretch</H3>
\r
1731 public void <B>setDurationStretch</B>(float stretch)</PRE>
\r
1733 <DD>Sets the duration stretch
\r
1739 <DT><B>Parameters:</B><DD><CODE>stretch</CODE> - the duration stretch (1.0 is no stretch)</DL>
\r
1744 <A NAME="getDurationStretch()"><!-- --></A><H3>
\r
1745 getDurationStretch</H3>
\r
1747 public float <B>getDurationStretch</B>()</PRE>
\r
1749 <DD>Gets the duration Stretch
\r
1756 <DT><B>Returns:</B><DD>the duration stretch</DL>
\r
1761 <A NAME="setRate(float)"><!-- --></A><H3>
\r
1764 public void <B>setRate</B>(float wpm)</PRE>
\r
1766 <DD>Sets the rate of speech.
\r
1772 <DT><B>Parameters:</B><DD><CODE>wpm</CODE> - words per minute</DL>
\r
1777 <A NAME="getRate()"><!-- --></A><H3>
\r
1780 public float <B>getRate</B>()</PRE>
\r
1782 <DD>Gets the rate of speech.
\r
1789 <DT><B>Returns:</B><DD>words per minute</DL>
\r
1794 <A NAME="setVolume(float)"><!-- --></A><H3>
\r
1797 public void <B>setVolume</B>(float vol)</PRE>
\r
1799 <DD>Sets the volume.
\r
1805 <DT><B>Parameters:</B><DD><CODE>vol</CODE> - the volume (0 to 1.0)</DL>
\r
1810 <A NAME="getVolume()"><!-- --></A><H3>
\r
1813 public float <B>getVolume</B>()</PRE>
\r
1815 <DD>Gets the volume.
\r
1822 <DT><B>Returns:</B><DD>the volume (0 to 1.0)</DL>
\r
1827 <A NAME="getLexicon()"><!-- --></A><H3>
\r
1830 public <A HREF="../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A> <B>getLexicon</B>()</PRE>
\r
1832 <DD>Gets the lexicon for this voice.
\r
1839 <DT><B>Returns:</B><DD>the lexicon (or null if there is no lexicon)</DL>
\r
1844 <A NAME="setLexicon(com.sun.speech.freetts.lexicon.Lexicon)"><!-- --></A><H3>
\r
1847 public void <B>setLexicon</B>(<A HREF="../../../../com/sun/speech/freetts/lexicon/Lexicon.html" title="interface in com.sun.speech.freetts.lexicon">Lexicon</A> lexicon)</PRE>
\r
1849 <DD>Sets the lexicon to be used by this voice.
\r
1855 <DT><B>Parameters:</B><DD><CODE>lexicon</CODE> - the lexicon to use</DL>
\r
1860 <A NAME="setWaveDumpFile(java.lang.String)"><!-- --></A><H3>
\r
1861 setWaveDumpFile</H3>
\r
1863 public void <B>setWaveDumpFile</B>(java.lang.String waveDumpFile)</PRE>
\r
1865 <DD>Sets the dumpfile for this voice.
\r
1871 <DT><B>Parameters:</B><DD><CODE>waveDumpFile</CODE> - the dumpfile</DL>
\r
1876 <A NAME="getWaveDumpFile()"><!-- --></A><H3>
\r
1877 getWaveDumpFile</H3>
\r
1879 public java.lang.String <B>getWaveDumpFile</B>()</PRE>
\r
1881 <DD>Gets the dumpfile for this voice.
\r
1888 <DT><B>Returns:</B><DD>the dumpfile</DL>
\r
1893 <A NAME="setAudioPlayer(com.sun.speech.freetts.audio.AudioPlayer)"><!-- --></A><H3>
\r
1894 setAudioPlayer</H3>
\r
1896 public void <B>setAudioPlayer</B>(<A HREF="../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A> player)</PRE>
\r
1898 <DD>Sets the audio player associated with this voice. The caller is
1899 responsible for closing this player.
\r
1905 <DT><B>Parameters:</B><DD><CODE>player</CODE> - the audio player</DL>
\r
1910 <A NAME="getDefaultAudioPlayer()"><!-- --></A><H3>
\r
1911 getDefaultAudioPlayer</H3>
\r
1913 public <A HREF="../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A> <B>getDefaultAudioPlayer</B>()
1914 throws java.lang.InstantiationException</PRE>
\r
1916 <DD>Gets the default audio player for this voice. The return
1917 value will be non-null only if the DEFAULT_AUDIO_PLAYER
1918 system property has been set to the name of an AudioPlayer
1919 class, and that class is able to be instantiated via a
1920 no arg constructor. getAudioPlayer will automatically set
1921 the audio player for this voice to the default audio player
1922 if the audio player has not yet been set.
\r
1929 <DT><B>Returns:</B><DD>the default AudioPlayer
1931 <DD><CODE>java.lang.InstantiationException</CODE><DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Voice.html#DEFAULT_AUDIO_PLAYER"><CODE>DEFAULT_AUDIO_PLAYER</CODE></A>,
1932 <A HREF="../../../../com/sun/speech/freetts/Voice.html#getAudioPlayer()"><CODE>getAudioPlayer()</CODE></A></DL>
\r
1937 <A NAME="getAudioPlayer()"><!-- --></A><H3>
\r
1938 getAudioPlayer</H3>
\r
1940 public <A HREF="../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A> <B>getAudioPlayer</B>()</PRE>
\r
1942 <DD>Gets the audio player associated with this voice. If the
1943 audio player has not yet been set, the value will default
1944 to the return value of getDefaultAudioPlayer.
\r
1951 <DT><B>Returns:</B><DD>the audio player<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Voice.html#getDefaultAudioPlayer()"><CODE>getDefaultAudioPlayer()</CODE></A></DL>
\r
1956 <A NAME="getResource(java.lang.String)"><!-- --></A><H3>
\r
1959 protected java.net.URL <B>getResource</B>(java.lang.String resource)</PRE>
\r
1961 <DD>Get a resource for this voice.
1962 By default, the voice is searched for in the package
1963 to which the voice class belongs. Subclasses are free to
1964 override this behaviour.
\r
1975 <A NAME="setName(java.lang.String)"><!-- --></A><H3>
\r
1978 protected void <B>setName</B>(java.lang.String name)</PRE>
\r
1980 <DD>Set the name of this voice.
1981 [[[TODO: any standard format to the name?]]]
\r
1987 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name to assign this voice</DL>
\r
1992 <A NAME="getName()"><!-- --></A><H3>
\r
1995 public java.lang.String <B>getName</B>()</PRE>
\r
1997 <DD>Get the name of this voice.
\r
2004 <DT><B>Returns:</B><DD>the name</DL>
\r
2009 <A NAME="toString()"><!-- --></A><H3>
\r
2012 public java.lang.String <B>toString</B>()</PRE>
\r
2014 <DD>Returns the name of this Voice.
\r
2021 <DT><B>Returns:</B><DD>the name of this Voice</DL>
\r
2026 <A NAME="setGender(com.sun.speech.freetts.Gender)"><!-- --></A><H3>
\r
2029 protected void <B>setGender</B>(<A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A> gender)</PRE>
\r
2031 <DD>Set the gender of this voice.
\r
2037 <DT><B>Parameters:</B><DD><CODE>gender</CODE> - the gender to assign</DL>
\r
2042 <A NAME="getGender()"><!-- --></A><H3>
\r
2045 public <A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts">Gender</A> <B>getGender</B>()</PRE>
\r
2047 <DD>Get the gender of this voice.
\r
2054 <DT><B>Returns:</B><DD>the gender of this voice</DL>
\r
2059 <A NAME="setAge(com.sun.speech.freetts.Age)"><!-- --></A><H3>
\r
2062 protected void <B>setAge</B>(<A HREF="../../../../com/sun/speech/freetts/Age.html" title="class in com.sun.speech.freetts">Age</A> age)</PRE>
\r
2064 <DD>Set the age of this voice.
\r
2070 <DT><B>Parameters:</B><DD><CODE>age</CODE> - the age to assign</DL>
\r
2075 <A NAME="getAge()"><!-- --></A><H3>
\r
2078 public <A HREF="../../../../com/sun/speech/freetts/Age.html" title="class in com.sun.speech.freetts">Age</A> <B>getAge</B>()</PRE>
\r
2080 <DD>Get the age of this voice.
\r
2087 <DT><B>Returns:</B><DD>the age of this voice</DL>
\r
2092 <A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
\r
2093 setDescription</H3>
\r
2095 protected void <B>setDescription</B>(java.lang.String description)</PRE>
\r
2097 <DD>Set the description of this voice.
\r
2103 <DT><B>Parameters:</B><DD><CODE>description</CODE> - the human readable description to assign</DL>
\r
2108 <A NAME="getDescription()"><!-- --></A><H3>
\r
2109 getDescription</H3>
\r
2111 public java.lang.String <B>getDescription</B>()</PRE>
\r
2113 <DD>Get the description of this voice.
\r
2120 <DT><B>Returns:</B><DD>the human readable description of this voice</DL>
\r
2125 <A NAME="setLocale(java.util.Locale)"><!-- --></A><H3>
\r
2128 protected void <B>setLocale</B>(java.util.Locale locale)</PRE>
\r
2130 <DD>Set the locale of this voice.
\r
2136 <DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale of this voice.</DL>
\r
2141 <A NAME="getLocale()"><!-- --></A><H3>
\r
2144 public java.util.Locale <B>getLocale</B>()</PRE>
\r
2146 <DD>Get the locale of this voice.
\r
2153 <DT><B>Returns:</B><DD>the locale of this voice.</DL>
\r
2158 <A NAME="setDomain(java.lang.String)"><!-- --></A><H3>
\r
2161 protected void <B>setDomain</B>(java.lang.String domain)</PRE>
\r
2163 <DD>Set the domain of this voice.
\r
2169 <DT><B>Parameters:</B><DD><CODE>domain</CODE> - the domain of this voice. For example,
2170 "general", "time", or
2171 "weather".</DL>
\r
2176 <A NAME="getDomain()"><!-- --></A><H3>
\r
2179 public java.lang.String <B>getDomain</B>()</PRE>
\r
2181 <DD>Get the domain of this voice.
\r
2188 <DT><B>Returns:</B><DD>the domain of this voice. For example,
2189 "general", "time", or
2190 "weather".</DL>
\r
2195 <A NAME="setStyle(java.lang.String)"><!-- --></A><H3>
\r
2198 public void <B>setStyle</B>(java.lang.String style)</PRE>
\r
2200 <DD>Sets the voice style. This parameter is designed for human
2201 interpretation. Values might include "business", "casual",
2202 "robotic", "breathy"
\r
2208 <DT><B>Parameters:</B><DD><CODE>style</CODE> - the stile of this voice.</DL>
\r
2213 <A NAME="getStyle()"><!-- --></A><H3>
\r
2216 public java.lang.String <B>getStyle</B>()</PRE>
\r
2218 <DD>Gets the voice style. This parameter is designed for human
2219 interpretation. Values might include "business", "casual",
2220 "robotic", "breathy".
\r
2231 <A NAME="setOrganization(java.lang.String)"><!-- --></A><H3>
\r
2232 setOrganization</H3>
\r
2234 protected void <B>setOrganization</B>(java.lang.String organization)</PRE>
\r
2236 <DD>Sets the organization which created this voice. For example
2243 <DT><B>Parameters:</B><DD><CODE>organization</CODE> - the name of the organization</DL>
\r
2248 <A NAME="getOrganization()"><!-- --></A><H3>
\r
2249 getOrganization</H3>
\r
2251 public java.lang.String <B>getOrganization</B>()</PRE>
\r
2253 <DD>Gets the organization which created this voice. For example
2261 <DT><B>Returns:</B><DD>the name of the organization</DL>
\r
2266 <A NAME="getAudioOutput()"><!-- --></A><H3>
\r
2267 getAudioOutput</H3>
\r
2269 protected abstract <A HREF="../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface in com.sun.speech.freetts">UtteranceProcessor</A> <B>getAudioOutput</B>()
2270 throws java.io.IOException</PRE>
\r
2272 <DD>Returns the AudioOutput processor to be used by this voice.
2273 Derived voices typically override this to customize behaviors.
\r
2280 <DT><B>Returns:</B><DD>the audio output processor
2282 <DD><CODE>java.io.IOException</CODE> - if an IO error occurs while getting
2286 <!-- ========= END OF CLASS DATA ========= -->
\r
2290 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
2291 <A NAME="navbar_bottom"><!-- --></A>
2292 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
2293 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
2295 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
2296 <A NAME="navbar_bottom_firstrow"><!-- --></A>
2297 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
2298 <TR ALIGN="center" VALIGN="top">
\r
2299 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
2300 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
2301 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
2302 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
2303 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
2304 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
2305 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
2309 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
2315 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
2316 <A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
2317 <A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
2318 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
2319 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
2320 <A HREF="Voice.html" target="_top"><B>NO FRAMES</B></A>
\r
2321 <SCRIPT type="text/javascript">
\r
2324 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
2329 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
2335 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
2336 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
2337 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
2338 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
2341 <A NAME="skip-navbar_bottom"></A>
2342 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
projects / debian / freetts / blob