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 NullAudioPlayer (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.audio.NullAudioPlayer 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="NullAudioPlayer (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/MultiFileAudioPlayer.html" title="class in com.sun.speech.freetts.audio"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.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="NullAudioPlayer.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 NullAudioPlayer</H2>
\r
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.audio.NullAudioPlayer</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>NullAudioPlayer</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 bit bucket. The <code>NullAudioPlayer</code>
101 is instrumented to provide timing metrics.
\r
108 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
111 <!-- =========== FIELD SUMMARY =========== -->
\r
114 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
116 <A NAME="constructor_summary"><!-- --></A>
117 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
118 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
119 <TD COLSPAN=2><FONT SIZE="+2">
\r
120 <B>Constructor Summary</B></FONT></TD>
\r
122 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
123 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#NullAudioPlayer()">NullAudioPlayer</A></B>()</CODE>
\r
126 Constructs a NullAudioPlayer</TD>
\r
130 <!-- ========== METHOD SUMMARY =========== -->
\r
132 <A NAME="method_summary"><!-- --></A>
133 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
134 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
135 <TD COLSPAN=2><FONT SIZE="+2">
\r
136 <B>Method Summary</B></FONT></TD>
\r
138 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
139 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
140 <CODE> void</CODE></FONT></TD>
\r
141 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#begin(int)">begin</A></B>(int size)</CODE>
\r
144 Starts the output of a set of data</TD>
\r
146 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
147 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
148 <CODE> void</CODE></FONT></TD>
\r
149 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#cancel()">cancel</A></B>()</CODE>
\r
152 Cancels all queued output. </TD>
\r
154 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
155 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
156 <CODE> void</CODE></FONT></TD>
\r
157 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#close()">close</A></B>()</CODE>
\r
160 Waits for all audio playback to stop, and closes this AudioPlayer.</TD>
\r
162 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
163 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
164 <CODE> boolean</CODE></FONT></TD>
\r
165 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#drain()">drain</A></B>()</CODE>
\r
168 Waits for all queued audio to be played</TD>
\r
170 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
171 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
172 <CODE> boolean</CODE></FONT></TD>
\r
173 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#end()">end</A></B>()</CODE>
\r
176 Marks the end of a set of data</TD>
\r
178 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
179 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
180 <CODE> javax.sound.sampled.AudioFormat</CODE></FONT></TD>
\r
181 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#getAudioFormat()">getAudioFormat</A></B>()</CODE>
\r
184 Retrieves the audio format for this player</TD>
\r
186 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
188 <CODE> long</CODE></FONT></TD>
\r
189 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#getTime()">getTime</A></B>()</CODE>
\r
192 Gets the amount of played since the last resetTime
193 Currently not supported.</TD>
\r
195 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
196 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
197 <CODE> float</CODE></FONT></TD>
\r
198 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#getVolume()">getVolume</A></B>()</CODE>
\r
201 Returns the current volume.</TD>
\r
203 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
205 <CODE> void</CODE></FONT></TD>
\r
206 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#pause()">pause</A></B>()</CODE>
\r
209 Pauses the audio output</TD>
\r
211 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
212 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
213 <CODE> void</CODE></FONT></TD>
\r
214 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#reset()">reset</A></B>()</CODE>
\r
217 Prepares for another batch of output. </TD>
\r
219 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
220 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
221 <CODE> void</CODE></FONT></TD>
\r
222 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#resetTime()">resetTime</A></B>()</CODE>
\r
225 Resets the audio clock</TD>
\r
227 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
229 <CODE> void</CODE></FONT></TD>
\r
230 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#resume()">resume</A></B>()</CODE>
\r
233 Resumes audio output</TD>
\r
235 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
236 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
237 <CODE> void</CODE></FONT></TD>
\r
238 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#setAudioFormat(javax.sound.sampled.AudioFormat)">setAudioFormat</A></B>(javax.sound.sampled.AudioFormat format)</CODE>
\r
241 Sets the audio format for this player</TD>
\r
243 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
244 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
245 <CODE> void</CODE></FONT></TD>
\r
246 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#setVolume(float)">setVolume</A></B>(float volume)</CODE>
\r
249 Sets the current volume.</TD>
\r
251 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
252 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
253 <CODE> void</CODE></FONT></TD>
\r
254 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#showMetrics()">showMetrics</A></B>()</CODE>
\r
257 Shows metrics for this audio player</TD>
\r
259 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
261 <CODE> void</CODE></FONT></TD>
\r
262 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#startFirstSampleTimer()">startFirstSampleTimer</A></B>()</CODE>
\r
265 Starts the first sample timer</TD>
\r
267 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
268 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
269 <CODE> boolean</CODE></FONT></TD>
\r
270 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#write(byte[])">write</A></B>(byte[] audioData)</CODE>
\r
273 Writes the given bytes to the audio stream</TD>
\r
275 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
276 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
277 <CODE> boolean</CODE></FONT></TD>
\r
278 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/audio/NullAudioPlayer.html#write(byte[], int, int)">write</A></B>(byte[] bytes,
280 int size)</CODE>
\r
283 Writes the given bytes to the audio stream</TD>
\r
286 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
287 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
288 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
289 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
291 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
292 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
298 <!-- ============ FIELD DETAIL =========== -->
\r
301 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
303 <A NAME="constructor_detail"><!-- --></A>
304 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
305 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
306 <TD COLSPAN=1><FONT SIZE="+2">
\r
307 <B>Constructor Detail</B></FONT></TD>
\r
311 <A NAME="NullAudioPlayer()"><!-- --></A><H3>
\r
312 NullAudioPlayer</H3>
\r
314 public <B>NullAudioPlayer</B>()</PRE>
\r
316 <DD>Constructs a NullAudioPlayer
\r
320 <!-- ============ METHOD DETAIL ========== -->
\r
322 <A NAME="method_detail"><!-- --></A>
323 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
324 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
325 <TD COLSPAN=1><FONT SIZE="+2">
\r
326 <B>Method Detail</B></FONT></TD>
\r
330 <A NAME="setAudioFormat(javax.sound.sampled.AudioFormat)"><!-- --></A><H3>
\r
331 setAudioFormat</H3>
\r
333 public void <B>setAudioFormat</B>(javax.sound.sampled.AudioFormat format)</PRE>
\r
335 <DD>Sets the audio format for this player
\r
338 <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
341 <DT><B>Parameters:</B><DD><CODE>format</CODE> - the audio format</DL>
\r
346 <A NAME="getAudioFormat()"><!-- --></A><H3>
\r
347 getAudioFormat</H3>
\r
349 public javax.sound.sampled.AudioFormat <B>getAudioFormat</B>()</PRE>
\r
351 <DD>Retrieves the audio format for this player
\r
354 <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
358 <DT><B>Returns:</B><DD>the current audio format.</DL>
\r
363 <A NAME="cancel()"><!-- --></A><H3>
\r
366 public void <B>cancel</B>()</PRE>
\r
368 <DD>Cancels all queued output. Current 'write' call will return
372 <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
380 <A NAME="pause()"><!-- --></A><H3>
\r
383 public void <B>pause</B>()</PRE>
\r
385 <DD>Pauses the audio output
\r
388 <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
396 <A NAME="reset()"><!-- --></A><H3>
\r
399 public void <B>reset</B>()</PRE>
\r
401 <DD>Prepares for another batch of output. Larger groups of output
402 (such as all output associated with a single FreeTTSSpeakable)
403 should be grouped between a reset/drain pair.
\r
406 <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
414 <A NAME="resume()"><!-- --></A><H3>
\r
417 public void <B>resume</B>()</PRE>
\r
419 <DD>Resumes audio output
\r
422 <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
430 <A NAME="close()"><!-- --></A><H3>
\r
433 public void <B>close</B>()</PRE>
\r
435 <DD>Waits for all audio playback to stop, and closes this AudioPlayer.
\r
438 <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
446 <A NAME="getVolume()"><!-- --></A><H3>
\r
449 public float <B>getVolume</B>()</PRE>
\r
451 <DD>Returns the current volume.
\r
454 <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
458 <DT><B>Returns:</B><DD>the current volume (between 0 and 1)</DL>
\r
463 <A NAME="setVolume(float)"><!-- --></A><H3>
\r
466 public void <B>setVolume</B>(float volume)</PRE>
\r
468 <DD>Sets the current volume.
\r
471 <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
474 <DT><B>Parameters:</B><DD><CODE>volume</CODE> - the current volume (between 0 and 1)</DL>
\r
479 <A NAME="write(byte[])"><!-- --></A><H3>
\r
482 public boolean <B>write</B>(byte[] audioData)</PRE>
\r
484 <DD>Writes the given bytes to the audio stream
\r
487 <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
490 <DT><B>Parameters:</B><DD><CODE>audioData</CODE> - array of audio data
491 <DT><B>Returns:</B><DD><code>true</code> of the write completed successfully,
492 <code> false </code>if the write was cancelled.</DL>
\r
497 <A NAME="begin(int)"><!-- --></A><H3>
\r
500 public void <B>begin</B>(int size)</PRE>
\r
502 <DD>Starts the output of a set of data
\r
505 <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
508 <DT><B>Parameters:</B><DD><CODE>size</CODE> - the size of data between now and the end</DL>
\r
513 <A NAME="end()"><!-- --></A><H3>
\r
516 public boolean <B>end</B>()</PRE>
\r
518 <DD>Marks the end of a set of data
\r
521 <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
525 <DT><B>Returns:</B><DD><code>true</code> if the audio was output properly,
526 <code> false</code> if the output was canceled
527 or interrupted.</DL>
\r
532 <A NAME="write(byte[], int, int)"><!-- --></A><H3>
\r
535 public boolean <B>write</B>(byte[] bytes,
537 int size)</PRE>
\r
539 <DD>Writes the given bytes to the audio stream
\r
542 <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
545 <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
546 <DT><B>Returns:</B><DD><code>true</code> of the write completed successfully,
547 <code> false </code>if the write was cancelled.</DL>
\r
552 <A NAME="startFirstSampleTimer()"><!-- --></A><H3>
\r
553 startFirstSampleTimer</H3>
\r
555 public void <B>startFirstSampleTimer</B>()</PRE>
\r
557 <DD>Starts the first sample timer
\r
560 <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
568 <A NAME="drain()"><!-- --></A><H3>
\r
571 public boolean <B>drain</B>()</PRE>
\r
573 <DD>Waits for all queued audio to be played
\r
576 <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
580 <DT><B>Returns:</B><DD><code>true</code> if the audio played to completion,
581 <code> false </code>if the audio was stopped</DL>
\r
586 <A NAME="getTime()"><!-- --></A><H3>
\r
589 public long <B>getTime</B>()</PRE>
\r
591 <DD>Gets the amount of played since the last resetTime
592 Currently not supported.
\r
595 <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
599 <DT><B>Returns:</B><DD>the amount of audio in milliseconds</DL>
\r
604 <A NAME="resetTime()"><!-- --></A><H3>
\r
607 public void <B>resetTime</B>()</PRE>
\r
609 <DD>Resets the audio clock
\r
612 <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
620 <A NAME="showMetrics()"><!-- --></A><H3>
\r
623 public void <B>showMetrics</B>()</PRE>
\r
625 <DD>Shows metrics for this audio player
\r
628 <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
634 <!-- ========= END OF CLASS DATA ========= -->
\r
638 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
639 <A NAME="navbar_bottom"><!-- --></A>
640 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
641 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
643 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
644 <A NAME="navbar_bottom_firstrow"><!-- --></A>
645 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
646 <TR ALIGN="center" VALIGN="top">
\r
647 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
648 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
649 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
650 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
651 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
652 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
653 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
657 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
663 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
664 <A HREF="../../../../../com/sun/speech/freetts/audio/MultiFileAudioPlayer.html" title="class in com.sun.speech.freetts.audio"><B>PREV CLASS</B></A>
\r
665 <A HREF="../../../../../com/sun/speech/freetts/audio/RawFileAudioPlayer.html" title="class in com.sun.speech.freetts.audio"><B>NEXT CLASS</B></A></FONT></TD>
\r
666 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
667 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
668 <A HREF="NullAudioPlayer.html" target="_top"><B>NO FRAMES</B></A>
\r
669 <SCRIPT type="text/javascript">
\r
672 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
677 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
683 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
684 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
685 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
686 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
689 <A NAME="skip-navbar_bottom"></A>
690 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
projects / debian / freetts / blob