upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / engine / synthesis / text / TextSynthesizerModeDesc.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:29 CET 2009 -->\r
6 <TITLE>\r
7 TextSynthesizerModeDesc (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.engine.synthesis.text.TextSynthesizerModeDesc class">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     parent.document.title="TextSynthesizerModeDesc (FreeTTS 1.2)";\r
18 }\r
19 </SCRIPT>\r
20 \r
21 </HEAD>\r
22 \r
23 <BODY BGCOLOR="white" onload="windowTitle();">\r
24 \r
25
26 <!-- ========= START OF TOP NAVBAR ======= -->\r
27 <A NAME="navbar_top"><!-- --></A>
28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
30 <TR>\r
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
34   <TR ALIGN="center" VALIGN="top">\r
35   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
36   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
37   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
42   </TR>\r
43 </TABLE>\r
44 </TD>\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
46 </EM>\r
47 </TD>\r
48 </TR>\r
49 \r
50 <TR>\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
52 &nbsp;<A HREF="../../../../../../com/sun/speech/engine/synthesis/text/TextSynthesizer.OutputHandler.html" title="class in com.sun.speech.engine.synthesis.text"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../../../com/sun/speech/engine/synthesis/text/TextSynthesizerQueueItem.html" title="class in com.sun.speech.engine.synthesis.text"><B>NEXT CLASS</B></A></FONT></TD>\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
55   <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
56 &nbsp;<A HREF="TextSynthesizerModeDesc.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
57 &nbsp;<SCRIPT type="text/javascript">\r
58   <!--\r
59   if(window==top) {\r
60     document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
61   }\r
62   //-->\r
63 </SCRIPT>\r
64 <NOSCRIPT>\r
65   <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
66 </NOSCRIPT>
67 \r
68 </FONT></TD>\r
69 </TR>\r
70 <TR>\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
72   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
74 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
75 </TR>\r
76 </TABLE>\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->\r
79 \r
80 <HR>\r
81 <!-- ======== START OF CLASS DATA ======== -->\r
82 <H2>\r
83 <FONT SIZE="-1">\r
84 com.sun.speech.engine.synthesis.text</FONT>\r
85 <BR>\r
86 Class TextSynthesizerModeDesc</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by">javax.speech.EngineModeDesc\r
90       <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by">javax.speech.synthesis.SynthesizerModeDesc\r
91           <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.engine.synthesis.text.TextSynthesizerModeDesc</B>\r
92 </PRE>\r
93 <DL>\r
94 <DT><B>All Implemented Interfaces:</B> <DD>javax.speech.EngineCreate</DD>\r
95 </DL>\r
96 <HR>\r
97 <DL>\r
98 <DT>public class <B>TextSynthesizerModeDesc</B><DT>extends javax.speech.synthesis.SynthesizerModeDesc<DT>implements javax.speech.EngineCreate</DL>\r
99 \r
100 <P>\r
101 Describes the <code>TextSynthesizer</code>.   Builds up the
102  voice list and other data.\r
103 <P>\r
104 \r
105 <P>\r
106 <HR>\r
107 \r
108 <P>\r
109 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
110 \r
111 \r
112 <!-- =========== FIELD SUMMARY =========== -->\r
113 \r
114 \r
115 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
116 \r
117 <A NAME="constructor_summary"><!-- --></A>
118 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
119 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
120 <TD COLSPAN=2><FONT SIZE="+2">\r
121 <B>Constructor Summary</B></FONT></TD>\r
122 </TR>\r
123 <TR BGCOLOR="white" CLASS="TableRowColor">\r
124 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/engine/synthesis/text/TextSynthesizerModeDesc.html#TextSynthesizerModeDesc()">TextSynthesizerModeDesc</A></B>()</CODE>\r
125 \r
126 <BR>\r
127 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Class constructor.</TD>\r
128 </TR>\r
129 </TABLE>\r
130 &nbsp;\r
131 <!-- ========== METHOD SUMMARY =========== -->\r
132 \r
133 <A NAME="method_summary"><!-- --></A>
134 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
135 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
136 <TD COLSPAN=2><FONT SIZE="+2">\r
137 <B>Method Summary</B></FONT></TD>\r
138 </TR>\r
139 <TR BGCOLOR="white" CLASS="TableRowColor">\r
140 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
141 <CODE>&nbsp;javax.speech.Engine</CODE></FONT></TD>\r
142 <TD><CODE><B><A HREF="../../../../../../com/sun/speech/engine/synthesis/text/TextSynthesizerModeDesc.html#createEngine()">createEngine</A></B>()</CODE>\r
143 \r
144 <BR>\r
145 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a text synthesizer with the properties of this mode
146  desc.</TD>\r
147 </TR>\r
148 </TABLE>\r
149 &nbsp;<A NAME="methods_inherited_from_class_javax.speech.synthesis.SynthesizerModeDesc"><!-- --></A>
150 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
151 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
152 <TD><B>Methods inherited from class javax.speech.synthesis.SynthesizerModeDesc</B></TD>\r
153 </TR>\r
154 <TR BGCOLOR="white" CLASS="TableRowColor">\r
155 <TD><CODE>addVoice, equals, getVoices, match, setVoices</CODE></TD>\r
156 </TR>\r
157 </TABLE>\r
158 &nbsp;<A NAME="methods_inherited_from_class_javax.speech.EngineModeDesc"><!-- --></A>
159 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
160 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
161 <TD><B>Methods inherited from class javax.speech.EngineModeDesc</B></TD>\r
162 </TR>\r
163 <TR BGCOLOR="white" CLASS="TableRowColor">\r
164 <TD><CODE>getEngineName, getLocale, getModeName, getRunning, setEngineName, setLocale, setModeName, setRunning</CODE></TD>\r
165 </TR>\r
166 </TABLE>\r
167 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
168 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
169 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
170 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
171 </TR>\r
172 <TR BGCOLOR="white" CLASS="TableRowColor">\r
173 <TD><CODE>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
174 </TR>\r
175 </TABLE>\r
176 &nbsp;\r
177 <P>\r
178 \r
179 <!-- ============ FIELD DETAIL =========== -->\r
180 \r
181 \r
182 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
183 \r
184 <A NAME="constructor_detail"><!-- --></A>
185 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
186 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
187 <TD COLSPAN=1><FONT SIZE="+2">\r
188 <B>Constructor Detail</B></FONT></TD>\r
189 </TR>\r
190 </TABLE>\r
191 \r
192 <A NAME="TextSynthesizerModeDesc()"><!-- --></A><H3>\r
193 TextSynthesizerModeDesc</H3>\r
194 <PRE>\r
195 public <B>TextSynthesizerModeDesc</B>()</PRE>\r
196 <DL>\r
197 <DD>Class constructor.\r
198 <P>\r
199 </DL>\r
200 \r
201 <!-- ============ METHOD DETAIL ========== -->\r
202 \r
203 <A NAME="method_detail"><!-- --></A>
204 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
205 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
206 <TD COLSPAN=1><FONT SIZE="+2">\r
207 <B>Method Detail</B></FONT></TD>\r
208 </TR>\r
209 </TABLE>\r
210 \r
211 <A NAME="createEngine()"><!-- --></A><H3>\r
212 createEngine</H3>\r
213 <PRE>\r
214 public javax.speech.Engine <B>createEngine</B>()
215                                  throws java.lang.IllegalArgumentException,
216                                         javax.speech.EngineException,
217                                         java.lang.SecurityException</PRE>\r
218 <DL>\r
219 <DD>Constructs a text synthesizer with the properties of this mode
220  desc.\r
221 <P>\r
222 <DD><DL>\r
223 <DT><B>Specified by:</B><DD><CODE>createEngine</CODE> in interface <CODE>javax.speech.EngineCreate</CODE></DL>\r
224 </DD>\r
225 <DD><DL>\r
226
227 <DT><B>Throws:</B>
228 <DD><CODE>java.lang.IllegalArgumentException</CODE>
229 <DD><CODE>javax.speech.EngineException</CODE>
230 <DD><CODE>java.lang.SecurityException</CODE></DL>\r
231 </DD>\r
232 </DL>\r
233 <!-- ========= END OF CLASS DATA ========= -->\r
234 <HR>\r
235 \r
236
237 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
238 <A NAME="navbar_bottom"><!-- --></A>
239 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
240 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
241 <TR>\r
242 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
243 <A NAME="navbar_bottom_firstrow"><!-- --></A>
244 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
245   <TR ALIGN="center" VALIGN="top">\r
246   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
247   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
248   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
249   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
250   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
251   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
252   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
253   </TR>\r
254 </TABLE>\r
255 </TD>\r
256 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
257 </EM>\r
258 </TD>\r
259 </TR>\r
260 \r
261 <TR>\r
262 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
263 &nbsp;<A HREF="../../../../../../com/sun/speech/engine/synthesis/text/TextSynthesizer.OutputHandler.html" title="class in com.sun.speech.engine.synthesis.text"><B>PREV CLASS</B></A>&nbsp;\r
264 &nbsp;<A HREF="../../../../../../com/sun/speech/engine/synthesis/text/TextSynthesizerQueueItem.html" title="class in com.sun.speech.engine.synthesis.text"><B>NEXT CLASS</B></A></FONT></TD>\r
265 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
266   <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
267 &nbsp;<A HREF="TextSynthesizerModeDesc.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
268 &nbsp;<SCRIPT type="text/javascript">\r
269   <!--\r
270   if(window==top) {\r
271     document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
272   }\r
273   //-->\r
274 </SCRIPT>\r
275 <NOSCRIPT>\r
276   <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
277 </NOSCRIPT>
278 \r
279 </FONT></TD>\r
280 </TR>\r
281 <TR>\r
282 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
283   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
284 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
285 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
286 </TR>\r
287 </TABLE>\r
288 <A NAME="skip-navbar_bottom"></A>
289 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
290 \r
291 <HR>\r
292 \r
293 </BODY>\r
294 </HTML>\r