1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:29 CET 2009 -->
\r
7 BaseSynthesizer (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.engine.synthesis.BaseSynthesizer 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="BaseSynthesizer (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 PREV CLASS
\r
53 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html" title="class in com.sun.speech.engine.synthesis"><B>NEXT CLASS</B></A></FONT></TD>
\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
56 <A HREF="BaseSynthesizer.html" target="_top"><B>NO FRAMES</B></A>
\r
57 <SCRIPT type="text/javascript">
\r
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
72 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->
\r
81 <!-- ======== START OF CLASS DATA ======== -->
\r
84 com.sun.speech.engine.synthesis</FONT>
\r
86 Class BaseSynthesizer</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"><B>com.sun.speech.engine.synthesis.BaseSynthesizer</B>
\r
93 <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
96 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html" title="class in com.sun.speech.freetts.jsapi">FreeTTSSynthesizer</A>, <A HREF="../../../../../com/sun/speech/engine/synthesis/text/TextSynthesizer.html" title="class in com.sun.speech.engine.synthesis.text">TextSynthesizer</A></DD>
\r
100 <DT>public abstract class <B>BaseSynthesizer</B><DT>extends <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html" title="class in com.sun.speech.engine">BaseEngine</A><DT>implements javax.speech.synthesis.Synthesizer, <A HREF="../../../../../com/sun/speech/engine/SpeechEventDispatcher.html" title="interface in com.sun.speech.engine">SpeechEventDispatcher</A></DL>
\r
103 Supports the JSAPI 1.0 <code>Synthesizer</code> interface that
104 performs the core non-engine-specific functions.
106 <p>An actual JSAPI synthesizer implementation needs to extend or
107 modify this implementation.
\r
114 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
117 <!-- =========== FIELD SUMMARY =========== -->
\r
119 <A NAME="field_summary"><!-- --></A>
120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
121 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
122 <TD COLSPAN=2><FONT SIZE="+2">
\r
123 <B>Field Summary</B></FONT></TD>
\r
125 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
126 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
127 <CODE>protected java.util.Collection</CODE></FONT></TD>
\r
128 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#speakableListeners">speakableListeners</A></B></CODE>
\r
131 Set of speakable listeners belonging to the <code>Synthesizer</code>.
134 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
136 <CODE>protected <A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html" title="class in com.sun.speech.engine.synthesis">VoiceList</A></CODE></FONT></TD>
\r
137 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#voiceList">voiceList</A></B></CODE>
\r
140 The set of voices available in this <code>Synthesizer</code>.
144 <A NAME="fields_inherited_from_class_com.sun.speech.engine.BaseEngine"><!-- --></A>
145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
146 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
147 <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
149 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
150 <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
153 <A NAME="fields_inherited_from_class_javax.speech.synthesis.Synthesizer"><!-- --></A>
154 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
155 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
156 <TD><B>Fields inherited from interface javax.speech.synthesis.Synthesizer</B></TD>
\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
159 <TD><CODE>QUEUE_EMPTY, QUEUE_NOT_EMPTY</CODE></TD>
\r
162 <A NAME="fields_inherited_from_class_javax.speech.Engine"><!-- --></A>
163 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
164 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
165 <TD><B>Fields inherited from interface javax.speech.Engine</B></TD>
\r
167 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
168 <TD><CODE>ALLOCATED, ALLOCATING_RESOURCES, DEALLOCATED, DEALLOCATING_RESOURCES, PAUSED, RESUMED</CODE></TD>
\r
172 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
174 <A NAME="constructor_summary"><!-- --></A>
175 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
176 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
177 <TD COLSPAN=2><FONT SIZE="+2">
\r
178 <B>Constructor Summary</B></FONT></TD>
\r
180 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
181 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#BaseSynthesizer(javax.speech.synthesis.SynthesizerModeDesc)">BaseSynthesizer</A></B>(javax.speech.synthesis.SynthesizerModeDesc mode)</CODE>
\r
184 Creates a new Synthesizer in the <code>DEALLOCATED</code> state.</TD>
\r
188 <!-- ========== METHOD SUMMARY =========== -->
\r
190 <A NAME="method_summary"><!-- --></A>
191 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
192 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
193 <TD COLSPAN=2><FONT SIZE="+2">
\r
194 <B>Method Summary</B></FONT></TD>
\r
196 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
197 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
198 <CODE> void</CODE></FONT></TD>
\r
199 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#addSpeakableListener(javax.speech.synthesis.SpeakableListener)">addSpeakableListener</A></B>(javax.speech.synthesis.SpeakableListener listener)</CODE>
\r
202 Adds a <code>SpeakableListener</code> to this <code>Synthesizer</code>.</TD>
\r
204 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
205 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
206 <CODE>protected abstract void</CODE></FONT></TD>
\r
207 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.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
210 Puts an item on the speaking queue and sends a queue updated
213 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
215 <CODE>abstract void</CODE></FONT></TD>
\r
216 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#cancel()">cancel</A></B>()</CODE>
\r
219 Cancels the item at the top of the queue.</TD>
\r
221 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
223 <CODE>abstract void</CODE></FONT></TD>
\r
224 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#cancel(java.lang.Object)">cancel</A></B>(java.lang.Object source)</CODE>
\r
227 Cancels a specific object on the queue.</TD>
\r
229 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
231 <CODE>abstract void</CODE></FONT></TD>
\r
232 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#cancelAll()">cancelAll</A></B>()</CODE>
\r
235 Cancels all items on the output queue.</TD>
\r
237 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
238 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
239 <CODE>protected <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine">BaseEngineProperties</A></CODE></FONT></TD>
\r
240 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#createEngineProperties()">createEngineProperties</A></B>()</CODE>
\r
243 Factory constructor for <code>EngineProperties</code> object.
246 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
247 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
248 <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
249 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#createQueueItem()">createQueueItem</A></B>()</CODE>
\r
252 Factory method that creates a <code>BaseSynthesizerQueueItem</code>.
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/engine/synthesis/BaseSynthesizer.html#dispatchSpeechEvent(javax.speech.SpeechEvent)">dispatchSpeechEvent</A></B>(javax.speech.SpeechEvent event)</CODE>
\r
261 Dispatches a <code>SpeechEvent</code>.
264 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
265 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
266 <CODE>abstract java.util.Enumeration</CODE></FONT></TD>
\r
267 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#enumerateQueue()">enumerateQueue</A></B>()</CODE>
\r
270 Returns an enumeration of the queue.</TD>
\r
272 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
273 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
274 <CODE> void</CODE></FONT></TD>
\r
275 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#fireQueueEmptied(javax.speech.synthesis.SynthesizerEvent)">fireQueueEmptied</A></B>(javax.speech.synthesis.SynthesizerEvent event)</CODE>
\r
278 Utility function that sends a <code>QUEUE_EMPTIED</code>
279 event to all <code>SynthesizerListeners</code>.</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/engine/synthesis/BaseSynthesizer.html#fireQueueUpdated(javax.speech.synthesis.SynthesizerEvent)">fireQueueUpdated</A></B>(javax.speech.synthesis.SynthesizerEvent event)</CODE>
\r
287 Utility function that sends a <code>QUEUE_UPDATED</code>
288 event to all <code>SynthesizerListeners</code>.</TD>
\r
290 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
291 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
292 <CODE> javax.speech.synthesis.SynthesizerProperties</CODE></FONT></TD>
\r
293 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#getSynthesizerProperties()">getSynthesizerProperties</A></B>()</CODE>
\r
296 Returns the <code>SynthesizerProperties</code> object (a JavaBean).
299 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
300 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
301 <CODE>protected <A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html" title="class in com.sun.speech.engine.synthesis">VoiceList</A></CODE></FONT></TD>
\r
302 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#getVoiceList()">getVoiceList</A></B>()</CODE>
\r
305 Returns the list of voices for this <code>Synthesizer</code>.</TD>
\r
307 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
308 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
309 <CODE> java.lang.String</CODE></FONT></TD>
\r
310 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#phoneme(java.lang.String)">phoneme</A></B>(java.lang.String text)</CODE>
\r
313 Optional method that converts a text string to a phoneme string.</TD>
\r
315 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
316 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
317 <CODE> void</CODE></FONT></TD>
\r
318 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#postQueueEmptied(long, long)">postQueueEmptied</A></B>(long oldState,
319 long newState)</CODE>
\r
322 Utility function that generates <code>QUEUE_EMPTIED</code>
323 event and posts it to the event queue. </TD>
\r
325 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
326 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
327 <CODE> void</CODE></FONT></TD>
\r
328 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#postQueueUpdated(boolean, long, long)">postQueueUpdated</A></B>(boolean topOfQueueChanged,
330 long newState)</CODE>
\r
333 Utility function that generates <code>QUEUE_UPDATED</code>
334 event and posts it to the event queue. </TD>
\r
336 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
337 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
338 <CODE> void</CODE></FONT></TD>
\r
339 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#removeSpeakableListener(javax.speech.synthesis.SpeakableListener)">removeSpeakableListener</A></B>(javax.speech.synthesis.SpeakableListener listener)</CODE>
\r
342 Removes a <code>SpeakableListener</code> from this
343 <code>Synthesizer</code>.</TD>
\r
345 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
346 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
347 <CODE> void</CODE></FONT></TD>
\r
348 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#speak(javax.speech.synthesis.Speakable, javax.speech.synthesis.SpeakableListener)">speak</A></B>(javax.speech.synthesis.Speakable jsmlText,
349 javax.speech.synthesis.SpeakableListener listener)</CODE>
\r
352 Speaks JSML text provided as a <code>Speakable</code> object.</TD>
\r
354 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
355 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
356 <CODE> void</CODE></FONT></TD>
\r
357 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#speak(java.lang.String, javax.speech.synthesis.SpeakableListener)">speak</A></B>(java.lang.String jsmlText,
358 javax.speech.synthesis.SpeakableListener listener)</CODE>
\r
361 Speaks JSML text provided as a <code>String</code>.</TD>
\r
363 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
364 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
365 <CODE> void</CODE></FONT></TD>
\r
366 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#speak(java.net.URL, javax.speech.synthesis.SpeakableListener)">speak</A></B>(java.net.URL jsmlURL,
367 javax.speech.synthesis.SpeakableListener listener)</CODE>
\r
370 Speaks JSML text provided as a <code>URL</code>.</TD>
\r
372 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
373 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
374 <CODE> void</CODE></FONT></TD>
\r
375 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#speakPlainText(java.lang.String, javax.speech.synthesis.SpeakableListener)">speakPlainText</A></B>(java.lang.String text,
376 javax.speech.synthesis.SpeakableListener listener)</CODE>
\r
379 Speaks a plain text <code>String</code>. </TD>
\r
381 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
382 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
383 <CODE>protected java.lang.String</CODE></FONT></TD>
\r
384 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#stateToString(long)">stateToString</A></B>(long state)</CODE>
\r
387 Returns a String of the names of all the states implied
388 in the given bit pattern.</TD>
\r
391 <A NAME="methods_inherited_from_class_com.sun.speech.engine.BaseEngine"><!-- --></A>
392 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
393 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
394 <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
396 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
397 <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#handleAllocate()">handleAllocate</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#handleDeallocate()">handleDeallocate</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#handlePause()">handlePause</A>, <A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#handleResume()">handleResume</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
400 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
401 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
402 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
403 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
405 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
406 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
409 <A NAME="methods_inherited_from_class_javax.speech.Engine"><!-- --></A>
410 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
411 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
412 <TD><B>Methods inherited from interface javax.speech.Engine</B></TD>
\r
414 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
415 <TD><CODE>addEngineListener, allocate, deallocate, getAudioManager, getEngineModeDesc, getEngineProperties, getEngineState, getVocabManager, pause, removeEngineListener, resume, testEngineState, waitEngineState</CODE></TD>
\r
421 <!-- ============ FIELD DETAIL =========== -->
\r
423 <A NAME="field_detail"><!-- --></A>
424 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
425 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
426 <TD COLSPAN=1><FONT SIZE="+2">
\r
427 <B>Field Detail</B></FONT></TD>
\r
431 <A NAME="speakableListeners"><!-- --></A><H3>
\r
432 speakableListeners</H3>
\r
434 protected java.util.Collection <B>speakableListeners</B></PRE>
\r
436 <DD>Set of speakable listeners belonging to the <code>Synthesizer</code>.
437 Each item on queue may have an individual listener too.
\r
440 <DT><B>See Also:</B><DD><CODE>SpeakableListener</CODE></DL>
\r
444 <A NAME="voiceList"><!-- --></A><H3>
\r
447 protected <A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html" title="class in com.sun.speech.engine.synthesis">VoiceList</A> <B>voiceList</B></PRE>
\r
449 <DD>The set of voices available in this <code>Synthesizer</code>.
450 The list can be created in the constructor methods.
\r
456 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
458 <A NAME="constructor_detail"><!-- --></A>
459 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
460 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
461 <TD COLSPAN=1><FONT SIZE="+2">
\r
462 <B>Constructor Detail</B></FONT></TD>
\r
466 <A NAME="BaseSynthesizer(javax.speech.synthesis.SynthesizerModeDesc)"><!-- --></A><H3>
\r
467 BaseSynthesizer</H3>
\r
469 public <B>BaseSynthesizer</B>(javax.speech.synthesis.SynthesizerModeDesc mode)</PRE>
\r
471 <DD>Creates a new Synthesizer in the <code>DEALLOCATED</code> state.
\r
473 <DT><B>Parameters:</B><DD><CODE>mode</CODE> - the operating mode of this <code>Synthesizer</code></DL>
\r
475 <!-- ============ METHOD DETAIL ========== -->
\r
477 <A NAME="method_detail"><!-- --></A>
478 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
479 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
480 <TD COLSPAN=1><FONT SIZE="+2">
\r
481 <B>Method Detail</B></FONT></TD>
\r
485 <A NAME="speak(javax.speech.synthesis.Speakable, javax.speech.synthesis.SpeakableListener)"><!-- --></A><H3>
\r
488 public void <B>speak</B>(javax.speech.synthesis.Speakable jsmlText,
489 javax.speech.synthesis.SpeakableListener listener)
490 throws javax.speech.synthesis.JSMLException,
491 javax.speech.EngineStateError</PRE>
\r
493 <DD>Speaks JSML text provided as a <code>Speakable</code> object.
\r
496 <DT><B>Specified by:</B><DD><CODE>speak</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE></DL>
\r
499 <DT><B>Parameters:</B><DD><CODE>jsmlText</CODE> - the JSML text to speak<DD><CODE>listener</CODE> - the listener to be notified as the
500 <code>jsmlText</code> is processed
502 <DD><CODE>javax.speech.synthesis.JSMLException</CODE> - if the JSML text contains errors
503 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Synthesizer</code> in the <code>DEALLOCATED</code> or
504 <code>DEALLOCATING_RESOURCES</code> states</DL>
\r
509 <A NAME="speak(java.net.URL, javax.speech.synthesis.SpeakableListener)"><!-- --></A><H3>
\r
512 public void <B>speak</B>(java.net.URL jsmlURL,
513 javax.speech.synthesis.SpeakableListener listener)
514 throws javax.speech.synthesis.JSMLException,
515 java.net.MalformedURLException,
517 javax.speech.EngineStateError</PRE>
\r
519 <DD>Speaks JSML text provided as a <code>URL</code>.
\r
522 <DT><B>Specified by:</B><DD><CODE>speak</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE></DL>
\r
525 <DT><B>Parameters:</B><DD><CODE>jsmlURL</CODE> - the <code>URL</code> containing JSML text<DD><CODE>listener</CODE> - the listener to be notified as the
526 JSML text is processed
528 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Synthesizer</code> in the <code>DEALLOCATED</code> or
529 <code>DEALLOCATING_RESOURCES</code> states
530 <DD><CODE>java.io.IOException</CODE> - if errors are encountered with the <code>JSMLurl</code>
531 <DD><CODE>javax.speech.synthesis.JSMLException</CODE> - if the JSML text contains errors
532 <DD><CODE>java.net.MalformedURLException</CODE> - if errors are encountered with the <code>JSMLurl</code></DL>
\r
537 <A NAME="speak(java.lang.String, javax.speech.synthesis.SpeakableListener)"><!-- --></A><H3>
\r
540 public void <B>speak</B>(java.lang.String jsmlText,
541 javax.speech.synthesis.SpeakableListener listener)
542 throws javax.speech.synthesis.JSMLException,
543 javax.speech.EngineStateError</PRE>
\r
545 <DD>Speaks JSML text provided as a <code>String</code>.
\r
548 <DT><B>Specified by:</B><DD><CODE>speak</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE></DL>
\r
551 <DT><B>Parameters:</B><DD><CODE>jsmlText</CODE> - a <code>String</code> containing JSML.<DD><CODE>listener</CODE> - the listener to be notified as the
552 JSML text is processed
554 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Synthesizer</code> in the <code>DEALLOCATED</code> or
555 <code>DEALLOCATING_RESOURCES</code> states
556 <DD><CODE>javax.speech.synthesis.JSMLException</CODE> - if the JSML text contains errors</DL>
\r
561 <A NAME="speakPlainText(java.lang.String, javax.speech.synthesis.SpeakableListener)"><!-- --></A><H3>
\r
562 speakPlainText</H3>
\r
564 public void <B>speakPlainText</B>(java.lang.String text,
565 javax.speech.synthesis.SpeakableListener listener)
566 throws javax.speech.EngineStateError</PRE>
\r
568 <DD>Speaks a plain text <code>String</code>. No JSML parsing is
572 <DT><B>Specified by:</B><DD><CODE>speakPlainText</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE></DL>
\r
575 <DT><B>Parameters:</B><DD><CODE>text</CODE> - a <code>String</code> containing plain text.<DD><CODE>listener</CODE> - the listener to be notified as the
578 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Synthesizer</code> in the <code>DEALLOCATED</code> or
579 <code>DEALLOCATING_RESOURCES</code> states</DL>
\r
584 <A NAME="stateToString(long)"><!-- --></A><H3>
\r
587 protected java.lang.String <B>stateToString</B>(long state)</PRE>
\r
589 <DD>Returns a String of the names of all the states implied
590 in the given bit pattern.
\r
593 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#stateToString(long)">stateToString</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
596 <DT><B>Parameters:</B><DD><CODE>state</CODE> - the bit pattern of states
597 <DT><B>Returns:</B><DD>a String of the names of all the states implied
598 in the given bit pattern.</DL>
\r
603 <A NAME="appendQueue(com.sun.speech.engine.synthesis.BaseSynthesizerQueueItem)"><!-- --></A><H3>
\r
606 protected abstract 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
608 <DD>Puts an item on the speaking queue and sends a queue updated
615 <DT><B>Parameters:</B><DD><CODE>item</CODE> - the item to add to the queue</DL>
\r
620 <A NAME="phoneme(java.lang.String)"><!-- --></A><H3>
\r
623 public java.lang.String <B>phoneme</B>(java.lang.String text)
624 throws javax.speech.EngineStateError</PRE>
\r
626 <DD>Optional method that converts a text string to a phoneme string.
\r
629 <DT><B>Specified by:</B><DD><CODE>phoneme</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE></DL>
\r
632 <DT><B>Parameters:</B><DD><CODE>text</CODE> - plain text to be converted to phonemes
633 <DT><B>Returns:</B><DD>IPA phonemic representation of text or <code>null</code>
635 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Synthesizer</code> in the <code>DEALLOCATED</code> or
636 <code>DEALLOCATING_RESOURCES</code> states</DL>
\r
641 <A NAME="enumerateQueue()"><!-- --></A><H3>
\r
642 enumerateQueue</H3>
\r
644 public abstract java.util.Enumeration <B>enumerateQueue</B>()
645 throws javax.speech.EngineStateError</PRE>
\r
647 <DD>Returns an enumeration of the queue.
\r
650 <DT><B>Specified by:</B><DD><CODE>enumerateQueue</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE></DL>
\r
654 <DT><B>Returns:</B><DD>an <code>Enumeration</code> of the speech output queue or
657 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Synthesizer</code> in the <code>DEALLOCATED</code> or
658 <code>DEALLOCATING_RESOURCES</code> states</DL>
\r
663 <A NAME="cancel()"><!-- --></A><H3>
\r
666 public abstract void <B>cancel</B>()
667 throws javax.speech.EngineStateError</PRE>
\r
669 <DD>Cancels the item at the top of the queue.
\r
672 <DT><B>Specified by:</B><DD><CODE>cancel</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE></DL>
\r
677 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Synthesizer</code> in the <code>DEALLOCATED</code> or
678 <code>DEALLOCATING_RESOURCES</code> states</DL>
\r
683 <A NAME="cancel(java.lang.Object)"><!-- --></A><H3>
\r
686 public abstract void <B>cancel</B>(java.lang.Object source)
687 throws java.lang.IllegalArgumentException,
688 javax.speech.EngineStateError</PRE>
\r
690 <DD>Cancels a specific object on the queue.
\r
693 <DT><B>Specified by:</B><DD><CODE>cancel</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE></DL>
\r
696 <DT><B>Parameters:</B><DD><CODE>source</CODE> - object to be removed from the speech output queue
698 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if the source object is not found in the speech output queue.
699 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Synthesizer</code> in the <code>DEALLOCATED</code> or
700 <code>DEALLOCATING_RESOURCES</code> states</DL>
\r
705 <A NAME="cancelAll()"><!-- --></A><H3>
\r
708 public abstract void <B>cancelAll</B>()
709 throws javax.speech.EngineStateError</PRE>
\r
711 <DD>Cancels all items on the output queue.
\r
714 <DT><B>Specified by:</B><DD><CODE>cancelAll</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE></DL>
\r
719 <DD><CODE>javax.speech.EngineStateError</CODE> - if this <code>Synthesizer</code> in the <code>DEALLOCATED</code> or
720 <code>DEALLOCATING_RESOURCES</code> states</DL>
\r
725 <A NAME="getSynthesizerProperties()"><!-- --></A><H3>
\r
726 getSynthesizerProperties</H3>
\r
728 public javax.speech.synthesis.SynthesizerProperties <B>getSynthesizerProperties</B>()</PRE>
\r
730 <DD>Returns the <code>SynthesizerProperties</code> object (a JavaBean).
731 The method returns exactly the same object as the
732 <code>getEngineProperties</code> method in the <code>Engine</code>
733 interface. However, with the <code>getSynthesizerProperties</code>
734 method, an application does not need to cast the return value.
\r
737 <DT><B>Specified by:</B><DD><CODE>getSynthesizerProperties</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE></DL>
\r
741 <DT><B>Returns:</B><DD>the <code>SynthesizerProperties</code> object for this
742 <code>Synthesizer</code></DL>
\r
747 <A NAME="addSpeakableListener(javax.speech.synthesis.SpeakableListener)"><!-- --></A><H3>
\r
748 addSpeakableListener</H3>
\r
750 public void <B>addSpeakableListener</B>(javax.speech.synthesis.SpeakableListener listener)</PRE>
\r
752 <DD>Adds a <code>SpeakableListener</code> to this <code>Synthesizer</code>.
\r
755 <DT><B>Specified by:</B><DD><CODE>addSpeakableListener</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE></DL>
\r
758 <DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener to add<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#removeSpeakableListener(javax.speech.synthesis.SpeakableListener)"><CODE>removeSpeakableListener(javax.speech.synthesis.SpeakableListener)</CODE></A></DL>
\r
763 <A NAME="removeSpeakableListener(javax.speech.synthesis.SpeakableListener)"><!-- --></A><H3>
\r
764 removeSpeakableListener</H3>
\r
766 public void <B>removeSpeakableListener</B>(javax.speech.synthesis.SpeakableListener listener)</PRE>
\r
768 <DD>Removes a <code>SpeakableListener</code> from this
769 <code>Synthesizer</code>.
\r
772 <DT><B>Specified by:</B><DD><CODE>removeSpeakableListener</CODE> in interface <CODE>javax.speech.synthesis.Synthesizer</CODE></DL>
\r
775 <DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener to remove<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#addSpeakableListener(javax.speech.synthesis.SpeakableListener)"><CODE>addSpeakableListener(javax.speech.synthesis.SpeakableListener)</CODE></A></DL>
\r
780 <A NAME="createEngineProperties()"><!-- --></A><H3>
\r
781 createEngineProperties</H3>
\r
783 protected <A HREF="../../../../../com/sun/speech/engine/BaseEngineProperties.html" title="class in com.sun.speech.engine">BaseEngineProperties</A> <B>createEngineProperties</B>()</PRE>
\r
785 <DD>Factory constructor for <code>EngineProperties</code> object.
786 Gets the default speaking voice from the
787 <code>SynthesizerModeDesc</code>.
788 Takes the default prosody values (pitch, range, volume, rate)
789 from the default voice. Override to set engine-specific defaults.
\r
792 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#createEngineProperties()">createEngineProperties</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
796 <DT><B>Returns:</B><DD>a <code>BaseEngineProperties</code> object specific to
802 <A NAME="createQueueItem()"><!-- --></A><H3>
\r
803 createQueueItem</H3>
\r
805 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
807 <DD>Factory method that creates a <code>BaseSynthesizerQueueItem</code>.
808 Override if the synthesizer specializes the
809 <code>BaseSynthesizerQueueItem</code> class.
\r
820 <A NAME="getVoiceList()"><!-- --></A><H3>
\r
823 protected <A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html" title="class in com.sun.speech.engine.synthesis">VoiceList</A> <B>getVoiceList</B>()</PRE>
\r
825 <DD>Returns the list of voices for this <code>Synthesizer</code>.
\r
832 <DT><B>Returns:</B><DD>the list of voices for this <code>Synthesizer</code>.</DL>
\r
837 <A NAME="postQueueUpdated(boolean, long, long)"><!-- --></A><H3>
\r
838 postQueueUpdated</H3>
\r
840 public void <B>postQueueUpdated</B>(boolean topOfQueueChanged,
842 long newState)</PRE>
\r
844 <DD>Utility function that generates <code>QUEUE_UPDATED</code>
845 event and posts it to the event queue. Eventually
846 <code>fireQueueUpdated</code> will be called
847 by <code>dispatchSpeechEvent</code> as a result of this action.
\r
853 <DT><B>Parameters:</B><DD><CODE>topOfQueueChanged</CODE> - <code>true</code> if the top of the
854 queue has changed<DD><CODE>oldState</CODE> - the old state of this <code>Synthesizer</code><DD><CODE>newState</CODE> - the new state of this <code>Synthesizer</code><DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#fireQueueUpdated(javax.speech.synthesis.SynthesizerEvent)"><CODE>fireQueueUpdated(javax.speech.synthesis.SynthesizerEvent)</CODE></A>,
855 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
860 <A NAME="fireQueueUpdated(javax.speech.synthesis.SynthesizerEvent)"><!-- --></A><H3>
\r
861 fireQueueUpdated</H3>
\r
863 public void <B>fireQueueUpdated</B>(javax.speech.synthesis.SynthesizerEvent event)</PRE>
\r
865 <DD>Utility function that sends a <code>QUEUE_UPDATED</code>
866 event to all <code>SynthesizerListeners</code>.
\r
872 <DT><B>Parameters:</B><DD><CODE>event</CODE> - the <code>QUEUE_UPDATED</code> event<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#postQueueUpdated(boolean, long, long)"><CODE>postQueueUpdated(boolean, long, long)</CODE></A>,
873 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
878 <A NAME="postQueueEmptied(long, long)"><!-- --></A><H3>
\r
879 postQueueEmptied</H3>
\r
881 public void <B>postQueueEmptied</B>(long oldState,
882 long newState)</PRE>
\r
884 <DD>Utility function that generates <code>QUEUE_EMPTIED</code>
885 event and posts it to the event queue. Eventually
886 <code>fireQueueEmptied</code> will be called
887 by <code>dispatchSpeechEvent</code> as a result of this action.
\r
893 <DT><B>Parameters:</B><DD><CODE>oldState</CODE> - the old state of this <code>Synthesizer</code><DD><CODE>newState</CODE> - the new state of this <code>Synthesizer</code><DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#fireQueueEmptied(javax.speech.synthesis.SynthesizerEvent)"><CODE>fireQueueEmptied(javax.speech.synthesis.SynthesizerEvent)</CODE></A>,
894 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
899 <A NAME="fireQueueEmptied(javax.speech.synthesis.SynthesizerEvent)"><!-- --></A><H3>
\r
900 fireQueueEmptied</H3>
\r
902 public void <B>fireQueueEmptied</B>(javax.speech.synthesis.SynthesizerEvent event)</PRE>
\r
904 <DD>Utility function that sends a <code>QUEUE_EMPTIED</code>
905 event to all <code>SynthesizerListeners</code>.
\r
911 <DT><B>Parameters:</B><DD><CODE>event</CODE> - the <code>QUEUE_EMPTIED</code> event<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#postQueueEmptied(long, long)"><CODE>postQueueEmptied(long, long)</CODE></A>,
912 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#dispatchSpeechEvent(javax.speech.SpeechEvent)"><CODE>dispatchSpeechEvent(javax.speech.SpeechEvent)</CODE></A></DL>
\r
917 <A NAME="dispatchSpeechEvent(javax.speech.SpeechEvent)"><!-- --></A><H3>
\r
918 dispatchSpeechEvent</H3>
\r
920 public void <B>dispatchSpeechEvent</B>(javax.speech.SpeechEvent event)</PRE>
\r
922 <DD>Dispatches a <code>SpeechEvent</code>.
923 The dispatcher should notify all <code>SynthesizerListeners</code>
924 from this method. The <code>SpeechEvent</code> was added
925 via the various post methods of this class.
\r
928 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/SpeechEventDispatcher.html#dispatchSpeechEvent(javax.speech.SpeechEvent)">dispatchSpeechEvent</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/engine/SpeechEventDispatcher.html" title="interface in com.sun.speech.engine">SpeechEventDispatcher</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/engine/BaseEngine.html#dispatchSpeechEvent(javax.speech.SpeechEvent)">dispatchSpeechEvent</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
931 <DT><B>Parameters:</B><DD><CODE>event</CODE> - the <code>SpeechEvent</code> to dispatch<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#postQueueUpdated(boolean, long, long)"><CODE>postQueueUpdated(boolean, long, long)</CODE></A>,
932 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizer.html#postQueueEmptied(long, long)"><CODE>postQueueEmptied(long, long)</CODE></A></DL>
\r
935 <!-- ========= END OF CLASS DATA ========= -->
\r
939 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
940 <A NAME="navbar_bottom"><!-- --></A>
941 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
942 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
944 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
945 <A NAME="navbar_bottom_firstrow"><!-- --></A>
946 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
947 <TR ALIGN="center" VALIGN="top">
\r
948 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
949 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
950 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
951 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
952 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
953 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
954 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
958 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
964 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
965 PREV CLASS
\r
966 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseSynthesizerProperties.html" title="class in com.sun.speech.engine.synthesis"><B>NEXT CLASS</B></A></FONT></TD>
\r
967 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
968 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
969 <A HREF="BaseSynthesizer.html" target="_top"><B>NO FRAMES</B></A>
\r
970 <SCRIPT type="text/javascript">
\r
973 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
978 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
984 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
985 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
986 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
987 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
990 <A NAME="skip-navbar_bottom"></A>
991 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r