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 FreeTTSSpeakable (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.FreeTTSSpeakable interface">
\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="FreeTTSSpeakable (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/FeatureSet.html" title="interface in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/freetts/PartOfSpeech.html" title="interface in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
55 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
56 <A HREF="FreeTTSSpeakable.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->
\r
81 <!-- ======== START OF CLASS DATA ======== -->
\r
84 com.sun.speech.freetts</FONT>
\r
86 Interface FreeTTSSpeakable</H2>
\r
88 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html" title="class in com.sun.speech.freetts">FreeTTSSpeakableImpl</A>, <A HREF="../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizerQueueItem.html" title="class in com.sun.speech.freetts.jsapi">FreeTTSSynthesizerQueueItem</A></DD>
\r
92 <DT>public interface <B>FreeTTSSpeakable</B></DL>
\r
95 Represents something that should be spoken.
\r
102 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
105 <!-- =========== FIELD SUMMARY =========== -->
\r
108 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
111 <!-- ========== METHOD SUMMARY =========== -->
\r
113 <A NAME="method_summary"><!-- --></A>
114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
116 <TD COLSPAN=2><FONT SIZE="+2">
\r
117 <B>Method Summary</B></FONT></TD>
\r
119 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
120 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
121 <CODE> void</CODE></FONT></TD>
\r
122 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#cancelled()">cancelled</A></B>()</CODE>
\r
125 Indicates that this speakable has been cancelled.</TD>
\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
129 <CODE> void</CODE></FONT></TD>
\r
130 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#completed()">completed</A></B>()</CODE>
\r
133 Indicates that this speakable has been completed.</TD>
\r
135 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
137 <CODE> org.w3c.dom.Document</CODE></FONT></TD>
\r
138 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#getDocument()">getDocument</A></B>()</CODE>
\r
141 Gets the DOM document for this object.</TD>
\r
143 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
145 <CODE> java.io.InputStream</CODE></FONT></TD>
\r
146 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#getInputStream()">getInputStream</A></B>()</CODE>
\r
149 Gets the input stream</TD>
\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
153 <CODE> java.lang.String</CODE></FONT></TD>
\r
154 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#getText()">getText</A></B>()</CODE>
\r
157 Returns the text corresponding to this Playable.</TD>
\r
159 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
161 <CODE> boolean</CODE></FONT></TD>
\r
162 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#isCompleted()">isCompleted</A></B>()</CODE>
\r
165 Returns <code>true</code> if this queue item has been
168 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
170 <CODE> boolean</CODE></FONT></TD>
\r
171 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#isDocument()">isDocument</A></B>()</CODE>
\r
174 Returns <code>true</code> if the item is a JSML document
175 (Java Speech Markup Language).</TD>
\r
177 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
178 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
179 <CODE> boolean</CODE></FONT></TD>
\r
180 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#isPlainText()">isPlainText</A></B>()</CODE>
\r
183 Returns <code>true</code> if the item contains plain text
184 (not Java Speech Markup Language text).</TD>
\r
186 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
188 <CODE> boolean</CODE></FONT></TD>
\r
189 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#isStream()">isStream</A></B>()</CODE>
\r
192 Returns <code>true</code> if the item is an input stream.</TD>
\r
194 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
195 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
196 <CODE> void</CODE></FONT></TD>
\r
197 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#started()">started</A></B>()</CODE>
\r
200 Indicates that this speakable has been started.</TD>
\r
202 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
203 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
204 <CODE> boolean</CODE></FONT></TD>
\r
205 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html#waitCompleted()">waitCompleted</A></B>()</CODE>
\r
208 Waits for this speakable item to be completed.</TD>
\r
214 <!-- ============ FIELD DETAIL =========== -->
\r
217 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
220 <!-- ============ METHOD DETAIL ========== -->
\r
222 <A NAME="method_detail"><!-- --></A>
223 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
224 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
225 <TD COLSPAN=1><FONT SIZE="+2">
\r
226 <B>Method Detail</B></FONT></TD>
\r
230 <A NAME="started()"><!-- --></A><H3>
\r
233 public void <B>started</B>()</PRE>
\r
235 <DD>Indicates that this speakable has been started.
\r
243 <A NAME="completed()"><!-- --></A><H3>
\r
246 public void <B>completed</B>()</PRE>
\r
248 <DD>Indicates that this speakable has been completed.
\r
256 <A NAME="cancelled()"><!-- --></A><H3>
\r
259 public void <B>cancelled</B>()</PRE>
\r
261 <DD>Indicates that this speakable has been cancelled.
\r
269 <A NAME="isCompleted()"><!-- --></A><H3>
\r
272 public boolean <B>isCompleted</B>()</PRE>
\r
274 <DD>Returns <code>true</code> if this queue item has been
279 <DT><B>Returns:</B><DD>true if it has been processed</DL>
\r
284 <A NAME="waitCompleted()"><!-- --></A><H3>
\r
287 public boolean <B>waitCompleted</B>()</PRE>
\r
289 <DD>Waits for this speakable item to be completed.
\r
293 <DT><B>Returns:</B><DD>true if the item was completed successfully, false if
294 the speakable was cancelled or an error occurred.</DL>
\r
299 <A NAME="isPlainText()"><!-- --></A><H3>
\r
302 public boolean <B>isPlainText</B>()</PRE>
\r
304 <DD>Returns <code>true</code> if the item contains plain text
305 (not Java Speech Markup Language text).
\r
309 <DT><B>Returns:</B><DD>true if the item contains plain text</DL>
\r
314 <A NAME="isStream()"><!-- --></A><H3>
\r
317 public boolean <B>isStream</B>()</PRE>
\r
319 <DD>Returns <code>true</code> if the item is an input stream.
\r
323 <DT><B>Returns:</B><DD>true if the item is an input stream</DL>
\r
328 <A NAME="isDocument()"><!-- --></A><H3>
\r
331 public boolean <B>isDocument</B>()</PRE>
\r
333 <DD>Returns <code>true</code> if the item is a JSML document
334 (Java Speech Markup Language).
\r
338 <DT><B>Returns:</B><DD>true if the item is a document</DL>
\r
343 <A NAME="getText()"><!-- --></A><H3>
\r
346 public java.lang.String <B>getText</B>()</PRE>
\r
348 <DD>Returns the text corresponding to this Playable.
\r
352 <DT><B>Returns:</B><DD>the Playable text</DL>
\r
357 <A NAME="getDocument()"><!-- --></A><H3>
\r
360 public org.w3c.dom.Document <B>getDocument</B>()</PRE>
\r
362 <DD>Gets the DOM document for this object.
\r
366 <DT><B>Returns:</B><DD>the DOM document for this object</DL>
\r
371 <A NAME="getInputStream()"><!-- --></A><H3>
\r
372 getInputStream</H3>
\r
374 public java.io.InputStream <B>getInputStream</B>()</PRE>
\r
376 <DD>Gets the input stream
\r
380 <DT><B>Returns:</B><DD>the input stream</DL>
\r
383 <!-- ========= END OF CLASS DATA ========= -->
\r
387 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
388 <A NAME="navbar_bottom"><!-- --></A>
389 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
390 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
392 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
393 <A NAME="navbar_bottom_firstrow"><!-- --></A>
394 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
395 <TR ALIGN="center" VALIGN="top">
\r
396 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
397 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
398 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
399 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
400 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
401 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
402 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
406 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
412 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
413 <A HREF="../../../../com/sun/speech/freetts/FeatureSet.html" title="interface in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
414 <A HREF="../../../../com/sun/speech/freetts/PartOfSpeech.html" title="interface in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
415 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
416 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
417 <A HREF="FreeTTSSpeakable.html" target="_top"><B>NO FRAMES</B></A>
\r
418 <SCRIPT type="text/javascript">
\r
421 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
426 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
432 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
433 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
434 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
435 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
438 <A NAME="skip-navbar_bottom"></A>
439 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
projects / debian / freetts / blob