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:30 CET 2009 -->
\r
7 FreeTTSSynthesizer (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.jsapi.FreeTTSSynthesizer 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="FreeTTSSynthesizer (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/jsapi/FreeTTSEngineCentral.html" title="class in com.sun.speech.freetts.jsapi"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizerModeDesc.html" title="class in com.sun.speech.freetts.jsapi"><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="FreeTTSSynthesizer.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="#fields_inherited_from_class_com.sun.speech.engine.synthesis.BaseSynthesizer">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: FIELD | <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.jsapi</FONT>
\r
86 Class FreeTTSSynthesizer</H2>
\r
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html" title="class in com.sun.speech.engine">com.sun.speech.engine.BaseEngine</A>
\r
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis">com.sun.speech.engine.synthesis.BaseSynthesizer</A>
\r
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.jsapi.FreeTTSSynthesizer</B>
\r
94 <DT><B>All Implemented Interfaces:</B> <DD>javax.speech.Engine, <A HREF="../../../../../com/sun/speech/engine/SpeechEventDispatcher.html" title="interface in com.sun.speech.engine">SpeechEventDispatcher</A>, javax.speech.synthesis.Synthesizer</DD>
\r
98 <DT>public class <B>FreeTTSSynthesizer</B><DT>extends <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizer</A></DL>
\r
101 Provides partial support for a JSAPI 1.0 synthesizer for the
102 FreeTTS speech synthesis system.
\r
109 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
112 <!-- =========== FIELD SUMMARY =========== -->
\r
114 <A NAME="field_summary"><!-- --></A>
115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
117 <TD COLSPAN=2><FONT SIZE="+2">
\r
118 <B>Field Summary</B></FONT></TD>
\r
121 <A NAME="fields_inherited_from_class_com.sun.speech.engine.synthesis.BaseSynthesizer"><!-- --></A>
122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
123 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
124 <TD><B>Fields inherited from class com.sun.speech.engine.synthesis.<A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizer</A></B></TD>
\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
127 <TD><CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#speakableListeners">speakableListeners</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#voiceList">voiceList</A></CODE></TD>
\r
130 <A NAME="fields_inherited_from_class_com.sun.speech.engine.BaseEngine"><!-- --></A>
131 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
132 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
133 <TD><B>Fields inherited from class com.sun.speech.engine.<A HREF="../../../../../com/sun/speech/engine/BaseEngine.html" title="class in com.sun.speech.engine">BaseEngine</A></B></TD>
\r
135 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
136 <TD><CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#audioManager">audioManager</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#CLEAR_ALL_STATE">CLEAR_ALL_STATE</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#engineListeners">engineListeners</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#engineModeDesc">engineModeDesc</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#engineProperties">engineProperties</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#engineState">engineState</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#engineStateLock">engineStateLock</A></CODE></TD>
\r
139 <A NAME="fields_inherited_from_class_javax.speech.synthesis.Synthesizer"><!-- --></A>
140 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
141 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
142 <TD><B>Fields inherited from interface javax.speech.synthesis.Synthesizer</B></TD>
\r
144 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
145 <TD><CODE>QUEUE_EMPTY, QUEUE_NOT_EMPTY</CODE></TD>
\r
148 <A NAME="fields_inherited_from_class_javax.speech.Engine"><!-- --></A>
149 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
150 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
151 <TD><B>Fields inherited from interface javax.speech.Engine</B></TD>
\r
153 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
154 <TD><CODE>ALLOCATED, ALLOCATING_RESOURCES, DEALLOCATED, DEALLOCATING_RESOURCES, PAUSED, RESUMED</CODE></TD>
\r
158 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
160 <A NAME="constructor_summary"><!-- --></A>
161 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
162 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
163 <TD COLSPAN=2><FONT SIZE="+2">
\r
164 <B>Constructor Summary</B></FONT></TD>
\r
166 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
167 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html#FreeTTSSynthesizer(com.sun.speech.freetts.jsapi.FreeTTSSynthesizerModeDesc)">FreeTTSSynthesizer</A></B>(<A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizerModeDesc.html" title="class in com.sun.speech.freetts.jsapi">FreeTTSSynthesizerModeDesc</A> desc)</CODE>
\r
170 Creates a new Synthesizer in the DEALLOCATED state.</TD>
\r
174 <!-- ========== METHOD SUMMARY =========== -->
\r
176 <A NAME="method_summary"><!-- --></A>
177 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
178 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
179 <TD COLSPAN=2><FONT SIZE="+2">
\r
180 <B>Method Summary</B></FONT></TD>
\r
182 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
184 <CODE>protected void</CODE></FONT></TD>
\r
185 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html#appendQueue(com.sun.speech.engine.synthesis.BaseSynthesizerQueueItem)">appendQueue</A></B>(<A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerQueueItem.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizerQueueItem</A> item)</CODE>
\r
188 Places an item on the speaking queue and send the queue update event.</TD>
\r
190 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
191 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
192 <CODE> void</CODE></FONT></TD>
\r
193 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html#cancel()">cancel</A></B>()</CODE>
\r
196 Cancels the item at the top of the queue.</TD>
\r
198 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
199 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
200 <CODE> void</CODE></FONT></TD>
\r
201 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html#cancel(java.lang.Object)">cancel</A></B>(java.lang.Object source)</CODE>
\r
204 Cancels a specific object on the queue.</TD>
\r
206 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
207 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
208 <CODE> void</CODE></FONT></TD>
\r
209 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html#cancelAll()">cancelAll</A></B>()</CODE>
\r
212 Cancels all items on the output queue.</TD>
\r
214 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
215 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
216 <CODE>protected <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine">BaseEngineProperties</A></CODE></FONT></TD>
\r
217 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html#createEngineProperties()">createEngineProperties</A></B>()</CODE>
\r
220 Factory constructor for EngineProperties object.
223 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
224 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
225 <CODE>protected <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerQueueItem.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizerQueueItem</A></CODE></FONT></TD>
\r
226 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html#createQueueItem()">createQueueItem</A></B>()</CODE>
\r
229 Factory method to create a BaseSynthesizerQueueItem.</TD>
\r
231 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
232 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
233 <CODE> java.util.Enumeration</CODE></FONT></TD>
\r
234 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html#enumerateQueue()">enumerateQueue</A></B>()</CODE>
\r
237 Returns an enumeration of the queue.</TD>
\r
239 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
240 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
241 <CODE>protected void</CODE></FONT></TD>
\r
242 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html#handleAllocate()">handleAllocate</A></B>()</CODE>
\r
245 Starts the output thread. </TD>
\r
247 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
248 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
249 <CODE>protected void</CODE></FONT></TD>
\r
250 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html#handleDeallocate()">handleDeallocate</A></B>()</CODE>
\r
253 Handles a deallocation request. </TD>
\r
255 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
256 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
257 <CODE>protected void</CODE></FONT></TD>
\r
258 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html#handlePause()">handlePause</A></B>()</CODE>
\r
261 Pauses the output</TD>
\r
263 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
264 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
265 <CODE>protected void</CODE></FONT></TD>
\r
266 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html#handleResume()">handleResume</A></B>()</CODE>
\r
269 Resumes the output</TD>
\r
272 <A NAME="methods_inherited_from_class_com.sun.speech.engine.synthesis.BaseSynthesizer"><!-- --></A>
273 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
274 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
275 <TD><B>Methods inherited from class com.sun.speech.engine.synthesis.<A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizer</A></B></TD>
\r
277 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
278 <TD><CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#addSpeakableListener(javax.speech.synthesis.SpeakableListener)">addSpeakableListener</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#dispatchSpeechEvent(javax.speech.SpeechEvent)">dispatchSpeechEvent</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#fireQueueEmptied(javax.speech.synthesis.SynthesizerEvent)">fireQueueEmptied</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#fireQueueUpdated(javax.speech.synthesis.SynthesizerEvent)">fireQueueUpdated</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#getSynthesizerProperties()">getSynthesizerProperties</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#getVoiceList()">getVoiceList</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#phoneme(java.lang.String)">phoneme</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#postQueueEmptied(long, long)">postQueueEmptied</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#postQueueUpdated(boolean, long, long)">postQueueUpdated</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#removeSpeakableListener(javax.speech.synthesis.SpeakableListener)">removeSpeakableListener</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#speak(javax.speech.synthesis.Speakable, javax.speech.synthesis.SpeakableListener)">speak</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#speak(java.lang.String, javax.speech.synthesis.SpeakableListener)">speak</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#speak(java.net.URL, javax.speech.synthesis.SpeakableListener)">speak</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#speakPlainText(java.lang.String, javax.speech.synthesis.SpeakableListener)">speakPlainText</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#stateToString(long)">stateToString</A></CODE></TD>
\r
281 <A NAME="methods_inherited_from_class_com.sun.speech.engine.BaseEngine"><!-- --></A>
282 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
283 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
284 <TD><B>Methods inherited from class com.sun.speech.engine.<A HREF="../../../../../com/sun/speech/engine/BaseEngine.html" title="class in com.sun.speech.engine">BaseEngine</A></B></TD>
\r
286 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
287 <TD><CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#addEngineListener(javax.speech.EngineListener)">addEngineListener</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#allocate()">allocate</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#checkEngineState(long)">checkEngineState</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#deallocate()">deallocate</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#fireEngineAllocated(javax.speech.EngineEvent)">fireEngineAllocated</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#fireEngineAllocatingResources(javax.speech.EngineEvent)">fireEngineAllocatingResources</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#fireEngineDeallocated(javax.speech.EngineEvent)">fireEngineDeallocated</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#fireEngineDeallocatingResources(javax.speech.EngineEvent)">fireEngineDeallocatingResources</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#fireEnginePaused(javax.speech.EngineEvent)">fireEnginePaused</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#fireEngineResumed(javax.speech.EngineEvent)">fireEngineResumed</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#getAudioManager()">getAudioManager</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#getEngineModeDesc()">getEngineModeDesc</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#getEngineProperties()">getEngineProperties</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#getEngineState()">getEngineState</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#getVocabManager()">getVocabManager</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#pause()">pause</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#postEngineAllocated(long, long)">postEngineAllocated</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#postEngineAllocatingResources(long, long)">postEngineAllocatingResources</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#postEngineDeallocated(long, long)">postEngineDeallocated</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#postEngineDeallocatingResources(long, long)">postEngineDeallocatingResources</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#postEnginePaused(long, long)">postEnginePaused</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#postEngineResumed(long, long)">postEngineResumed</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#removeEngineListener(javax.speech.EngineListener)">removeEngineListener</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#resume()">resume</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#setEngineModeDesc(javax.speech.EngineModeDesc)">setEngineModeDesc</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#setEngineState(long, long)">setEngineState</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#testEngineState(long)">testEngineState</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#toString()">toString</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#waitEngineState(long)">waitEngineState</A></CODE></TD>
\r
290 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
291 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
292 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
293 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
295 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
296 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
299 <A NAME="methods_inherited_from_class_javax.speech.Engine"><!-- --></A>
300 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
301 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
302 <TD><B>Methods inherited from interface javax.speech.Engine</B></TD>
\r
304 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
305 <TD><CODE>addEngineListener, allocate, deallocate, getAudioManager, getEngineModeDesc, getEngineProperties, getEngineState, getVocabManager, pause, removeEngineListener, resume, testEngineState, waitEngineState</CODE></TD>
\r
311 <!-- ============ FIELD DETAIL =========== -->
\r
314 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
316 <A NAME="constructor_detail"><!-- --></A>
317 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
318 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
319 <TD COLSPAN=1><FONT SIZE="+2">
\r
320 <B>Constructor Detail</B></FONT></TD>
\r
324 <A NAME="FreeTTSSynthesizer(com.sun.speech.freetts.jsapi.FreeTTSSynthesizerModeDesc)"><!-- --></A><H3>
\r
325 FreeTTSSynthesizer</H3>
\r
327 public <B>FreeTTSSynthesizer</B>(<A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizerModeDesc.html" title="class in com.sun.speech.freetts.jsapi">FreeTTSSynthesizerModeDesc</A> desc)</PRE>
\r
329 <DD>Creates a new Synthesizer in the DEALLOCATED state.
\r
331 <DT><B>Parameters:</B><DD><CODE>desc</CODE> - describes the allowed mode of operations for this
334 <!-- ============ METHOD DETAIL ========== -->
\r
336 <A NAME="method_detail"><!-- --></A>
337 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
338 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
339 <TD COLSPAN=1><FONT SIZE="+2">
\r
340 <B>Method Detail</B></FONT></TD>
\r
344 <A NAME="handleAllocate()"><!-- --></A><H3>
\r
345 handleAllocate</H3>
\r
347 protected void <B>handleAllocate</B>()
348 throws javax.speech.EngineException</PRE>
\r
350 <DD>Starts the output thread. The output thread is responsible for
351 taking items off of the queue and sending them to the audio
355 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#handleAllocate()">handleAllocate</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html" title="class in com.sun.speech.engine">BaseEngine</A></CODE></DL>
\r
360 <DD><CODE>javax.speech.EngineException</CODE> - if an allocation error occurs<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#allocate()"><CODE>BaseEngine.allocate()</CODE></A></DL>
\r
365 <A NAME="handleDeallocate()"><!-- --></A><H3>
\r
366 handleDeallocate</H3>
\r
368 protected void <B>handleDeallocate</B>()
369 throws javax.speech.EngineException</PRE>
\r
371 <DD>Handles a deallocation request. Cancels all pending items,
372 terminates the output handler, and posts the state changes.
\r
375 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#handleDeallocate()">handleDeallocate</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html" title="class in com.sun.speech.engine">BaseEngine</A></CODE></DL>
\r
380 <DD><CODE>javax.speech.EngineException</CODE> - if a deallocation error occurs</DL>
\r
385 <A NAME="createQueueItem()"><!-- --></A><H3>
\r
386 createQueueItem</H3>
\r
388 protected <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerQueueItem.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizerQueueItem</A> <B>createQueueItem</B>()</PRE>
\r
390 <DD>Factory method to create a BaseSynthesizerQueueItem.
\r
393 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#createQueueItem()">createQueueItem</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizer</A></CODE></DL>
\r
397 <DT><B>Returns:</B><DD>a queue item appropriate for this synthesizer</DL>
\r
402 <A NAME="enumerateQueue()"><!-- --></A><H3>
\r
403 enumerateQueue</H3>
\r
405 public java.util.Enumeration <B>enumerateQueue</B>()
406 throws javax.speech.EngineStateError</PRE>
\r
408 <DD>Returns an enumeration of the queue.
\r
411 <DT><B>Specified by:</B><DD><CODE>enumerateQueue</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#enumerateQueue()">enumerateQueue</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizer</A></CODE></DL>
\r
415 <DT><B>Returns:</B><DD>an enumeration of the contents of the queue. This
416 enumeration contains FreeTTSSynthesizerQueueItem objects
418 <DD><CODE>javax.speech.EngineStateError</CODE> - if the engine was not in the proper
424 <A NAME="appendQueue(com.sun.speech.engine.synthesis.BaseSynthesizerQueueItem)"><!-- --></A><H3>
\r
427 protected void <B>appendQueue</B>(<A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerQueueItem.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizerQueueItem</A> item)</PRE>
\r
429 <DD>Places an item on the speaking queue and send the queue update event.
\r
432 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#appendQueue(com.sun.speech.engine.synthesis.BaseSynthesizerQueueItem)">appendQueue</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizer</A></CODE></DL>
\r
435 <DT><B>Parameters:</B><DD><CODE>item</CODE> - the item to place in the queue</DL>
\r
440 <A NAME="cancel()"><!-- --></A><H3>
\r
443 public void <B>cancel</B>()
444 throws javax.speech.EngineStateError</PRE>
\r
446 <DD>Cancels the item at the top of the queue.
\r
449 <DT><B>Specified by:</B><DD><CODE>cancel</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#cancel()">cancel</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizer</A></CODE></DL>
\r
454 <DD><CODE>javax.speech.EngineStateError</CODE> - if the synthesizer is not in the
460 <A NAME="cancel(java.lang.Object)"><!-- --></A><H3>
\r
463 public void <B>cancel</B>(java.lang.Object source)
464 throws java.lang.IllegalArgumentException,
465 javax.speech.EngineStateError</PRE>
\r
467 <DD>Cancels a specific object on the queue.
\r
470 <DT><B>Specified by:</B><DD><CODE>cancel</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#cancel(java.lang.Object)">cancel</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizer</A></CODE></DL>
\r
473 <DT><B>Parameters:</B><DD><CODE>source</CODE> - the object to cancel
475 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if the source object is not
476 currently in the queue
477 <DD><CODE>javax.speech.EngineStateError</CODE> - the synthesizer is not in the
483 <A NAME="cancelAll()"><!-- --></A><H3>
\r
486 public void <B>cancelAll</B>()
487 throws javax.speech.EngineStateError</PRE>
\r
489 <DD>Cancels all items on the output queue.
\r
492 <DT><B>Specified by:</B><DD><CODE>cancelAll</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#cancelAll()">cancelAll</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizer</A></CODE></DL>
\r
497 <DD><CODE>javax.speech.EngineStateError</CODE></DL>
\r
502 <A NAME="handlePause()"><!-- --></A><H3>
\r
505 protected void <B>handlePause</B>()</PRE>
\r
507 <DD>Pauses the output
\r
510 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#handlePause()">handlePause</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html" title="class in com.sun.speech.engine">BaseEngine</A></CODE></DL>
\r
518 <A NAME="handleResume()"><!-- --></A><H3>
\r
521 protected void <B>handleResume</B>()</PRE>
\r
523 <DD>Resumes the output
\r
526 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#handleResume()">handleResume</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html" title="class in com.sun.speech.engine">BaseEngine</A></CODE></DL>
\r
534 <A NAME="createEngineProperties()"><!-- --></A><H3>
\r
535 createEngineProperties</H3>
\r
537 protected <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine">BaseEngineProperties</A> <B>createEngineProperties</B>()</PRE>
\r
539 <DD>Factory constructor for EngineProperties object.
540 Gets the default speaking voice from the SynthesizerModeDesc.
541 Takes the default prosody values (pitch, range, volume, rate)
542 from the default voice.
543 Override to set engine-specific defaults.
\r
546 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#createEngineProperties()">createEngineProperties</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html" title="class in com.sun.speech.engine.synthesis">BaseSynthesizer</A></CODE></DL>
\r
550 <DT><B>Returns:</B><DD>a <code>BaseEngineProperties</code> object specific to
554 <!-- ========= END OF CLASS DATA ========= -->
\r
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
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> </TD>
\r
568 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
569 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
570 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
571 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
572 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
573 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
577 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
583 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
584 <A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSEngineCentral.html" title="class in com.sun.speech.freetts.jsapi"><B>PREV CLASS</B></A>
\r
585 <A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizerModeDesc.html" title="class in com.sun.speech.freetts.jsapi"><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>
\r
588 <A HREF="FreeTTSSynthesizer.html" target="_top"><B>NO FRAMES</B></A>
\r
589 <SCRIPT type="text/javascript">
\r
592 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
597 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
603 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
604 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_com.sun.speech.engine.synthesis.BaseSynthesizer">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
605 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
606 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
609 <A NAME="skip-navbar_bottom"></A>
610 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r