add ant stuff
[debian/freetts] / javadoc / com / sun / speech / freetts / relp / Sample.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 Sample (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.relp.Sample 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="Sample (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/relp/LPCResult.html" title="class in com.sun.speech.freetts.relp"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html" title="class in com.sun.speech.freetts.relp"><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="Sample.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.relp</FONT>\r
85 <BR>\r
86 Class Sample</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.relp.Sample</B>\r
90 </PRE>\r
91 <HR>\r
92 <DL>\r
93 <DT>public class <B>Sample</B><DT>extends java.lang.Object</DL>\r
94 \r
95 <P>\r
96 A single short term sample containing Residual Excited Linear Predictive
97  (RELP) frame and residual voice data.\r
98 <P>\r
99 \r
100 <P>\r
101 <HR>\r
102 \r
103 <P>\r
104 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
105 \r
106 \r
107 <!-- =========== FIELD SUMMARY =========== -->\r
108 \r
109 \r
110 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
111 \r
112 <A NAME="constructor_summary"><!-- --></A>
113 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
114 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
115 <TD COLSPAN=2><FONT SIZE="+2">\r
116 <B>Constructor Summary</B></FONT></TD>\r
117 </TR>\r
118 <TR BGCOLOR="white" CLASS="TableRowColor">\r
119 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#Sample(java.io.BufferedReader, int)">Sample</A></B>(java.io.BufferedReader&nbsp;reader,
120        int&nbsp;numChannels)</CODE>\r
121 \r
122 <BR>\r
123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads a sample from the input reader.</TD>\r
124 </TR>\r
125 <TR BGCOLOR="white" CLASS="TableRowColor">\r
126 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#Sample(short[], byte[])">Sample</A></B>(short[]&nbsp;frameData,
127        byte[]&nbsp;residualData)</CODE>\r
128 \r
129 <BR>\r
130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a RELP Sample from its component parts</TD>\r
131 </TR>\r
132 <TR BGCOLOR="white" CLASS="TableRowColor">\r
133 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#Sample(short[], byte[], int)">Sample</A></B>(short[]&nbsp;frameData,
134        byte[]&nbsp;residualData,
135        int&nbsp;residualSize)</CODE>\r
136 \r
137 <BR>\r
138 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a Sample from its component parts</TD>\r
139 </TR>\r
140 </TABLE>\r
141 &nbsp;\r
142 <!-- ========== METHOD SUMMARY =========== -->\r
143 \r
144 <A NAME="method_summary"><!-- --></A>
145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
146 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
147 <TD COLSPAN=2><FONT SIZE="+2">\r
148 <B>Method Summary</B></FONT></TD>\r
149 </TR>\r
150 <TR BGCOLOR="white" CLASS="TableRowColor">\r
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
152 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
153 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#compare(com.sun.speech.freetts.relp.Sample)">compare</A></B>(<A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A>&nbsp;other)</CODE>\r
154 \r
155 <BR>\r
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares two samples. </TD>\r
157 </TR>\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">\r
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
160 <CODE>&nbsp;void</CODE></FONT></TD>\r
161 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#dump()">dump</A></B>()</CODE>\r
162 \r
163 <BR>\r
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dumps the sample:</TD>\r
165 </TR>\r
166 <TR BGCOLOR="white" CLASS="TableRowColor">\r
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
168 <CODE>&nbsp;void</CODE></FONT></TD>\r
169 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#dumpBinary(java.nio.ByteBuffer)">dumpBinary</A></B>(java.nio.ByteBuffer&nbsp;bb)</CODE>\r
170 \r
171 <BR>\r
172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dumps the samples to the given ByteBuffer</TD>\r
173 </TR>\r
174 <TR BGCOLOR="white" CLASS="TableRowColor">\r
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
176 <CODE>&nbsp;void</CODE></FONT></TD>\r
177 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#dumpBinary(java.io.DataOutputStream)">dumpBinary</A></B>(java.io.DataOutputStream&nbsp;os)</CODE>\r
178 \r
179 <BR>\r
180 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dumps the samples to the given stream</TD>\r
181 </TR>\r
182 <TR BGCOLOR="white" CLASS="TableRowColor">\r
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
184 <CODE>&nbsp;short[]</CODE></FONT></TD>\r
185 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#getFrameData()">getFrameData</A></B>()</CODE>\r
186 \r
187 <BR>\r
188 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the frame data associated with this sample</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;int</CODE></FONT></TD>\r
193 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#getFrameData(int)">getFrameData</A></B>(int&nbsp;which)</CODE>\r
194 \r
195 <BR>\r
196 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the normalized frame data. </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;byte[]</CODE></FONT></TD>\r
201 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#getResidualData()">getResidualData</A></B>()</CODE>\r
202 \r
203 <BR>\r
204 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the residual data associated with this sample</TD>\r
205 </TR>\r
206 <TR BGCOLOR="white" CLASS="TableRowColor">\r
207 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
208 <CODE>&nbsp;int</CODE></FONT></TD>\r
209 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#getResidualData(int)">getResidualData</A></B>(int&nbsp;which)</CODE>\r
210 \r
211 <BR>\r
212 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the normalized residual data. </TD>\r
213 </TR>\r
214 <TR BGCOLOR="white" CLASS="TableRowColor">\r
215 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
216 <CODE>&nbsp;int</CODE></FONT></TD>\r
217 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#getResidualSize()">getResidualSize</A></B>()</CODE>\r
218 \r
219 <BR>\r
220 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of residuals in this Sample.</TD>\r
221 </TR>\r
222 <TR BGCOLOR="white" CLASS="TableRowColor">\r
223 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
224 <CODE>static&nbsp;<A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A></CODE></FONT></TD>\r
225 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#loadBinary(java.nio.ByteBuffer)">loadBinary</A></B>(java.nio.ByteBuffer&nbsp;bb)</CODE>\r
226 \r
227 <BR>\r
228 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads the samples from the byte bufer</TD>\r
229 </TR>\r
230 <TR BGCOLOR="white" CLASS="TableRowColor">\r
231 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
232 <CODE>static&nbsp;<A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A></CODE></FONT></TD>\r
233 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html#loadBinary(java.io.DataInputStream)">loadBinary</A></B>(java.io.DataInputStream&nbsp;dis)</CODE>\r
234 \r
235 <BR>\r
236 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads the samples from the given channel</TD>\r
237 </TR>\r
238 </TABLE>\r
239 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
240 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
241 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
242 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
243 </TR>\r
244 <TR BGCOLOR="white" CLASS="TableRowColor">\r
245 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
246 </TR>\r
247 </TABLE>\r
248 &nbsp;\r
249 <P>\r
250 \r
251 <!-- ============ FIELD DETAIL =========== -->\r
252 \r
253 \r
254 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
255 \r
256 <A NAME="constructor_detail"><!-- --></A>
257 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
258 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
259 <TD COLSPAN=1><FONT SIZE="+2">\r
260 <B>Constructor Detail</B></FONT></TD>\r
261 </TR>\r
262 </TABLE>\r
263 \r
264 <A NAME="Sample(short[], byte[])"><!-- --></A><H3>\r
265 Sample</H3>\r
266 <PRE>\r
267 public <B>Sample</B>(short[]&nbsp;frameData,
268               byte[]&nbsp;residualData)</PRE>\r
269 <DL>\r
270 <DD>Constructs a RELP Sample from its component parts\r
271 <P>\r
272 <DT><B>Parameters:</B><DD><CODE>frameData</CODE> - the framedata<DD><CODE>residualData</CODE> - the residual data</DL>\r
273 <HR>\r
274 \r
275 <A NAME="Sample(short[], byte[], int)"><!-- --></A><H3>\r
276 Sample</H3>\r
277 <PRE>\r
278 public <B>Sample</B>(short[]&nbsp;frameData,
279               byte[]&nbsp;residualData,
280               int&nbsp;residualSize)</PRE>\r
281 <DL>\r
282 <DD>Constructs a Sample from its component parts\r
283 <P>\r
284 <DT><B>Parameters:</B><DD><CODE>frameData</CODE> - the framedata<DD><CODE>residualData</CODE> - the residual data</DL>\r
285 <HR>\r
286 \r
287 <A NAME="Sample(java.io.BufferedReader, int)"><!-- --></A><H3>\r
288 Sample</H3>\r
289 <PRE>\r
290 public <B>Sample</B>(java.io.BufferedReader&nbsp;reader,
291               int&nbsp;numChannels)</PRE>\r
292 <DL>\r
293 <DD>Reads a sample from the input reader.\r
294 <P>\r
295 <DT><B>Parameters:</B><DD><CODE>reader</CODE> - the input reader to read the data from<DD><CODE>numChannels</CODE> - the number of channels per frame</DL>\r
296 \r
297 <!-- ============ METHOD DETAIL ========== -->\r
298 \r
299 <A NAME="method_detail"><!-- --></A>
300 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
301 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
302 <TD COLSPAN=1><FONT SIZE="+2">\r
303 <B>Method Detail</B></FONT></TD>\r
304 </TR>\r
305 </TABLE>\r
306 \r
307 <A NAME="getFrameData()"><!-- --></A><H3>\r
308 getFrameData</H3>\r
309 <PRE>\r
310 public short[] <B>getFrameData</B>()</PRE>\r
311 <DL>\r
312 <DD>Gets the frame data associated with this sample\r
313 <P>\r
314 <DD><DL>\r
315
316 <DT><B>Returns:</B><DD>the frame data associated with this sample</DL>\r
317 </DD>\r
318 </DL>\r
319 <HR>\r
320 \r
321 <A NAME="getResidualData()"><!-- --></A><H3>\r
322 getResidualData</H3>\r
323 <PRE>\r
324 public byte[] <B>getResidualData</B>()</PRE>\r
325 <DL>\r
326 <DD>Gets the residual data associated with this sample\r
327 <P>\r
328 <DD><DL>\r
329
330 <DT><B>Returns:</B><DD>the residual data associated with this sample</DL>\r
331 </DD>\r
332 </DL>\r
333 <HR>\r
334 \r
335 <A NAME="getResidualSize()"><!-- --></A><H3>\r
336 getResidualSize</H3>\r
337 <PRE>\r
338 public int <B>getResidualSize</B>()</PRE>\r
339 <DL>\r
340 <DD>Returns the number of residuals in this Sample.\r
341 <P>\r
342 <DD><DL>\r
343
344 <DT><B>Returns:</B><DD>the number of residuals in this sample</DL>\r
345 </DD>\r
346 </DL>\r
347 <HR>\r
348 \r
349 <A NAME="getResidualData(int)"><!-- --></A><H3>\r
350 getResidualData</H3>\r
351 <PRE>\r
352 public int <B>getResidualData</B>(int&nbsp;which)</PRE>\r
353 <DL>\r
354 <DD>Returns the normalized residual data. You may not want to 
355  call this function because of the overhead involved.\r
356 <P>\r
357 <DD><DL>\r
358 <DT><B>Parameters:</B><DD><CODE>which</CODE> - the index of the data of interest
359 <DT><B>Returns:</B><DD>the normalized data.</DL>\r
360 </DD>\r
361 </DL>\r
362 <HR>\r
363 \r
364 <A NAME="getFrameData(int)"><!-- --></A><H3>\r
365 getFrameData</H3>\r
366 <PRE>\r
367 public int <B>getFrameData</B>(int&nbsp;which)</PRE>\r
368 <DL>\r
369 <DD>Returns the normalized frame data. You may not want to 
370  call this function because of the overhead involved.\r
371 <P>\r
372 <DD><DL>\r
373 <DT><B>Parameters:</B><DD><CODE>which</CODE> - the index of the data of interest
374 <DT><B>Returns:</B><DD>the normalized data.</DL>\r
375 </DD>\r
376 </DL>\r
377 <HR>\r
378 \r
379 <A NAME="dump()"><!-- --></A><H3>\r
380 dump</H3>\r
381 <PRE>\r
382 public void <B>dump</B>()</PRE>\r
383 <DL>\r
384 <DD>Dumps the sample:\r
385 <P>\r
386 <DD><DL>\r
387 </DL>\r
388 </DD>\r
389 </DL>\r
390 <HR>\r
391 \r
392 <A NAME="dumpBinary(java.nio.ByteBuffer)"><!-- --></A><H3>\r
393 dumpBinary</H3>\r
394 <PRE>\r
395 public void <B>dumpBinary</B>(java.nio.ByteBuffer&nbsp;bb)
396                 throws java.io.IOException</PRE>\r
397 <DL>\r
398 <DD>Dumps the samples to the given ByteBuffer\r
399 <P>\r
400 <DD><DL>\r
401 <DT><B>Parameters:</B><DD><CODE>bb</CODE> - the ByteBuffer to write the data to.
402 <DT><B>Throws:</B>
403 <DD><CODE>java.io.IOException</CODE> - if IO error occurs</DL>\r
404 </DD>\r
405 </DL>\r
406 <HR>\r
407 \r
408 <A NAME="dumpBinary(java.io.DataOutputStream)"><!-- --></A><H3>\r
409 dumpBinary</H3>\r
410 <PRE>\r
411 public void <B>dumpBinary</B>(java.io.DataOutputStream&nbsp;os)
412                 throws java.io.IOException</PRE>\r
413 <DL>\r
414 <DD>Dumps the samples to the given stream\r
415 <P>\r
416 <DD><DL>\r
417 <DT><B>Parameters:</B><DD><CODE>os</CODE> - the DataOutputStream to write the data to.
418 <DT><B>Throws:</B>
419 <DD><CODE>java.io.IOException</CODE> - if IO error occurs</DL>\r
420 </DD>\r
421 </DL>\r
422 <HR>\r
423 \r
424 <A NAME="loadBinary(java.nio.ByteBuffer)"><!-- --></A><H3>\r
425 loadBinary</H3>\r
426 <PRE>\r
427 public static <A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A> <B>loadBinary</B>(java.nio.ByteBuffer&nbsp;bb)
428                          throws java.io.IOException</PRE>\r
429 <DL>\r
430 <DD>Loads the samples from the byte bufer\r
431 <P>\r
432 <DD><DL>\r
433 <DT><B>Parameters:</B><DD><CODE>bb</CODE> - the byte buffer to read the data from.
434 <DT><B>Throws:</B>
435 <DD><CODE>java.io.IOException</CODE> - if IO error occurs</DL>\r
436 </DD>\r
437 </DL>\r
438 <HR>\r
439 \r
440 <A NAME="loadBinary(java.io.DataInputStream)"><!-- --></A><H3>\r
441 loadBinary</H3>\r
442 <PRE>\r
443 public static <A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A> <B>loadBinary</B>(java.io.DataInputStream&nbsp;dis)
444                          throws java.io.IOException</PRE>\r
445 <DL>\r
446 <DD>Loads the samples from the given channel\r
447 <P>\r
448 <DD><DL>\r
449 <DT><B>Parameters:</B><DD><CODE>dis</CODE> - the DataInputStream to read the data from.
450 <DT><B>Throws:</B>
451 <DD><CODE>java.io.IOException</CODE> - if IO error occurs</DL>\r
452 </DD>\r
453 </DL>\r
454 <HR>\r
455 \r
456 <A NAME="compare(com.sun.speech.freetts.relp.Sample)"><!-- --></A><H3>\r
457 compare</H3>\r
458 <PRE>\r
459 public boolean <B>compare</B>(<A HREF="../../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A>&nbsp;other)</PRE>\r
460 <DL>\r
461 <DD>Compares two samples. Note that this is not the same as
462  "equals"\r
463 <P>\r
464 <DD><DL>\r
465 <DT><B>Parameters:</B><DD><CODE>other</CODE> - the other sample to compare this one to
466 <DT><B>Returns:</B><DD><code>true</code> if they compare; otherwise
467      <code>false</code></DL>\r
468 </DD>\r
469 </DL>\r
470 <!-- ========= END OF CLASS DATA ========= -->\r
471 <HR>\r
472 \r
473
474 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
475 <A NAME="navbar_bottom"><!-- --></A>
476 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
477 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
478 <TR>\r
479 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
480 <A NAME="navbar_bottom_firstrow"><!-- --></A>
481 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
482   <TR ALIGN="center" VALIGN="top">\r
483   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
484   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
485   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
486   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
487   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
488   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
489   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
490   </TR>\r
491 </TABLE>\r
492 </TD>\r
493 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
494 </EM>\r
495 </TD>\r
496 </TR>\r
497 \r
498 <TR>\r
499 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
500 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/relp/LPCResult.html" title="class in com.sun.speech.freetts.relp"><B>PREV CLASS</B></A>&nbsp;\r
501 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/relp/SampleInfo.html" title="class in com.sun.speech.freetts.relp"><B>NEXT CLASS</B></A></FONT></TD>\r
502 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
503   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
504 &nbsp;<A HREF="Sample.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
505 &nbsp;<SCRIPT type="text/javascript">\r
506   <!--\r
507   if(window==top) {\r
508     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
509   }\r
510   //-->\r
511 </SCRIPT>\r
512 <NOSCRIPT>\r
513   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
514 </NOSCRIPT>
515 \r
516 </FONT></TD>\r
517 </TR>\r
518 <TR>\r
519 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
520   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
521 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
522 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
523 </TR>\r
524 </TABLE>\r
525 <A NAME="skip-navbar_bottom"></A>
526 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
527 \r
528 <HR>\r
529 \r
530 </BODY>\r
531 </HTML>\r