add a cleanup script to elide the non-free jsapi binary blob from the sources
[debian/freetts] / javadoc / com / sun / speech / freetts / FreeTTS.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:29 CET 2009 -->\r
6 <TITLE>\r
7 FreeTTS (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.FreeTTS class">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     parent.document.title="FreeTTS (FreeTTS 1.2)";\r
18 }\r
19 </SCRIPT>\r
20 \r
21 </HEAD>\r
22 \r
23 <BODY BGCOLOR="white" onload="windowTitle();">\r
24 \r
25
26 <!-- ========= START OF TOP NAVBAR ======= -->\r
27 <A NAME="navbar_top"><!-- --></A>
28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
30 <TR>\r
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
34   <TR ALIGN="center" VALIGN="top">\r
35   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
36   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
37   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
42   </TR>\r
43 </TABLE>\r
44 </TD>\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
46 </EM>\r
47 </TD>\r
48 </TR>\r
49 \r
50 <TR>\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
52 &nbsp;<A HREF="../../../../com/sun/speech/freetts/FeatureSetImpl.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
55   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
56 &nbsp;<A HREF="FreeTTS.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
57 &nbsp;<SCRIPT type="text/javascript">\r
58   <!--\r
59   if(window==top) {\r
60     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
61   }\r
62   //-->\r
63 </SCRIPT>\r
64 <NOSCRIPT>\r
65   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
66 </NOSCRIPT>
67 \r
68 </FONT></TD>\r
69 </TR>\r
70 <TR>\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
72   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
74 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
75 </TR>\r
76 </TABLE>\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->\r
79 \r
80 <HR>\r
81 <!-- ======== START OF CLASS DATA ======== -->\r
82 <H2>\r
83 <FONT SIZE="-1">\r
84 com.sun.speech.freetts</FONT>\r
85 <BR>\r
86 Class FreeTTS</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.FreeTTS</B>\r
90 </PRE>\r
91 <DL>\r
92 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html" title="class in com.sun.speech.freetts">FreeTTSTime</A></DD>\r
93 </DL>\r
94 <HR>\r
95 <DL>\r
96 <DT>public class <B>FreeTTS</B><DT>extends java.lang.Object</DL>\r
97 \r
98 <P>\r
99 Standalone utility that directly interacts with a CMUDiphoneVoice.\r
100 <P>\r
101 \r
102 <P>\r
103 <HR>\r
104 \r
105 <P>\r
106 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
107 \r
108 \r
109 <!-- =========== FIELD SUMMARY =========== -->\r
110 \r
111 <A NAME="field_summary"><!-- --></A>
112 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
113 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
114 <TD COLSPAN=2><FONT SIZE="+2">\r
115 <B>Field Summary</B></FONT></TD>\r
116 </TR>\r
117 <TR BGCOLOR="white" CLASS="TableRowColor">\r
118 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
119 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
120 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#VERSION">VERSION</A></B></CODE>\r
121 \r
122 <BR>\r
123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Version number.</TD>\r
124 </TR>\r
125 </TABLE>\r
126 &nbsp;\r
127 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
128 \r
129 <A NAME="constructor_summary"><!-- --></A>
130 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
131 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
132 <TD COLSPAN=2><FONT SIZE="+2">\r
133 <B>Constructor Summary</B></FONT></TD>\r
134 </TR>\r
135 <TR BGCOLOR="white" CLASS="TableRowColor">\r
136 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#FreeTTS()">FreeTTS</A></B>()</CODE>\r
137 \r
138 <BR>\r
139 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a default FreeTTS with the kevin16 voice.</TD>\r
140 </TR>\r
141 <TR BGCOLOR="white" CLASS="TableRowColor">\r
142 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#FreeTTS(com.sun.speech.freetts.Voice)">FreeTTS</A></B>(<A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A>&nbsp;voice)</CODE>\r
143 \r
144 <BR>\r
145 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a FreeTTS object with the given Voice.</TD>\r
146 </TR>\r
147 </TABLE>\r
148 &nbsp;\r
149 <!-- ========== METHOD SUMMARY =========== -->\r
150 \r
151 <A NAME="method_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>Method Summary</B></FONT></TD>\r
156 </TR>\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">\r
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
159 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
160 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#fileToSpeech(java.lang.String)">fileToSpeech</A></B>(java.lang.String&nbsp;filePath)</CODE>\r
161 \r
162 <BR>\r
163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the text contained in the given path to speech.</TD>\r
164 </TR>\r
165 <TR BGCOLOR="white" CLASS="TableRowColor">\r
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
167 <CODE>&nbsp;<A HREF="../../../../com/sun/speech/freetts/InputMode.html" title="class in com.sun.speech.freetts">InputMode</A></CODE></FONT></TD>\r
168 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#getInputMode()">getInputMode</A></B>()</CODE>\r
169 \r
170 <BR>\r
171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the InputMode.</TD>\r
172 </TR>\r
173 <TR BGCOLOR="white" CLASS="TableRowColor">\r
174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
175 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
176 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#getSilentMode()">getSilentMode</A></B>()</CODE>\r
177 \r
178 <BR>\r
179 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets silent mode.</TD>\r
180 </TR>\r
181 <TR BGCOLOR="white" CLASS="TableRowColor">\r
182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
183 <CODE>protected &nbsp;<A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A></CODE></FONT></TD>\r
184 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#getVoice()">getVoice</A></B>()</CODE>\r
185 \r
186 <BR>\r
187 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the voice used by FreeTTS.</TD>\r
188 </TR>\r
189 <TR BGCOLOR="white" CLASS="TableRowColor">\r
190 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
191 <CODE>static&nbsp;void</CODE></FONT></TD>\r
192 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>\r
193 \r
194 <BR>\r
195 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The main entry point for FreeTTS.</TD>\r
196 </TR>\r
197 <TR BGCOLOR="white" CLASS="TableRowColor">\r
198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
199 <CODE>&nbsp;void</CODE></FONT></TD>\r
200 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#setAudioFile(java.lang.String)">setAudioFile</A></B>(java.lang.String&nbsp;audioFile)</CODE>\r
201 \r
202 <BR>\r
203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the audio file .</TD>\r
204 </TR>\r
205 <TR BGCOLOR="white" CLASS="TableRowColor">\r
206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
207 <CODE>&nbsp;void</CODE></FONT></TD>\r
208 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#setInputMode(com.sun.speech.freetts.InputMode)">setInputMode</A></B>(<A HREF="../../../../com/sun/speech/freetts/InputMode.html" title="class in com.sun.speech.freetts">InputMode</A>&nbsp;inputMode)</CODE>\r
209 \r
210 <BR>\r
211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the input mode.</TD>\r
212 </TR>\r
213 <TR BGCOLOR="white" CLASS="TableRowColor">\r
214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
215 <CODE>&nbsp;void</CODE></FONT></TD>\r
216 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#setMultiAudio(boolean)">setMultiAudio</A></B>(boolean&nbsp;multiAudio)</CODE>\r
217 \r
218 <BR>\r
219 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets multi audio. </TD>\r
220 </TR>\r
221 <TR BGCOLOR="white" CLASS="TableRowColor">\r
222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
223 <CODE>&nbsp;void</CODE></FONT></TD>\r
224 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#setSilentMode(boolean)">setSilentMode</A></B>(boolean&nbsp;silent)</CODE>\r
225 \r
226 <BR>\r
227 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Turns audio playing on and off.</TD>\r
228 </TR>\r
229 <TR BGCOLOR="white" CLASS="TableRowColor">\r
230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
231 <CODE>&nbsp;void</CODE></FONT></TD>\r
232 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#setStreamingAudio(boolean)">setStreamingAudio</A></B>(boolean&nbsp;streamingAudio)</CODE>\r
233 \r
234 <BR>\r
235 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets streaming audio. </TD>\r
236 </TR>\r
237 <TR BGCOLOR="white" CLASS="TableRowColor">\r
238 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
239 <CODE>&nbsp;void</CODE></FONT></TD>\r
240 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#shutdown()">shutdown</A></B>()</CODE>\r
241 \r
242 <BR>\r
243 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shuts down this FreeTTS synthesizer by closing the AudioPlayer and voice.</TD>\r
244 </TR>\r
245 <TR BGCOLOR="white" CLASS="TableRowColor">\r
246 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
247 <CODE>&nbsp;void</CODE></FONT></TD>\r
248 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#startup()">startup</A></B>()</CODE>\r
249 \r
250 <BR>\r
251 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Starts this FreeTTS Synthesizer by loading the void and creating a new
252  AudioPlayer.</TD>\r
253 </TR>\r
254 <TR BGCOLOR="white" CLASS="TableRowColor">\r
255 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
256 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
257 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#streamToSpeech(java.io.InputStream)">streamToSpeech</A></B>(java.io.InputStream&nbsp;is)</CODE>\r
258 \r
259 <BR>\r
260 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the text contained in the given stream to speech.</TD>\r
261 </TR>\r
262 <TR BGCOLOR="white" CLASS="TableRowColor">\r
263 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
264 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
265 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#textToSpeech(java.lang.String)">textToSpeech</A></B>(java.lang.String&nbsp;text)</CODE>\r
266 \r
267 <BR>\r
268 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the given text to speech based using processing options
269  currently set in FreeTTS.</TD>\r
270 </TR>\r
271 <TR BGCOLOR="white" CLASS="TableRowColor">\r
272 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
273 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
274 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#urlToSpeech(java.lang.String)">urlToSpeech</A></B>(java.lang.String&nbsp;urlPath)</CODE>\r
275 \r
276 <BR>\r
277 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the text contained in the given path to speech.</TD>\r
278 </TR>\r
279 </TABLE>\r
280 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
281 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
282 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
283 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
284 </TR>\r
285 <TR BGCOLOR="white" CLASS="TableRowColor">\r
286 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
287 </TR>\r
288 </TABLE>\r
289 &nbsp;\r
290 <P>\r
291 \r
292 <!-- ============ FIELD DETAIL =========== -->\r
293 \r
294 <A NAME="field_detail"><!-- --></A>
295 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
296 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
297 <TD COLSPAN=1><FONT SIZE="+2">\r
298 <B>Field Detail</B></FONT></TD>\r
299 </TR>\r
300 </TABLE>\r
301 \r
302 <A NAME="VERSION"><!-- --></A><H3>\r
303 VERSION</H3>\r
304 <PRE>\r
305 public static final java.lang.String <B>VERSION</B></PRE>\r
306 <DL>\r
307 <DD>Version number.\r
308 <P>\r
309 <DL>\r
310 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.freetts.FreeTTS.VERSION">Constant Field Values</A></DL>\r
311 </DL>\r
312 \r
313 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
314 \r
315 <A NAME="constructor_detail"><!-- --></A>
316 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
317 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
318 <TD COLSPAN=1><FONT SIZE="+2">\r
319 <B>Constructor Detail</B></FONT></TD>\r
320 </TR>\r
321 </TABLE>\r
322 \r
323 <A NAME="FreeTTS()"><!-- --></A><H3>\r
324 FreeTTS</H3>\r
325 <PRE>\r
326 public <B>FreeTTS</B>()</PRE>\r
327 <DL>\r
328 <DD>Constructs a default FreeTTS with the kevin16 voice.\r
329 <P>\r
330 </DL>\r
331 <HR>\r
332 \r
333 <A NAME="FreeTTS(com.sun.speech.freetts.Voice)"><!-- --></A><H3>\r
334 FreeTTS</H3>\r
335 <PRE>\r
336 public <B>FreeTTS</B>(<A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A>&nbsp;voice)</PRE>\r
337 <DL>\r
338 <DD>Creates a FreeTTS object with the given Voice.\r
339 <P>\r
340 <DT><B>Parameters:</B><DD><CODE>voice</CODE> - the voice to use</DL>\r
341 \r
342 <!-- ============ METHOD DETAIL ========== -->\r
343 \r
344 <A NAME="method_detail"><!-- --></A>
345 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
346 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
347 <TD COLSPAN=1><FONT SIZE="+2">\r
348 <B>Method Detail</B></FONT></TD>\r
349 </TR>\r
350 </TABLE>\r
351 \r
352 <A NAME="startup()"><!-- --></A><H3>\r
353 startup</H3>\r
354 <PRE>\r
355 public void <B>startup</B>()</PRE>\r
356 <DL>\r
357 <DD>Starts this FreeTTS Synthesizer by loading the void and creating a new
358  AudioPlayer.\r
359 <P>\r
360 <DD><DL>\r
361 </DL>\r
362 </DD>\r
363 </DL>\r
364 <HR>\r
365 \r
366 <A NAME="shutdown()"><!-- --></A><H3>\r
367 shutdown</H3>\r
368 <PRE>\r
369 public void <B>shutdown</B>()</PRE>\r
370 <DL>\r
371 <DD>Shuts down this FreeTTS synthesizer by closing the AudioPlayer and voice.\r
372 <P>\r
373 <DD><DL>\r
374 </DL>\r
375 </DD>\r
376 </DL>\r
377 <HR>\r
378 \r
379 <A NAME="textToSpeech(java.lang.String)"><!-- --></A><H3>\r
380 textToSpeech</H3>\r
381 <PRE>\r
382 public boolean <B>textToSpeech</B>(java.lang.String&nbsp;text)</PRE>\r
383 <DL>\r
384 <DD>Converts the given text to speech based using processing options
385  currently set in FreeTTS.\r
386 <P>\r
387 <DD><DL>\r
388 <DT><B>Parameters:</B><DD><CODE>text</CODE> - the text to speak
389 <DT><B>Returns:</B><DD>true if the utterance was played properly</DL>\r
390 </DD>\r
391 </DL>\r
392 <HR>\r
393 \r
394 <A NAME="getVoice()"><!-- --></A><H3>\r
395 getVoice</H3>\r
396 <PRE>\r
397 protected <A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A> <B>getVoice</B>()</PRE>\r
398 <DL>\r
399 <DD>Returns the voice used by FreeTTS.\r
400 <P>\r
401 <DD><DL>\r
402
403 <DT><B>Returns:</B><DD>the voice used by freetts</DL>\r
404 </DD>\r
405 </DL>\r
406 <HR>\r
407 \r
408 <A NAME="streamToSpeech(java.io.InputStream)"><!-- --></A><H3>\r
409 streamToSpeech</H3>\r
410 <PRE>\r
411 public boolean <B>streamToSpeech</B>(java.io.InputStream&nbsp;is)</PRE>\r
412 <DL>\r
413 <DD>Converts the text contained in the given stream to speech.\r
414 <P>\r
415 <DD><DL>\r
416 <DT><B>Parameters:</B><DD><CODE>is</CODE> - the stream containing the text to speak</DL>\r
417 </DD>\r
418 </DL>\r
419 <HR>\r
420 \r
421 <A NAME="urlToSpeech(java.lang.String)"><!-- --></A><H3>\r
422 urlToSpeech</H3>\r
423 <PRE>\r
424 public boolean <B>urlToSpeech</B>(java.lang.String&nbsp;urlPath)</PRE>\r
425 <DL>\r
426 <DD>Converts the text contained in the given path to speech.\r
427 <P>\r
428 <DD><DL>\r
429 <DT><B>Parameters:</B><DD><CODE>urlPath</CODE> - the file containing the text to speak
430 <DT><B>Returns:</B><DD>true if the utterance was played properly</DL>\r
431 </DD>\r
432 </DL>\r
433 <HR>\r
434 \r
435 <A NAME="fileToSpeech(java.lang.String)"><!-- --></A><H3>\r
436 fileToSpeech</H3>\r
437 <PRE>\r
438 public boolean <B>fileToSpeech</B>(java.lang.String&nbsp;filePath)</PRE>\r
439 <DL>\r
440 <DD>Converts the text contained in the given path to speech.\r
441 <P>\r
442 <DD><DL>\r
443 <DT><B>Parameters:</B><DD><CODE>filePath</CODE> - the file containing the text to speak
444 <DT><B>Returns:</B><DD>true if the utterance was played properly</DL>\r
445 </DD>\r
446 </DL>\r
447 <HR>\r
448 \r
449 <A NAME="setSilentMode(boolean)"><!-- --></A><H3>\r
450 setSilentMode</H3>\r
451 <PRE>\r
452 public void <B>setSilentMode</B>(boolean&nbsp;silent)</PRE>\r
453 <DL>\r
454 <DD>Turns audio playing on and off.\r
455 <P>\r
456 <DD><DL>\r
457 <DT><B>Parameters:</B><DD><CODE>silent</CODE> - if true, don't play audio</DL>\r
458 </DD>\r
459 </DL>\r
460 <HR>\r
461 \r
462 <A NAME="getSilentMode()"><!-- --></A><H3>\r
463 getSilentMode</H3>\r
464 <PRE>\r
465 public boolean <B>getSilentMode</B>()</PRE>\r
466 <DL>\r
467 <DD>Gets silent mode.\r
468 <P>\r
469 <DD><DL>\r
470
471 <DT><B>Returns:</B><DD>true if in silent mode<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#setSilentMode(boolean)"><CODE>setSilentMode(boolean)</CODE></A></DL>\r
472 </DD>\r
473 </DL>\r
474 <HR>\r
475 \r
476 <A NAME="setInputMode(com.sun.speech.freetts.InputMode)"><!-- --></A><H3>\r
477 setInputMode</H3>\r
478 <PRE>\r
479 public void <B>setInputMode</B>(<A HREF="../../../../com/sun/speech/freetts/InputMode.html" title="class in com.sun.speech.freetts">InputMode</A>&nbsp;inputMode)</PRE>\r
480 <DL>\r
481 <DD>Sets the input mode.\r
482 <P>\r
483 <DD><DL>\r
484 <DT><B>Parameters:</B><DD><CODE>inputMode</CODE> - the input mode</DL>\r
485 </DD>\r
486 </DL>\r
487 <HR>\r
488 \r
489 <A NAME="getInputMode()"><!-- --></A><H3>\r
490 getInputMode</H3>\r
491 <PRE>\r
492 public <A HREF="../../../../com/sun/speech/freetts/InputMode.html" title="class in com.sun.speech.freetts">InputMode</A> <B>getInputMode</B>()</PRE>\r
493 <DL>\r
494 <DD>Returns the InputMode.\r
495 <P>\r
496 <DD><DL>\r
497
498 <DT><B>Returns:</B><DD>the input mode<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#setInputMode(com.sun.speech.freetts.InputMode)"><CODE>setInputMode(com.sun.speech.freetts.InputMode)</CODE></A></DL>\r
499 </DD>\r
500 </DL>\r
501 <HR>\r
502 \r
503 <A NAME="setAudioFile(java.lang.String)"><!-- --></A><H3>\r
504 setAudioFile</H3>\r
505 <PRE>\r
506 public void <B>setAudioFile</B>(java.lang.String&nbsp;audioFile)</PRE>\r
507 <DL>\r
508 <DD>Sets the audio file .\r
509 <P>\r
510 <DD><DL>\r
511 <DT><B>Parameters:</B><DD><CODE>audioFile</CODE> - the audioFile</DL>\r
512 </DD>\r
513 </DL>\r
514 <HR>\r
515 \r
516 <A NAME="setMultiAudio(boolean)"><!-- --></A><H3>\r
517 setMultiAudio</H3>\r
518 <PRE>\r
519 public void <B>setMultiAudio</B>(boolean&nbsp;multiAudio)</PRE>\r
520 <DL>\r
521 <DD>Sets multi audio. If true, and an audio file has been set output will be
522  sent to multiple files\r
523 <P>\r
524 <DD><DL>\r
525 <DT><B>Parameters:</B><DD><CODE>multiAudio</CODE> - if <code>true</code> send output to multiple files.</DL>\r
526 </DD>\r
527 </DL>\r
528 <HR>\r
529 \r
530 <A NAME="setStreamingAudio(boolean)"><!-- --></A><H3>\r
531 setStreamingAudio</H3>\r
532 <PRE>\r
533 public void <B>setStreamingAudio</B>(boolean&nbsp;streamingAudio)</PRE>\r
534 <DL>\r
535 <DD>Sets streaming audio. If true, output will be sent to\r
536 <P>\r
537 <DD><DL>\r
538 <DT><B>Parameters:</B><DD><CODE>streamingAudio</CODE> - if <code>true</code> stream audio</DL>\r
539 </DD>\r
540 </DL>\r
541 <HR>\r
542 \r
543 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
544 main</H3>\r
545 <PRE>\r
546 public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>\r
547 <DL>\r
548 <DD>The main entry point for FreeTTS.\r
549 <P>\r
550 <DD><DL>\r
551 </DL>\r
552 </DD>\r
553 </DL>\r
554 <!-- ========= END OF CLASS DATA ========= -->\r
555 <HR>\r
556 \r
557
558 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
559 <A NAME="navbar_bottom"><!-- --></A>
560 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
561 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
562 <TR>\r
563 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
564 <A NAME="navbar_bottom_firstrow"><!-- --></A>
565 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
566   <TR ALIGN="center" VALIGN="top">\r
567   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
568   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
569   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
570   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
571   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
572   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
573   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
574   </TR>\r
575 </TABLE>\r
576 </TD>\r
577 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
578 </EM>\r
579 </TD>\r
580 </TR>\r
581 \r
582 <TR>\r
583 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
584 &nbsp;<A HREF="../../../../com/sun/speech/freetts/FeatureSetImpl.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
585 &nbsp;<A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>\r
586 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
587   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
588 &nbsp;<A HREF="FreeTTS.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
589 &nbsp;<SCRIPT type="text/javascript">\r
590   <!--\r
591   if(window==top) {\r
592     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
593   }\r
594   //-->\r
595 </SCRIPT>\r
596 <NOSCRIPT>\r
597   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
598 </NOSCRIPT>
599 \r
600 </FONT></TD>\r
601 </TR>\r
602 <TR>\r
603 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
604   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
605 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
606 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
607 </TR>\r
608 </TABLE>\r
609 <A NAME="skip-navbar_bottom"></A>
610 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
611 \r
612 <HR>\r
613 \r
614 </BODY>\r
615 </HTML>\r