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 RawFileAudioPlayer (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.audio.RawFileAudioPlayer 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="RawFileAudioPlayer (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/freetts/audio/NullAudioPlayer.html" title="class in com.sun.speech.freetts.audio"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../../com/sun/speech/freetts/audio/SingleFileAudioPlayer.html" title="class in com.sun.speech.freetts.audio"><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>
\r
56 <A HREF="RawFileAudioPlayer.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 | FIELD | <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: FIELD | <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.freetts.audio</FONT>
\r
86 Class RawFileAudioPlayer</H2>
\r
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.audio.RawFileAudioPlayer</B>
\r
92 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></DD>
\r
96 <DT>public class <B>RawFileAudioPlayer</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></DL>
\r
99 Provides an implementation of <code>AudioPlayer</code> that sends
100 all audio data to the given file.
\r
107 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
110 <!-- =========== FIELD SUMMARY =========== -->
\r
113 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
115 <A NAME="constructor_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>Constructor Summary</B></FONT></TD>
\r
121 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
122 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#RawFileAudioPlayer()">RawFileAudioPlayer</A></B>()</CODE>
\r
125 Creates a default audio player for an AudioFileFormat of type
128 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
129 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#RawFileAudioPlayer(java.lang.String)">RawFileAudioPlayer</A></B>(java.lang.String path)</CODE>
\r
132 Constructs a NullAudioPlayer</TD>
\r
136 <!-- ========== METHOD SUMMARY =========== -->
\r
138 <A NAME="method_summary"><!-- --></A>
139 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
140 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
141 <TD COLSPAN=2><FONT SIZE="+2">
\r
142 <B>Method Summary</B></FONT></TD>
\r
144 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
145 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
146 <CODE> void</CODE></FONT></TD>
\r
147 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#begin(int)">begin</A></B>(int size)</CODE>
\r
150 Starts the output of a set of data</TD>
\r
152 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
154 <CODE> void</CODE></FONT></TD>
\r
155 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#cancel()">cancel</A></B>()</CODE>
\r
158 Cancels all queued output. </TD>
\r
160 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
162 <CODE> void</CODE></FONT></TD>
\r
163 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#close()">close</A></B>()</CODE>
\r
166 Waits for all audio playback to stop, and closes this AudioPlayer.</TD>
\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
170 <CODE> boolean</CODE></FONT></TD>
\r
171 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#drain()">drain</A></B>()</CODE>
\r
174 Waits for all queued audio to be played</TD>
\r
176 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
178 <CODE> boolean</CODE></FONT></TD>
\r
179 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#end()">end</A></B>()</CODE>
\r
182 Marks the end of a set of data</TD>
\r
184 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
186 <CODE> javax.sound.sampled.AudioFormat</CODE></FONT></TD>
\r
187 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#getAudioFormat()">getAudioFormat</A></B>()</CODE>
\r
190 Retrieves the audio format for this player</TD>
\r
192 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
194 <CODE> long</CODE></FONT></TD>
\r
195 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#getTime()">getTime</A></B>()</CODE>
\r
198 Gets the amount of played since the last resetTime
199 Currently not supported.</TD>
\r
201 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
202 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
203 <CODE> float</CODE></FONT></TD>
\r
204 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#getVolume()">getVolume</A></B>()</CODE>
\r
207 Returns the current volume.</TD>
\r
209 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
210 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
211 <CODE> void</CODE></FONT></TD>
\r
212 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#pause()">pause</A></B>()</CODE>
\r
215 Pauses the audio output</TD>
\r
217 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
218 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
219 <CODE> void</CODE></FONT></TD>
\r
220 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#reset()">reset</A></B>()</CODE>
\r
223 Prepares for another batch of output. </TD>
\r
225 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
226 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
227 <CODE> void</CODE></FONT></TD>
\r
228 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#resetTime()">resetTime</A></B>()</CODE>
\r
231 Resets the audio clock</TD>
\r
233 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
234 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
235 <CODE> void</CODE></FONT></TD>
\r
236 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#resume()">resume</A></B>()</CODE>
\r
239 Resumes audio output</TD>
\r
241 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
242 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
243 <CODE> void</CODE></FONT></TD>
\r
244 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#setAudioFormat(javax.sound.sampled.AudioFormat)">setAudioFormat</A></B>(javax.sound.sampled.AudioFormat format)</CODE>
\r
247 Sets the audio format for this player</TD>
\r
249 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
250 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
251 <CODE> void</CODE></FONT></TD>
\r
252 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#setVolume(float)">setVolume</A></B>(float volume)</CODE>
\r
255 Sets the current volume.</TD>
\r
257 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
258 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
259 <CODE> void</CODE></FONT></TD>
\r
260 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#showMetrics()">showMetrics</A></B>()</CODE>
\r
263 Shows metrics for this audio player</TD>
\r
265 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
266 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
267 <CODE> void</CODE></FONT></TD>
\r
268 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#startFirstSampleTimer()">startFirstSampleTimer</A></B>()</CODE>
\r
271 Starts the first sample timer</TD>
\r
273 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
274 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
275 <CODE> boolean</CODE></FONT></TD>
\r
276 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#write(byte[])">write</A></B>(byte[] audioData)</CODE>
\r
279 Writes the given bytes to the audio stream</TD>
\r
281 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
282 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
283 <CODE> boolean</CODE></FONT></TD>
\r
284 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html#write(byte[], int, int)">write</A></B>(byte[] bytes,
286 int size)</CODE>
\r
289 Writes the given bytes to the audio stream</TD>
\r
292 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
293 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
294 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
295 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
297 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
298 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
304 <!-- ============ FIELD DETAIL =========== -->
\r
307 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
309 <A NAME="constructor_detail"><!-- --></A>
310 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
311 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
312 <TD COLSPAN=1><FONT SIZE="+2">
\r
313 <B>Constructor Detail</B></FONT></TD>
\r
317 <A NAME="RawFileAudioPlayer()"><!-- --></A><H3>
\r
318 RawFileAudioPlayer</H3>
\r
320 public <B>RawFileAudioPlayer</B>()
321 throws java.io.IOException</PRE>
\r
323 <DD>Creates a default audio player for an AudioFileFormat of type
324 WAVE. Reads the "com.sun.speech.freetts.AudioPlayer.baseName"
325 property for the base filename to use, and will produce files
326 of the form <baseName>.raw. The default value for the
327 base name is "freetts".
\r
332 <A NAME="RawFileAudioPlayer(java.lang.String)"><!-- --></A><H3>
\r
333 RawFileAudioPlayer</H3>
\r
335 public <B>RawFileAudioPlayer</B>(java.lang.String path)
336 throws java.io.IOException</PRE>
\r
338 <DD>Constructs a NullAudioPlayer
\r
342 <!-- ============ METHOD DETAIL ========== -->
\r
344 <A NAME="method_detail"><!-- --></A>
345 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
346 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
347 <TD COLSPAN=1><FONT SIZE="+2">
\r
348 <B>Method Detail</B></FONT></TD>
\r
352 <A NAME="setAudioFormat(javax.sound.sampled.AudioFormat)"><!-- --></A><H3>
\r
353 setAudioFormat</H3>
\r
355 public void <B>setAudioFormat</B>(javax.sound.sampled.AudioFormat format)</PRE>
\r
357 <DD>Sets the audio format for this player
\r
360 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#setAudioFormat(javax.sound.sampled.AudioFormat)">setAudioFormat</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
363 <DT><B>Parameters:</B><DD><CODE>format</CODE> - the audio format</DL>
\r
368 <A NAME="getAudioFormat()"><!-- --></A><H3>
\r
369 getAudioFormat</H3>
\r
371 public javax.sound.sampled.AudioFormat <B>getAudioFormat</B>()</PRE>
\r
373 <DD>Retrieves the audio format for this player
\r
376 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#getAudioFormat()">getAudioFormat</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
380 <DT><B>Returns:</B><DD>the current audio format.</DL>
\r
385 <A NAME="cancel()"><!-- --></A><H3>
\r
388 public void <B>cancel</B>()</PRE>
\r
390 <DD>Cancels all queued output. Current 'write' call will return
394 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#cancel()">cancel</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
402 <A NAME="pause()"><!-- --></A><H3>
\r
405 public void <B>pause</B>()</PRE>
\r
407 <DD>Pauses the audio output
\r
410 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#pause()">pause</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
418 <A NAME="reset()"><!-- --></A><H3>
\r
421 public void <B>reset</B>()</PRE>
\r
423 <DD>Prepares for another batch of output. Larger groups of output
424 (such as all output associated with a single FreeTTSSpeakable)
425 should be grouped between a reset/drain pair.
\r
428 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
436 <A NAME="resume()"><!-- --></A><H3>
\r
439 public void <B>resume</B>()</PRE>
\r
441 <DD>Resumes audio output
\r
444 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#resume()">resume</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
452 <A NAME="close()"><!-- --></A><H3>
\r
455 public void <B>close</B>()</PRE>
\r
457 <DD>Waits for all audio playback to stop, and closes this AudioPlayer.
\r
460 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
468 <A NAME="getVolume()"><!-- --></A><H3>
\r
471 public float <B>getVolume</B>()</PRE>
\r
473 <DD>Returns the current volume.
\r
476 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#getVolume()">getVolume</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
480 <DT><B>Returns:</B><DD>the current volume (between 0 and 1)</DL>
\r
485 <A NAME="setVolume(float)"><!-- --></A><H3>
\r
488 public void <B>setVolume</B>(float volume)</PRE>
\r
490 <DD>Sets the current volume.
\r
493 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#setVolume(float)">setVolume</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
496 <DT><B>Parameters:</B><DD><CODE>volume</CODE> - the current volume (between 0 and 1)</DL>
\r
501 <A NAME="write(byte[])"><!-- --></A><H3>
\r
504 public boolean <B>write</B>(byte[] audioData)</PRE>
\r
506 <DD>Writes the given bytes to the audio stream
\r
509 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#write(byte[])">write</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
512 <DT><B>Parameters:</B><DD><CODE>audioData</CODE> - array of audio data
513 <DT><B>Returns:</B><DD><code>true</code> of the write completed successfully,
514 <code> false </code>if the write was cancelled.</DL>
\r
519 <A NAME="begin(int)"><!-- --></A><H3>
\r
522 public void <B>begin</B>(int size)</PRE>
\r
524 <DD>Starts the output of a set of data
\r
527 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#begin(int)">begin</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
530 <DT><B>Parameters:</B><DD><CODE>size</CODE> - the size of data between now and the end</DL>
\r
535 <A NAME="end()"><!-- --></A><H3>
\r
538 public boolean <B>end</B>()</PRE>
\r
540 <DD>Marks the end of a set of data
\r
543 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#end()">end</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
547 <DT><B>Returns:</B><DD><code>true</code> if the audio was output properly,
548 <code> false</code> if the output was canceled
549 or interrupted.</DL>
\r
554 <A NAME="write(byte[], int, int)"><!-- --></A><H3>
\r
557 public boolean <B>write</B>(byte[] bytes,
559 int size)</PRE>
\r
561 <DD>Writes the given bytes to the audio stream
\r
564 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#write(byte[], int, int)">write</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
567 <DT><B>Parameters:</B><DD><CODE>bytes</CODE> - audio data to write to the device<DD><CODE>offset</CODE> - the offset into the buffer<DD><CODE>size</CODE> - the size into the buffer
568 <DT><B>Returns:</B><DD><code>true</code> of the write completed successfully,
569 <code> false </code>if the write was cancelled.</DL>
\r
574 <A NAME="startFirstSampleTimer()"><!-- --></A><H3>
\r
575 startFirstSampleTimer</H3>
\r
577 public void <B>startFirstSampleTimer</B>()</PRE>
\r
579 <DD>Starts the first sample timer
\r
582 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#startFirstSampleTimer()">startFirstSampleTimer</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
590 <A NAME="drain()"><!-- --></A><H3>
\r
593 public boolean <B>drain</B>()</PRE>
\r
595 <DD>Waits for all queued audio to be played
\r
598 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#drain()">drain</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
602 <DT><B>Returns:</B><DD><code>true</code> if the audio played to completion,
603 <code> false </code>if the audio was stopped</DL>
\r
608 <A NAME="getTime()"><!-- --></A><H3>
\r
611 public long <B>getTime</B>()</PRE>
\r
613 <DD>Gets the amount of played since the last resetTime
614 Currently not supported.
\r
617 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#getTime()">getTime</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
621 <DT><B>Returns:</B><DD>the amount of audio in milliseconds</DL>
\r
626 <A NAME="resetTime()"><!-- --></A><H3>
\r
629 public void <B>resetTime</B>()</PRE>
\r
631 <DD>Resets the audio clock
\r
634 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#resetTime()">resetTime</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
642 <A NAME="showMetrics()"><!-- --></A><H3>
\r
645 public void <B>showMetrics</B>()</PRE>
\r
647 <DD>Shows metrics for this audio player
\r
650 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html#showMetrics()">showMetrics</A></CODE> in interface <CODE><A HREF="../../../../../com/sun/speech/freetts/audio/AudioPlayer.html" title="interface in com.sun.speech.freetts.audio">AudioPlayer</A></CODE></DL>
\r
656 <!-- ========= END OF CLASS DATA ========= -->
\r
660 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
661 <A NAME="navbar_bottom"><!-- --></A>
662 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
663 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
665 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
666 <A NAME="navbar_bottom_firstrow"><!-- --></A>
667 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
668 <TR ALIGN="center" VALIGN="top">
\r
669 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
670 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
671 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
672 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
673 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
674 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
675 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
679 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
685 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
686 <A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html" title="class in com.sun.speech.freetts.audio"><B>PREV CLASS</B></A>
\r
687 <A HREF="../../../../../com/sun/speech/freetts/audio/SingleFileAudioPlayer.html" title="class in com.sun.speech.freetts.audio"><B>NEXT CLASS</B></A></FONT></TD>
\r
688 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
689 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
690 <A HREF="RawFileAudioPlayer.html" target="_top"><B>NO FRAMES</B></A>
\r
691 <SCRIPT type="text/javascript">
\r
694 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
699 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
705 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
706 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
707 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
708 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
711 <A NAME="skip-navbar_bottom"></A>
712 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
projects / debian / freetts / blob