upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / jsapi / FreeTTSSynthesizerModeDesc.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:30 CET 2009 -->\r
6 <TITLE>\r
7 FreeTTSSynthesizerModeDesc (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.jsapi.FreeTTSSynthesizerModeDesc 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="FreeTTSSynthesizerModeDesc (FreeTTS 1.2)";\r
18 }\r
19 </SCRIPT>\r
20 \r
21 </HEAD>\r
22 \r
23 <BODY BGCOLOR="white" onload="windowTitle();">\r
24 \r
25
26 <!-- ========= START OF TOP NAVBAR ======= -->\r
27 <A NAME="navbar_top"><!-- --></A>
28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
30 <TR>\r
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
34   <TR ALIGN="center" VALIGN="top">\r
35   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
36   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
37   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
42   </TR>\r
43 </TABLE>\r
44 </TD>\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
46 </EM>\r
47 </TD>\r
48 </TR>\r
49 \r
50 <TR>\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
52 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html" title="class in com.sun.speech.freetts.jsapi"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizerQueueItem.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>  &nbsp;\r
56 &nbsp;<A HREF="FreeTTSSynthesizerModeDesc.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.freetts.jsapi</FONT>\r
85 <BR>\r
86 Class FreeTTSSynthesizerModeDesc</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.freetts.jsapi.FreeTTSSynthesizerModeDesc</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>FreeTTSSynthesizerModeDesc</B><DT>extends javax.speech.synthesis.SynthesizerModeDesc<DT>implements javax.speech.EngineCreate</DL>\r
99 \r
100 <P>\r
101 Represents a SynthesizerModeDesc for the
102  FreeTTSSynthesizer. A FreeTTSSynthesizerModeDesc adds 
103  an audio player to the standard mode items.\r
104 <P>\r
105 \r
106 <P>\r
107 <HR>\r
108 \r
109 <P>\r
110 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
111 \r
112 \r
113 <!-- =========== FIELD SUMMARY =========== -->\r
114 \r
115 \r
116 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
117 \r
118 <A NAME="constructor_summary"><!-- --></A>
119 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
120 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
121 <TD COLSPAN=2><FONT SIZE="+2">\r
122 <B>Constructor Summary</B></FONT></TD>\r
123 </TR>\r
124 <TR BGCOLOR="white" CLASS="TableRowColor">\r
125 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizerModeDesc.html#FreeTTSSynthesizerModeDesc(java.lang.String, java.lang.String, java.util.Locale)">FreeTTSSynthesizerModeDesc</A></B>(java.lang.String&nbsp;engineName,
126                            java.lang.String&nbsp;modeName,
127                            java.util.Locale&nbsp;locale)</CODE>\r
128 \r
129 <BR>\r
130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a fully-specified descriptor.
131  </TD>\r
132 </TR>\r
133 </TABLE>\r
134 &nbsp;\r
135 <!-- ========== METHOD SUMMARY =========== -->\r
136 \r
137 <A NAME="method_summary"><!-- --></A>
138 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
139 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
140 <TD COLSPAN=2><FONT SIZE="+2">\r
141 <B>Method Summary</B></FONT></TD>\r
142 </TR>\r
143 <TR BGCOLOR="white" CLASS="TableRowColor">\r
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
145 <CODE>&nbsp;javax.speech.Engine</CODE></FONT></TD>\r
146 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizerModeDesc.html#createEngine()">createEngine</A></B>()</CODE>\r
147 \r
148 <BR>\r
149 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a FreeTTSSynthesizer with the properties of this mode
150  descriptor.</TD>\r
151 </TR>\r
152 <TR BGCOLOR="white" CLASS="TableRowColor">\r
153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
154 <CODE>&nbsp;javax.speech.synthesis.Voice[]</CODE></FONT></TD>\r
155 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizerModeDesc.html#getVoices()">getVoices</A></B>()</CODE>\r
156 \r
157 <BR>\r
158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the valid voices in this synthesizer mode.</TD>\r
159 </TR>\r
160 <TR BGCOLOR="white" CLASS="TableRowColor">\r
161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
162 <CODE>&nbsp;void</CODE></FONT></TD>\r
163 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizerModeDesc.html#validate()">validate</A></B>()</CODE>\r
164 \r
165 <BR>\r
166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if this is a valid FreeTTSSynthesizerModeDesc.
167  </TD>\r
168 </TR>\r
169 </TABLE>\r
170 &nbsp;<A NAME="methods_inherited_from_class_javax.speech.synthesis.SynthesizerModeDesc"><!-- --></A>
171 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
172 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
173 <TD><B>Methods inherited from class javax.speech.synthesis.SynthesizerModeDesc</B></TD>\r
174 </TR>\r
175 <TR BGCOLOR="white" CLASS="TableRowColor">\r
176 <TD><CODE>addVoice, equals, match, setVoices</CODE></TD>\r
177 </TR>\r
178 </TABLE>\r
179 &nbsp;<A NAME="methods_inherited_from_class_javax.speech.EngineModeDesc"><!-- --></A>
180 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
181 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
182 <TD><B>Methods inherited from class javax.speech.EngineModeDesc</B></TD>\r
183 </TR>\r
184 <TR BGCOLOR="white" CLASS="TableRowColor">\r
185 <TD><CODE>getEngineName, getLocale, getModeName, getRunning, setEngineName, setLocale, setModeName, setRunning</CODE></TD>\r
186 </TR>\r
187 </TABLE>\r
188 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
189 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
190 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
191 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
192 </TR>\r
193 <TR BGCOLOR="white" CLASS="TableRowColor">\r
194 <TD><CODE>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
195 </TR>\r
196 </TABLE>\r
197 &nbsp;\r
198 <P>\r
199 \r
200 <!-- ============ FIELD DETAIL =========== -->\r
201 \r
202 \r
203 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
204 \r
205 <A NAME="constructor_detail"><!-- --></A>
206 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
207 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
208 <TD COLSPAN=1><FONT SIZE="+2">\r
209 <B>Constructor Detail</B></FONT></TD>\r
210 </TR>\r
211 </TABLE>\r
212 \r
213 <A NAME="FreeTTSSynthesizerModeDesc(java.lang.String, java.lang.String, java.util.Locale)"><!-- --></A><H3>\r
214 FreeTTSSynthesizerModeDesc</H3>\r
215 <PRE>\r
216 public <B>FreeTTSSynthesizerModeDesc</B>(java.lang.String&nbsp;engineName,
217                                   java.lang.String&nbsp;modeName,
218                                   java.util.Locale&nbsp;locale)</PRE>\r
219 <DL>\r
220 <DD>Creates a fully-specified descriptor.
221  Any of the features may be <code>null</code>.\r
222 <P>\r
223 <DT><B>Parameters:</B><DD><CODE>engineName</CODE> - the name of the engine<DD><CODE>modeName</CODE> - the name of the mode<DD><CODE>locale</CODE> - the locale associated with this mode</DL>\r
224 \r
225 <!-- ============ METHOD DETAIL ========== -->\r
226 \r
227 <A NAME="method_detail"><!-- --></A>
228 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
229 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
230 <TD COLSPAN=1><FONT SIZE="+2">\r
231 <B>Method Detail</B></FONT></TD>\r
232 </TR>\r
233 </TABLE>\r
234 \r
235 <A NAME="getVoices()"><!-- --></A><H3>\r
236 getVoices</H3>\r
237 <PRE>\r
238 public javax.speech.synthesis.Voice[] <B>getVoices</B>()</PRE>\r
239 <DL>\r
240 <DD>Returns the valid voices in this synthesizer mode.\r
241 <P>\r
242 <DD><DL>\r
243 </DL>\r
244 </DD>\r
245 <DD><DL>\r
246
247 <DT><B>Returns:</B><DD>an array of valid voices, if no valid voices, it will
248     return an array of size 0</DL>\r
249 </DD>\r
250 </DL>\r
251 <HR>\r
252 \r
253 <A NAME="validate()"><!-- --></A><H3>\r
254 validate</H3>\r
255 <PRE>\r
256 public void <B>validate</B>()
257               throws <A HREF="../../../../../com/sun/speech/freetts/ValidationException.html" title="class in com.sun.speech.freetts">ValidationException</A></PRE>\r
258 <DL>\r
259 <DD>Returns true if this is a valid FreeTTSSynthesizerModeDesc.
260  It is valid if it contains at least one valid Voice.
261  Returns false otherwise.\r
262 <P>\r
263 <DD><DL>\r
264 </DL>\r
265 </DD>\r
266 <DD><DL>\r
267
268 <DT><B>Throws:</B>
269 <DD><CODE><A HREF="../../../../../com/sun/speech/freetts/ValidationException.html" title="class in com.sun.speech.freetts">ValidationException</A></CODE> - if this FreeTTSSynthesizerModeDesc
270     is invalid</DL>\r
271 </DD>\r
272 </DL>\r
273 <HR>\r
274 \r
275 <A NAME="createEngine()"><!-- --></A><H3>\r
276 createEngine</H3>\r
277 <PRE>\r
278 public javax.speech.Engine <B>createEngine</B>()
279                                  throws java.lang.IllegalArgumentException,
280                                         javax.speech.EngineException,
281                                         java.lang.SecurityException</PRE>\r
282 <DL>\r
283 <DD>Constructs a FreeTTSSynthesizer with the properties of this mode
284  descriptor.\r
285 <P>\r
286 <DD><DL>\r
287 <DT><B>Specified by:</B><DD><CODE>createEngine</CODE> in interface <CODE>javax.speech.EngineCreate</CODE></DL>\r
288 </DD>\r
289 <DD><DL>\r
290
291 <DT><B>Returns:</B><DD>a synthesizer that mathes the mode
292 <DT><B>Throws:</B>
293 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if the properties of this
294                 descriptor do not match any known engine or mode
295 <DD><CODE>javax.speech.EngineException</CODE> - if the engine could not be created
296 <DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have
297                 permission to use the speech engine</DL>\r
298 </DD>\r
299 </DL>\r
300 <!-- ========= END OF CLASS DATA ========= -->\r
301 <HR>\r
302 \r
303
304 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
305 <A NAME="navbar_bottom"><!-- --></A>
306 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
307 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
308 <TR>\r
309 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
310 <A NAME="navbar_bottom_firstrow"><!-- --></A>
311 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
312   <TR ALIGN="center" VALIGN="top">\r
313   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
314   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
315   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
316   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
317   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
318   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
319   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
320   </TR>\r
321 </TABLE>\r
322 </TD>\r
323 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
324 </EM>\r
325 </TD>\r
326 </TR>\r
327 \r
328 <TR>\r
329 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
330 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizer.html" title="class in com.sun.speech.freetts.jsapi"><B>PREV CLASS</B></A>&nbsp;\r
331 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/jsapi/FreeTTSSynthesizerQueueItem.html" title="class in com.sun.speech.freetts.jsapi"><B>NEXT CLASS</B></A></FONT></TD>\r
332 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
333   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
334 &nbsp;<A HREF="FreeTTSSynthesizerModeDesc.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
335 &nbsp;<SCRIPT type="text/javascript">\r
336   <!--\r
337   if(window==top) {\r
338     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
339   }\r
340   //-->\r
341 </SCRIPT>\r
342 <NOSCRIPT>\r
343   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
344 </NOSCRIPT>
345 \r
346 </FONT></TD>\r
347 </TR>\r
348 <TR>\r
349 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
350   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
351 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
352 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
353 </TR>\r
354 </TABLE>\r
355 <A NAME="skip-navbar_bottom"></A>
356 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
357 \r
358 <HR>\r
359 \r
360 </BODY>\r
361 </HTML>\r