upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / diphone / AliasDiphone.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 AliasDiphone (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.diphone.AliasDiphone 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="AliasDiphone (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;PREV CLASS&nbsp;\r
53 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone"><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="AliasDiphone.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;<A HREF="#fields_inherited_from_class_com.sun.speech.freetts.diphone.Diphone">FIELD</A>&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.diphone</FONT>\r
85 <BR>\r
86 Class AliasDiphone</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">com.sun.speech.freetts.diphone.Diphone</A>\r
90       <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.diphone.AliasDiphone</B>\r
91 </PRE>\r
92 <HR>\r
93 <DL>\r
94 <DT>public class <B>AliasDiphone</B><DT>extends <A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A></DL>\r
95 \r
96 <P>\r
97 Represent an alias diphone which is just another name for an
98  already-existing original diphone. This can be used just like a
99  "real" diphone.\r
100 <P>\r
101 \r
102 <P>\r
103 <DL>\r
104 <DT><B>Author:</B></DT>
105   <DD>Marc Schr&ouml;der</DD>
106 </DL>\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 <A NAME="field_summary"><!-- --></A>
116 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
117 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
118 <TD COLSPAN=2><FONT SIZE="+2">\r
119 <B>Field Summary</B></FONT></TD>\r
120 </TR>\r
121 </TABLE>\r
122 &nbsp;<A NAME="fields_inherited_from_class_com.sun.speech.freetts.diphone.Diphone"><!-- --></A>
123 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
124 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
125 <TD><B>Fields inherited from class com.sun.speech.freetts.diphone.<A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A></B></TD>\r
126 </TR>\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">\r
128 <TD><CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#ALIAS_MAGIC">ALIAS_MAGIC</A>, <A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#MAGIC">MAGIC</A>, <A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#NAME_LENGTH">NAME_LENGTH</A></CODE></TD>\r
129 </TR>\r
130 </TABLE>\r
131 &nbsp;\r
132 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
133 \r
134 <A NAME="constructor_summary"><!-- --></A>
135 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
136 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
137 <TD COLSPAN=2><FONT SIZE="+2">\r
138 <B>Constructor Summary</B></FONT></TD>\r
139 </TR>\r
140 <TR BGCOLOR="white" CLASS="TableRowColor">\r
141 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/AliasDiphone.html#AliasDiphone(java.lang.String, java.lang.String)">AliasDiphone</A></B>(java.lang.String&nbsp;name,
142              java.lang.String&nbsp;originalName)</CODE>\r
143 \r
144 <BR>\r
145 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
146 </TR>\r
147 </TABLE>\r
148 &nbsp;\r
149 <!-- ========== METHOD SUMMARY =========== -->\r
150 \r
151 <A NAME="method_summary"><!-- --></A>
152 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
153 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
154 <TD COLSPAN=2><FONT SIZE="+2">\r
155 <B>Method Summary</B></FONT></TD>\r
156 </TR>\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">\r
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
159 <CODE>&nbsp;void</CODE></FONT></TD>\r
160 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/AliasDiphone.html#dump()">dump</A></B>()</CODE>\r
161 \r
162 <BR>\r
163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;dumps out this Diphone.</TD>\r
164 </TR>\r
165 <TR BGCOLOR="white" CLASS="TableRowColor">\r
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
167 <CODE>&nbsp;void</CODE></FONT></TD>\r
168 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/AliasDiphone.html#dumpBinary(java.nio.ByteBuffer)">dumpBinary</A></B>(java.nio.ByteBuffer&nbsp;bb)</CODE>\r
169 \r
170 <BR>\r
171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dumps the diphone to the given channel.</TD>\r
172 </TR>\r
173 <TR BGCOLOR="white" CLASS="TableRowColor">\r
174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
175 <CODE>&nbsp;void</CODE></FONT></TD>\r
176 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/AliasDiphone.html#dumpBinary(java.io.DataOutputStream)">dumpBinary</A></B>(java.io.DataOutputStream&nbsp;os)</CODE>\r
177 \r
178 <BR>\r
179 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dumps the diphone to the given channel.</TD>\r
180 </TR>\r
181 <TR BGCOLOR="white" CLASS="TableRowColor">\r
182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
183 <CODE>&nbsp;int</CODE></FONT></TD>\r
184 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/AliasDiphone.html#getMidPoint()">getMidPoint</A></B>()</CODE>\r
185 \r
186 <BR>\r
187 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the midpoint index. the midpoint index is the sample
188  that divides the diphone into the first and second parts.</TD>\r
189 </TR>\r
190 <TR BGCOLOR="white" CLASS="TableRowColor">\r
191 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
192 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
193 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/AliasDiphone.html#getOriginalName()">getOriginalName</A></B>()</CODE>\r
194 \r
195 <BR>\r
196 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name of the original name that this alias points to.</TD>\r
197 </TR>\r
198 <TR BGCOLOR="white" CLASS="TableRowColor">\r
199 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
200 <CODE>&nbsp;int</CODE></FONT></TD>\r
201 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/AliasDiphone.html#getPbPositionMillis()">getPbPositionMillis</A></B>()</CODE>\r
202 \r
203 <BR>\r
204 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the midpoint index. the midpoint index is the sample
205  that divides the diphone into the first and second parts.</TD>\r
206 </TR>\r
207 <TR BGCOLOR="white" CLASS="TableRowColor">\r
208 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
209 <CODE>&nbsp;<A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A>[]</CODE></FONT></TD>\r
210 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/AliasDiphone.html#getSamples()">getSamples</A></B>()</CODE>\r
211 \r
212 <BR>\r
213 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the samples associated with this diphone.</TD>\r
214 </TR>\r
215 <TR BGCOLOR="white" CLASS="TableRowColor">\r
216 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
217 <CODE>&nbsp;<A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A></CODE></FONT></TD>\r
218 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/AliasDiphone.html#getSamples(int)">getSamples</A></B>(int&nbsp;which)</CODE>\r
219 \r
220 <BR>\r
221 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a particular sample.</TD>\r
222 </TR>\r
223 <TR BGCOLOR="white" CLASS="TableRowColor">\r
224 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
225 <CODE>&nbsp;int</CODE></FONT></TD>\r
226 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/AliasDiphone.html#getUnitSize(int)">getUnitSize</A></B>(int&nbsp;unitPart)</CODE>\r
227 \r
228 <BR>\r
229 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total number of residuals in the given part for this
230  diphone.</TD>\r
231 </TR>\r
232 <TR BGCOLOR="white" CLASS="TableRowColor">\r
233 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
234 <CODE>&nbsp;<A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A></CODE></FONT></TD>\r
235 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/AliasDiphone.html#nearestSample(float, int)">nearestSample</A></B>(float&nbsp;uIndex,
236               int&nbsp;unitPart)</CODE>\r
237 \r
238 <BR>\r
239 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the sample that is closest to uIndex.</TD>\r
240 </TR>\r
241 <TR BGCOLOR="white" CLASS="TableRowColor">\r
242 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
243 <CODE>&nbsp;void</CODE></FONT></TD>\r
244 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/diphone/AliasDiphone.html#setOriginalDiphone(com.sun.speech.freetts.diphone.Diphone)">setOriginalDiphone</A></B>(<A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A>&nbsp;original)</CODE>\r
245 \r
246 <BR>\r
247 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Associate the actual diphone object of the original with this alias.</TD>\r
248 </TR>\r
249 </TABLE>\r
250 &nbsp;<A NAME="methods_inherited_from_class_com.sun.speech.freetts.diphone.Diphone"><!-- --></A>
251 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
252 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
253 <TD><B>Methods inherited from class com.sun.speech.freetts.diphone.<A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A></B></TD>\r
254 </TR>\r
255 <TR BGCOLOR="white" CLASS="TableRowColor">\r
256 <TD><CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#getName()">getName</A>, <A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#loadBinary(java.nio.ByteBuffer)">loadBinary</A>, <A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#loadBinary(java.io.DataInputStream)">loadBinary</A></CODE></TD>\r
257 </TR>\r
258 </TABLE>\r
259 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
260 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
261 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
262 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
263 </TR>\r
264 <TR BGCOLOR="white" CLASS="TableRowColor">\r
265 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
266 </TR>\r
267 </TABLE>\r
268 &nbsp;\r
269 <P>\r
270 \r
271 <!-- ============ FIELD DETAIL =========== -->\r
272 \r
273 \r
274 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
275 \r
276 <A NAME="constructor_detail"><!-- --></A>
277 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
278 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
279 <TD COLSPAN=1><FONT SIZE="+2">\r
280 <B>Constructor Detail</B></FONT></TD>\r
281 </TR>\r
282 </TABLE>\r
283 \r
284 <A NAME="AliasDiphone(java.lang.String, java.lang.String)"><!-- --></A><H3>\r
285 AliasDiphone</H3>\r
286 <PRE>\r
287 public <B>AliasDiphone</B>(java.lang.String&nbsp;name,
288                     java.lang.String&nbsp;originalName)</PRE>\r
289 <DL>\r
290 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The alias name to use for the existing diphone<DD><CODE>originalName</CODE> - the original name of the diphone.</DL>\r
291 \r
292 <!-- ============ METHOD DETAIL ========== -->\r
293 \r
294 <A NAME="method_detail"><!-- --></A>
295 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
296 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
297 <TD COLSPAN=1><FONT SIZE="+2">\r
298 <B>Method Detail</B></FONT></TD>\r
299 </TR>\r
300 </TABLE>\r
301 \r
302 <A NAME="getOriginalName()"><!-- --></A><H3>\r
303 getOriginalName</H3>\r
304 <PRE>\r
305 public java.lang.String <B>getOriginalName</B>()</PRE>\r
306 <DL>\r
307 <DD>Get the name of the original name that this alias points to.\r
308 <P>\r
309 <DD><DL>\r
310 </DL>\r
311 </DD>\r
312 </DL>\r
313 <HR>\r
314 \r
315 <A NAME="setOriginalDiphone(com.sun.speech.freetts.diphone.Diphone)"><!-- --></A><H3>\r
316 setOriginalDiphone</H3>\r
317 <PRE>\r
318 public void <B>setOriginalDiphone</B>(<A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A>&nbsp;original)</PRE>\r
319 <DL>\r
320 <DD>Associate the actual diphone object of the original with this alias.\r
321 <P>\r
322 <DD><DL>\r
323 <DT><B>Parameters:</B><DD><CODE>original</CODE> - a diphone object whose getName() must return the same
324  as our getOriginalName().
325 <DT><B>Throws:</B>
326 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if the diphone to be registered as the
327  original has a name which is different from this AliasDiphone's original name
328  as returned by getOriginalName().</DL>\r
329 </DD>\r
330 </DL>\r
331 <HR>\r
332 \r
333 <A NAME="getSamples()"><!-- --></A><H3>\r
334 getSamples</H3>\r
335 <PRE>\r
336 public <A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A>[] <B>getSamples</B>()</PRE>\r
337 <DL>\r
338 <DD>Returns the samples associated with this diphone.\r
339 <P>\r
340 <DD><DL>\r
341 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#getSamples()">getSamples</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A></CODE></DL>\r
342 </DD>\r
343 <DD><DL>\r
344
345 <DT><B>Returns:</B><DD>the samples associated with this diphone</DL>\r
346 </DD>\r
347 </DL>\r
348 <HR>\r
349 \r
350 <A NAME="getSamples(int)"><!-- --></A><H3>\r
351 getSamples</H3>\r
352 <PRE>\r
353 public <A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A> <B>getSamples</B>(int&nbsp;which)</PRE>\r
354 <DL>\r
355 <DD>Returns a particular sample.\r
356 <P>\r
357 <DD><DL>\r
358 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#getSamples(int)">getSamples</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A></CODE></DL>\r
359 </DD>\r
360 <DD><DL>\r
361 <DT><B>Parameters:</B><DD><CODE>which</CODE> - which sample to return
362 <DT><B>Returns:</B><DD>the desired sample</DL>\r
363 </DD>\r
364 </DL>\r
365 <HR>\r
366 \r
367 <A NAME="getMidPoint()"><!-- --></A><H3>\r
368 getMidPoint</H3>\r
369 <PRE>\r
370 public int <B>getMidPoint</B>()</PRE>\r
371 <DL>\r
372 <DD>Returns the midpoint index. the midpoint index is the sample
373  that divides the diphone into the first and second parts.\r
374 <P>\r
375 <DD><DL>\r
376 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#getMidPoint()">getMidPoint</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A></CODE></DL>\r
377 </DD>\r
378 <DD><DL>\r
379
380 <DT><B>Returns:</B><DD>the midpoint index.</DL>\r
381 </DD>\r
382 </DL>\r
383 <HR>\r
384 \r
385 <A NAME="getPbPositionMillis()"><!-- --></A><H3>\r
386 getPbPositionMillis</H3>\r
387 <PRE>\r
388 public int <B>getPbPositionMillis</B>()</PRE>\r
389 <DL>\r
390 <DD>Returns the midpoint index. the midpoint index is the sample
391  that divides the diphone into the first and second parts.\r
392 <P>\r
393 <DD><DL>\r
394 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#getPbPositionMillis()">getPbPositionMillis</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A></CODE></DL>\r
395 </DD>\r
396 <DD><DL>\r
397
398 <DT><B>Returns:</B><DD>the midpoint index.</DL>\r
399 </DD>\r
400 </DL>\r
401 <HR>\r
402 \r
403 <A NAME="nearestSample(float, int)"><!-- --></A><H3>\r
404 nearestSample</H3>\r
405 <PRE>\r
406 public <A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A> <B>nearestSample</B>(float&nbsp;uIndex,
407                             int&nbsp;unitPart)</PRE>\r
408 <DL>\r
409 <DD>Returns the sample that is closest to uIndex.\r
410 <P>\r
411 <DD><DL>\r
412 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#nearestSample(float, int)">nearestSample</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A></CODE></DL>\r
413 </DD>\r
414 <DD><DL>\r
415 <DT><B>Parameters:</B><DD><CODE>uIndex</CODE> - the desired index<DD><CODE>unitPart</CODE> - do we want the first have (1) or the second
416       half (2)
417 <DT><B>Returns:</B><DD>the sample nearest to the given index in the given
418       part</DL>\r
419 </DD>\r
420 </DL>\r
421 <HR>\r
422 \r
423 <A NAME="getUnitSize(int)"><!-- --></A><H3>\r
424 getUnitSize</H3>\r
425 <PRE>\r
426 public int <B>getUnitSize</B>(int&nbsp;unitPart)</PRE>\r
427 <DL>\r
428 <DD>Returns the total number of residuals in the given part for this
429  diphone.\r
430 <P>\r
431 <DD><DL>\r
432 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#getUnitSize(int)">getUnitSize</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A></CODE></DL>\r
433 </DD>\r
434 <DD><DL>\r
435 <DT><B>Parameters:</B><DD><CODE>unitPart</CODE> - indicates which part is of interest (1 or 2)
436 <DT><B>Returns:</B><DD>the number of residuals in the specified part</DL>\r
437 </DD>\r
438 </DL>\r
439 <HR>\r
440 \r
441 <A NAME="dump()"><!-- --></A><H3>\r
442 dump</H3>\r
443 <PRE>\r
444 public void <B>dump</B>()</PRE>\r
445 <DL>\r
446 <DD>dumps out this Diphone.\r
447 <P>\r
448 <DD><DL>\r
449 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#dump()">dump</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A></CODE></DL>\r
450 </DD>\r
451 <DD><DL>\r
452 </DL>\r
453 </DD>\r
454 </DL>\r
455 <HR>\r
456 \r
457 <A NAME="dumpBinary(java.nio.ByteBuffer)"><!-- --></A><H3>\r
458 dumpBinary</H3>\r
459 <PRE>\r
460 public void <B>dumpBinary</B>(java.nio.ByteBuffer&nbsp;bb)
461                 throws java.io.IOException</PRE>\r
462 <DL>\r
463 <DD>Dumps the diphone to the given channel.\r
464 <P>\r
465 <DD><DL>\r
466 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#dumpBinary(java.nio.ByteBuffer)">dumpBinary</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A></CODE></DL>\r
467 </DD>\r
468 <DD><DL>\r
469 <DT><B>Parameters:</B><DD><CODE>bb</CODE> - the ByteBuffer to write to
470 <DT><B>Throws:</B>
471 <DD><CODE>java.io.IOException</CODE> - if IO error occurs</DL>\r
472 </DD>\r
473 </DL>\r
474 <HR>\r
475 \r
476 <A NAME="dumpBinary(java.io.DataOutputStream)"><!-- --></A><H3>\r
477 dumpBinary</H3>\r
478 <PRE>\r
479 public void <B>dumpBinary</B>(java.io.DataOutputStream&nbsp;os)
480                 throws java.io.IOException</PRE>\r
481 <DL>\r
482 <DD>Dumps the diphone to the given channel.\r
483 <P>\r
484 <DD><DL>\r
485 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html#dumpBinary(java.io.DataOutputStream)">dumpBinary</A></CODE> in class <CODE><A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone">Diphone</A></CODE></DL>\r
486 </DD>\r
487 <DD><DL>\r
488 <DT><B>Parameters:</B><DD><CODE>os</CODE> - the DataOutputStream to write to
489 <DT><B>Throws:</B>
490 <DD><CODE>java.io.IOException</CODE> - if IO error occurs</DL>\r
491 </DD>\r
492 </DL>\r
493 <!-- ========= END OF CLASS DATA ========= -->\r
494 <HR>\r
495 \r
496
497 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
498 <A NAME="navbar_bottom"><!-- --></A>
499 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
500 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
501 <TR>\r
502 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
503 <A NAME="navbar_bottom_firstrow"><!-- --></A>
504 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
505   <TR ALIGN="center" VALIGN="top">\r
506   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
507   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
508   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
509   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
510   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
511   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
512   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
513   </TR>\r
514 </TABLE>\r
515 </TD>\r
516 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
517 </EM>\r
518 </TD>\r
519 </TR>\r
520 \r
521 <TR>\r
522 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
523 &nbsp;PREV CLASS&nbsp;\r
524 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/diphone/Diphone.html" title="class in com.sun.speech.freetts.diphone"><B>NEXT CLASS</B></A></FONT></TD>\r
525 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
526   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
527 &nbsp;<A HREF="AliasDiphone.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
528 &nbsp;<SCRIPT type="text/javascript">\r
529   <!--\r
530   if(window==top) {\r
531     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
532   }\r
533   //-->\r
534 </SCRIPT>\r
535 <NOSCRIPT>\r
536   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
537 </NOSCRIPT>
538 \r
539 </FONT></TD>\r
540 </TR>\r
541 <TR>\r
542 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
543   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_com.sun.speech.freetts.diphone.Diphone">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
544 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
545 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
546 </TR>\r
547 </TABLE>\r
548 <A NAME="skip-navbar_bottom"></A>
549 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
550 \r
551 <HR>\r
552 \r
553 </BODY>\r
554 </HTML>\r