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 MultiFileAudioPlayer (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.audio.MultiFileAudioPlayer 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="MultiFileAudioPlayer (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/MultiFile8BitAudioPlayer.html" title="class in com.sun.speech.freetts.audio"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.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="MultiFileAudioPlayer.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 MultiFileAudioPlayer</H2>
\r
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.audio.MultiFileAudioPlayer</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>MultiFileAudioPlayer</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 Streams audio to multiple files, one per utterance.
\r
106 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
109 <!-- =========== FIELD SUMMARY =========== -->
\r
112 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
114 <A NAME="constructor_summary"><!-- --></A>
115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
117 <TD COLSPAN=2><FONT SIZE="+2">
\r
118 <B>Constructor Summary</B></FONT></TD>
\r
120 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
121 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#MultiFileAudioPlayer()">MultiFileAudioPlayer</A></B>()</CODE>
\r
124 Creates a default audio player for an AudioFileFormat of type
127 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
128 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#MultiFileAudioPlayer(java.lang.String, javax.sound.sampled.AudioFileFormat.Type)">MultiFileAudioPlayer</A></B>(java.lang.String baseName,
129 javax.sound.sampled.AudioFileFormat.Type type)</CODE>
\r
132 Constructs a MultiFileAudioPlayer</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/MultiFileAudioPlayer.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/MultiFileAudioPlayer.html#cancel()">cancel</A></B>()</CODE>
\r
158 Cancels currently playing audio</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/MultiFileAudioPlayer.html#close()">close</A></B>()</CODE>
\r
166 Closes this audio player</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/MultiFileAudioPlayer.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/MultiFileAudioPlayer.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/MultiFileAudioPlayer.html#getAudioFormat()">getAudioFormat</A></B>()</CODE>
\r
190 Gets 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/MultiFileAudioPlayer.html#getTime()">getTime</A></B>()</CODE>
\r
198 Gets the amount of played since the last mark</TD>
\r
200 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
202 <CODE> float</CODE></FONT></TD>
\r
203 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#getVolume()">getVolume</A></B>()</CODE>
\r
206 Returns the current volume.</TD>
\r
208 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
210 <CODE> void</CODE></FONT></TD>
\r
211 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#pause()">pause</A></B>()</CODE>
\r
214 Pauses audio output</TD>
\r
216 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
217 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
218 <CODE> void</CODE></FONT></TD>
\r
219 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#reset()">reset</A></B>()</CODE>
\r
222 Prepares for another batch of output. </TD>
\r
224 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
225 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
226 <CODE> void</CODE></FONT></TD>
\r
227 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#resetTime()">resetTime</A></B>()</CODE>
\r
230 Resets the audio clock</TD>
\r
232 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
233 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
234 <CODE> void</CODE></FONT></TD>
\r
235 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#resume()">resume</A></B>()</CODE>
\r
238 Resumes audio output</TD>
\r
240 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
241 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
242 <CODE> void</CODE></FONT></TD>
\r
243 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#setAudioFormat(javax.sound.sampled.AudioFormat)">setAudioFormat</A></B>(javax.sound.sampled.AudioFormat format)</CODE>
\r
246 Sets the audio format for this player</TD>
\r
248 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
249 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
250 <CODE> void</CODE></FONT></TD>
\r
251 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#setVolume(float)">setVolume</A></B>(float volume)</CODE>
\r
254 Sets the current volume.</TD>
\r
256 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
257 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
258 <CODE> void</CODE></FONT></TD>
\r
259 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#showMetrics()">showMetrics</A></B>()</CODE>
\r
262 Shows metrics for this audio player</TD>
\r
264 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
265 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
266 <CODE> void</CODE></FONT></TD>
\r
267 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#startFirstSampleTimer()">startFirstSampleTimer</A></B>()</CODE>
\r
270 Starts the first sample timer</TD>
\r
272 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
273 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
274 <CODE> java.lang.String</CODE></FONT></TD>
\r
275 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#toString()">toString</A></B>()</CODE>
\r
278 Returns the name of this audioplayer</TD>
\r
280 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
281 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
282 <CODE> boolean</CODE></FONT></TD>
\r
283 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#write(byte[])">write</A></B>(byte[] audioData)</CODE>
\r
286 Writes the given bytes to the audio stream</TD>
\r
288 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
289 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
290 <CODE> boolean</CODE></FONT></TD>
\r
291 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html#write(byte[], int, int)">write</A></B>(byte[] bytes,
293 int size)</CODE>
\r
296 Writes the given bytes to the audio stream</TD>
\r
299 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
300 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
301 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
302 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
304 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
305 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
311 <!-- ============ FIELD DETAIL =========== -->
\r
314 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
316 <A NAME="constructor_detail"><!-- --></A>
317 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
318 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
319 <TD COLSPAN=1><FONT SIZE="+2">
\r
320 <B>Constructor Detail</B></FONT></TD>
\r
324 <A NAME="MultiFileAudioPlayer()"><!-- --></A><H3>
\r
325 MultiFileAudioPlayer</H3>
\r
327 public <B>MultiFileAudioPlayer</B>()</PRE>
\r
329 <DD>Creates a default audio player for an AudioFileFormat of type
330 WAVE. Reads the "com.sun.speech.freetts.AudioPlayer.baseName"
331 property for the base filename to use, and will produce files
332 of the form <baseName>1.wav. The default value for the
333 base name is "freetts".
\r
338 <A NAME="MultiFileAudioPlayer(java.lang.String, javax.sound.sampled.AudioFileFormat.Type)"><!-- --></A><H3>
\r
339 MultiFileAudioPlayer</H3>
\r
341 public <B>MultiFileAudioPlayer</B>(java.lang.String baseName,
342 javax.sound.sampled.AudioFileFormat.Type type)</PRE>
\r
344 <DD>Constructs a MultiFileAudioPlayer
\r
346 <DT><B>Parameters:</B><DD><CODE>baseName</CODE> - the base name of the audio file<DD><CODE>type</CODE> - the type of audio output</DL>
\r
348 <!-- ============ METHOD DETAIL ========== -->
\r
350 <A NAME="method_detail"><!-- --></A>
351 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
352 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
353 <TD COLSPAN=1><FONT SIZE="+2">
\r
354 <B>Method Detail</B></FONT></TD>
\r
358 <A NAME="setAudioFormat(javax.sound.sampled.AudioFormat)"><!-- --></A><H3>
\r
359 setAudioFormat</H3>
\r
361 public void <B>setAudioFormat</B>(javax.sound.sampled.AudioFormat format)</PRE>
\r
363 <DD>Sets the audio format for this player
\r
366 <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
369 <DT><B>Parameters:</B><DD><CODE>format</CODE> - the audio format
371 <DD><CODE>java.lang.UnsupportedOperationException</CODE> - if the line cannot be opened with
372 the given format</DL>
\r
377 <A NAME="getAudioFormat()"><!-- --></A><H3>
\r
378 getAudioFormat</H3>
\r
380 public javax.sound.sampled.AudioFormat <B>getAudioFormat</B>()</PRE>
\r
382 <DD>Gets the audio format for this player
\r
385 <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
389 <DT><B>Returns:</B><DD>format the audio format</DL>
\r
394 <A NAME="pause()"><!-- --></A><H3>
\r
397 public void <B>pause</B>()</PRE>
\r
399 <DD>Pauses audio output
\r
402 <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
410 <A NAME="resume()"><!-- --></A><H3>
\r
413 public void <B>resume</B>()</PRE>
\r
415 <DD>Resumes audio output
\r
418 <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
426 <A NAME="startFirstSampleTimer()"><!-- --></A><H3>
\r
427 startFirstSampleTimer</H3>
\r
429 public void <B>startFirstSampleTimer</B>()</PRE>
\r
431 <DD>Starts the first sample timer
\r
434 <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
442 <A NAME="cancel()"><!-- --></A><H3>
\r
445 public void <B>cancel</B>()</PRE>
\r
447 <DD>Cancels currently playing audio
\r
450 <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
458 <A NAME="reset()"><!-- --></A><H3>
\r
461 public void <B>reset</B>()</PRE>
\r
463 <DD>Prepares for another batch of output. Larger groups of output
464 (such as all output associated with a single FreeTTSSpeakable)
465 should be grouped between a reset/drain pair.
\r
468 <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
476 <A NAME="close()"><!-- --></A><H3>
\r
479 public void <B>close</B>()</PRE>
\r
481 <DD>Closes this audio player
\r
484 <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
492 <A NAME="getVolume()"><!-- --></A><H3>
\r
495 public float <B>getVolume</B>()</PRE>
\r
497 <DD>Returns the current volume.
\r
500 <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
504 <DT><B>Returns:</B><DD>the current volume (between 0 and 1)</DL>
\r
509 <A NAME="setVolume(float)"><!-- --></A><H3>
\r
512 public void <B>setVolume</B>(float volume)</PRE>
\r
514 <DD>Sets the current volume.
\r
517 <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
520 <DT><B>Parameters:</B><DD><CODE>volume</CODE> - the current volume (between 0 and 1)</DL>
\r
525 <A NAME="begin(int)"><!-- --></A><H3>
\r
528 public void <B>begin</B>(int size)</PRE>
\r
530 <DD>Starts the output of a set of data. Audio data for a single
531 utterance should be grouped between begin/end pairs.
\r
534 <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
537 <DT><B>Parameters:</B><DD><CODE>size</CODE> - the size of data between now and the end</DL>
\r
542 <A NAME="end()"><!-- --></A><H3>
\r
545 public boolean <B>end</B>()</PRE>
\r
547 <DD>Marks the end of a set of data. Audio data for a single
548 utterance should be groupd between begin/end pairs.
\r
551 <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
555 <DT><B>Returns:</B><DD>true if the audio was output properly, false if the
556 output was cancelled or interrupted.</DL>
\r
561 <A NAME="drain()"><!-- --></A><H3>
\r
564 public boolean <B>drain</B>()</PRE>
\r
566 <DD>Waits for all queued audio to be played
\r
569 <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
573 <DT><B>Returns:</B><DD>true if the audio played to completion, false if
574 the audio was stopped</DL>
\r
579 <A NAME="getTime()"><!-- --></A><H3>
\r
582 public long <B>getTime</B>()</PRE>
\r
584 <DD>Gets the amount of played since the last mark
\r
587 <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
591 <DT><B>Returns:</B><DD>the amount of audio in milliseconds</DL>
\r
596 <A NAME="resetTime()"><!-- --></A><H3>
\r
599 public void <B>resetTime</B>()</PRE>
\r
601 <DD>Resets the audio clock
\r
604 <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
612 <A NAME="write(byte[])"><!-- --></A><H3>
\r
615 public boolean <B>write</B>(byte[] audioData)</PRE>
\r
617 <DD>Writes the given bytes to the audio stream
\r
620 <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
623 <DT><B>Parameters:</B><DD><CODE>audioData</CODE> - audio data to write to the device
624 <DT><B>Returns:</B><DD><code>true</code> of the write completed successfully,
625 <code> false </code>if the write was cancelled.</DL>
\r
630 <A NAME="write(byte[], int, int)"><!-- --></A><H3>
\r
633 public boolean <B>write</B>(byte[] bytes,
635 int size)</PRE>
\r
637 <DD>Writes the given bytes to the audio stream
\r
640 <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
643 <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
644 <DT><B>Returns:</B><DD><code>true</code> of the write completed successfully,
645 <code> false </code>if the write was cancelled.</DL>
\r
650 <A NAME="toString()"><!-- --></A><H3>
\r
653 public java.lang.String <B>toString</B>()</PRE>
\r
655 <DD>Returns the name of this audioplayer
\r
662 <DT><B>Returns:</B><DD>the name of the audio player</DL>
\r
667 <A NAME="showMetrics()"><!-- --></A><H3>
\r
670 public void <B>showMetrics</B>()</PRE>
\r
672 <DD>Shows metrics for this audio player
\r
675 <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
681 <!-- ========= END OF CLASS DATA ========= -->
\r
685 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
686 <A NAME="navbar_bottom"><!-- --></A>
687 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
688 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
690 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
691 <A NAME="navbar_bottom_firstrow"><!-- --></A>
692 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
693 <TR ALIGN="center" VALIGN="top">
\r
694 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
695 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
696 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
697 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
698 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
699 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
700 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
704 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
710 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
711 <A HREF="../../../../../com/sun/speech/freetts/audio/MultiFile8BitAudioPlayer.html" title="class in com.sun.speech.freetts.audio"><B>PREV CLASS</B></A>
\r
712 <A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html" title="class in com.sun.speech.freetts.audio"><B>NEXT CLASS</B></A></FONT></TD>
\r
713 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
714 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
715 <A HREF="MultiFileAudioPlayer.html" target="_top"><B>NO FRAMES</B></A>
\r
716 <SCRIPT type="text/javascript">
\r
719 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
724 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
730 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
731 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
732 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
733 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
736 <A NAME="skip-navbar_bottom"></A>
737 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
projects / debian / freetts / blob