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 VoiceList (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.engine.synthesis.VoiceList 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="VoiceList (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/engine/synthesis/SynthesizerSelector.html" title="class in com.sun.speech.engine.synthesis"><B>PREV CLASS</B></A>
\r
53 NEXT CLASS</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="VoiceList.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 VoiceList</H2>
\r
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.engine.synthesis.VoiceList</B>
\r
93 <DT>public class <B>VoiceList</B><DT>extends java.lang.Object</DL>
\r
96 Maintains a list of JSAPI 1.0 <code>Voices</code>.
\r
103 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
106 <!-- =========== FIELD SUMMARY =========== -->
\r
108 <A NAME="field_summary"><!-- --></A>
109 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
110 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
111 <TD COLSPAN=2><FONT SIZE="+2">
\r
112 <B>Field Summary</B></FONT></TD>
\r
114 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
115 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
116 <CODE>protected java.util.List</CODE></FONT></TD>
\r
117 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html#voiceList">voiceList</A></B></CODE>
\r
120 The list of <code>Voices</code>.</TD>
\r
124 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
126 <A NAME="constructor_summary"><!-- --></A>
127 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
128 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
129 <TD COLSPAN=2><FONT SIZE="+2">
\r
130 <B>Constructor Summary</B></FONT></TD>
\r
132 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
133 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html#VoiceList()">VoiceList</A></B>()</CODE>
\r
136 Class constructor.</TD>
\r
138 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
139 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html#VoiceList(javax.speech.synthesis.SynthesizerModeDesc)">VoiceList</A></B>(javax.speech.synthesis.SynthesizerModeDesc desc)</CODE>
\r
142 Constructs from the voice list in <code>desc</code>.
147 <!-- ========== METHOD SUMMARY =========== -->
\r
149 <A NAME="method_summary"><!-- --></A>
150 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
151 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
152 <TD COLSPAN=2><FONT SIZE="+2">
\r
153 <B>Method Summary</B></FONT></TD>
\r
155 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
157 <CODE> void</CODE></FONT></TD>
\r
158 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html#addVoice(com.sun.speech.engine.synthesis.BaseVoice)">addVoice</A></B>(<A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html" title="class in com.sun.speech.engine.synthesis">BaseVoice</A> voice)</CODE>
\r
161 Adds a voice to the list.</TD>
\r
163 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
165 <CODE> <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html" title="class in com.sun.speech.engine.synthesis">BaseVoice</A></CODE></FONT></TD>
\r
166 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html#getVoiceById(java.lang.String)">getVoiceById</A></B>(java.lang.String id)</CODE>
\r
169 Gets a voice by its identifier.</TD>
\r
171 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
172 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
173 <CODE> java.lang.String</CODE></FONT></TD>
\r
174 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html#getVoiceId(java.lang.String, int, int, int)">getVoiceId</A></B>(java.lang.String name,
177 int variant)</CODE>
\r
180 Gets id for voice based on parameters provided in JSML.
183 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
185 <CODE> java.lang.String</CODE></FONT></TD>
\r
186 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html#getVoiceId(javax.speech.synthesis.Voice, int)">getVoiceId</A></B>(javax.speech.synthesis.Voice voice,
187 int variant)</CODE>
\r
190 Gets the id of a voice.</TD>
\r
192 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
194 <CODE> void</CODE></FONT></TD>
\r
195 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html#removeVoice(com.sun.speech.engine.synthesis.BaseVoice)">removeVoice</A></B>(<A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html" title="class in com.sun.speech.engine.synthesis">BaseVoice</A> voice)</CODE>
\r
198 Removes a voice from the list.</TD>
\r
201 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
202 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
203 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
204 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
206 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
207 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
213 <!-- ============ FIELD DETAIL =========== -->
\r
215 <A NAME="field_detail"><!-- --></A>
216 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
217 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
218 <TD COLSPAN=1><FONT SIZE="+2">
\r
219 <B>Field Detail</B></FONT></TD>
\r
223 <A NAME="voiceList"><!-- --></A><H3>
\r
226 protected final java.util.List <B>voiceList</B></PRE>
\r
228 <DD>The list of <code>Voices</code>.
\r
234 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
236 <A NAME="constructor_detail"><!-- --></A>
237 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
238 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
239 <TD COLSPAN=1><FONT SIZE="+2">
\r
240 <B>Constructor Detail</B></FONT></TD>
\r
244 <A NAME="VoiceList()"><!-- --></A><H3>
\r
247 public <B>VoiceList</B>()</PRE>
\r
249 <DD>Class constructor.
\r
254 <A NAME="VoiceList(javax.speech.synthesis.SynthesizerModeDesc)"><!-- --></A><H3>
\r
257 public <B>VoiceList</B>(javax.speech.synthesis.SynthesizerModeDesc desc)</PRE>
\r
259 <DD>Constructs from the voice list in <code>desc</code>.
260 Requires that all voices in mode desc be instances of
261 <code>BaseVoice</code>.
\r
263 <DT><B>Parameters:</B><DD><CODE>desc</CODE> - the <code>SynthesizerModeDesc</code> to get voices from</DL>
\r
265 <!-- ============ METHOD DETAIL ========== -->
\r
267 <A NAME="method_detail"><!-- --></A>
268 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
269 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
270 <TD COLSPAN=1><FONT SIZE="+2">
\r
271 <B>Method Detail</B></FONT></TD>
\r
275 <A NAME="addVoice(com.sun.speech.engine.synthesis.BaseVoice)"><!-- --></A><H3>
\r
278 public void <B>addVoice</B>(<A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html" title="class in com.sun.speech.engine.synthesis">BaseVoice</A> voice)</PRE>
\r
280 <DD>Adds a voice to the list.
\r
283 <DT><B>Parameters:</B><DD><CODE>voice</CODE> - the voice to add<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html#removeVoice(com.sun.speech.engine.synthesis.BaseVoice)"><CODE>removeVoice(com.sun.speech.engine.synthesis.BaseVoice)</CODE></A></DL>
\r
288 <A NAME="removeVoice(com.sun.speech.engine.synthesis.BaseVoice)"><!-- --></A><H3>
\r
291 public void <B>removeVoice</B>(<A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html" title="class in com.sun.speech.engine.synthesis">BaseVoice</A> voice)</PRE>
\r
293 <DD>Removes a voice from the list.
\r
296 <DT><B>Parameters:</B><DD><CODE>voice</CODE> - the voice to remove<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/VoiceList.html#addVoice(com.sun.speech.engine.synthesis.BaseVoice)"><CODE>addVoice(com.sun.speech.engine.synthesis.BaseVoice)</CODE></A></DL>
\r
301 <A NAME="getVoiceById(java.lang.String)"><!-- --></A><H3>
\r
304 public <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html" title="class in com.sun.speech.engine.synthesis">BaseVoice</A> <B>getVoiceById</B>(java.lang.String id)</PRE>
\r
306 <DD>Gets a voice by its identifier.
\r
309 <DT><B>Parameters:</B><DD><CODE>id</CODE> - the voice id
310 <DT><B>Returns:</B><DD>the voice if it exists; otherwise <code>null</code><DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html#getId()"><CODE>BaseVoice.getId()</CODE></A></DL>
\r
315 <A NAME="getVoiceId(javax.speech.synthesis.Voice, int)"><!-- --></A><H3>
\r
318 public java.lang.String <B>getVoiceId</B>(javax.speech.synthesis.Voice voice,
319 int variant)</PRE>
\r
321 <DD>Gets the id of a voice.
\r
324 <DT><B>Parameters:</B><DD><CODE>voice</CODE> - the voice<DD><CODE>variant</CODE> - the voice variant
325 <DT><B>Returns:</B><DD>the id of the voice</DL>
\r
330 <A NAME="getVoiceId(java.lang.String, int, int, int)"><!-- --></A><H3>
\r
333 public java.lang.String <B>getVoiceId</B>(java.lang.String name,
336 int variant)</PRE>
\r
338 <DD>Gets id for voice based on parameters provided in JSML.
339 Priority to voice name. Then try to match age and gender plus
343 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the voice name<DD><CODE>gender</CODE> - the gender<DD><CODE>age</CODE> - the age<DD><CODE>variant</CODE> - the variant
344 <DT><B>Returns:</B><DD>the voice id<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html" title="class in com.sun.speech.engine.synthesis"><CODE>BaseVoice</CODE></A>,
345 <CODE>Voice</CODE></DL>
\r
348 <!-- ========= END OF CLASS DATA ========= -->
\r
352 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
353 <A NAME="navbar_bottom"><!-- --></A>
354 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
355 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
357 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
358 <A NAME="navbar_bottom_firstrow"><!-- --></A>
359 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
360 <TR ALIGN="center" VALIGN="top">
\r
361 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
362 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
363 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
364 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
365 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
366 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
367 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
371 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
377 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
378 <A HREF="../../../../../com/sun/speech/engine/synthesis/SynthesizerSelector.html" title="class in com.sun.speech.engine.synthesis"><B>PREV CLASS</B></A>
\r
379 NEXT CLASS</FONT></TD>
\r
380 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
381 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
382 <A HREF="VoiceList.html" target="_top"><B>NO FRAMES</B></A>
\r
383 <SCRIPT type="text/javascript">
\r
386 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
391 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
397 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
398 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
399 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
400 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
403 <A NAME="skip-navbar_bottom"></A>
404 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
projects / debian / freetts / blob