1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (build 1.5.0_09) on Sun Sep 02 23:07:09 BST 2007 -->
7 Sound (leJOS NXT API documentation)
10 <META NAME="keywords" CONTENT="lejos.nxt.Sound class">
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
14 <SCRIPT type="text/javascript">
15 function windowTitle()
17 parent.document.title="Sound (leJOS NXT API documentation)";
25 <BODY BGCOLOR="white" onload="windowTitle();">
28 <!-- ========= START OF TOP NAVBAR ======= -->
29 <A NAME="navbar_top"><!-- --></A>
30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34 <A NAME="navbar_top_firstrow"><!-- --></A>
35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36 <TR ALIGN="center" VALIGN="top">
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54 <A HREF="../../lejos/nxt/SensorPortListener.html" title="interface in lejos.nxt"><B>PREV CLASS</B></A>
55 <A HREF="../../lejos/nxt/SoundSensor.html" title="class in lejos.nxt"><B>NEXT CLASS</B></A></FONT></TD>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../index.html?lejos/nxt/Sound.html" target="_top"><B>FRAMES</B></A>
58 <A HREF="Sound.html" target="_top"><B>NO FRAMES</B></A>
59 <SCRIPT type="text/javascript">
62 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
67 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
74 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77 DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
80 <A NAME="skip-navbar_top"></A>
81 <!-- ========= END OF TOP NAVBAR ========= -->
84 <!-- ======== START OF CLASS DATA ======== -->
91 <A HREF="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</A>
92 <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>lejos.nxt.Sound</B>
96 <DT><PRE>public class <B>Sound</B><DT>extends <A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></DL>
107 <!-- =========== FIELD SUMMARY =========== -->
109 <A NAME="field_summary"><!-- --></A>
110 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
111 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
112 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
113 <B>Field Summary</B></FONT></TH>
115 <TR BGCOLOR="white" CLASS="TableRowColor">
116 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
117 <CODE>static int</CODE></FONT></TD>
118 <TD><CODE><B><A HREF="../../lejos/nxt/Sound.html#C2">C2</A></B></CODE>
121 Play a system sound - not yet implemented.</TD>
125 <!-- ========== METHOD SUMMARY =========== -->
127 <A NAME="method_summary"><!-- --></A>
128 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
129 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
130 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
131 <B>Method Summary</B></FONT></TH>
133 <TR BGCOLOR="white" CLASS="TableRowColor">
134 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135 <CODE>static void</CODE></FONT></TD>
136 <TD><CODE><B><A HREF="../../lejos/nxt/Sound.html#beep()">beep</A></B>()</CODE>
139 Beeps once - not yet implemented.</TD>
141 <TR BGCOLOR="white" CLASS="TableRowColor">
142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143 <CODE>static void</CODE></FONT></TD>
144 <TD><CODE><B><A HREF="../../lejos/nxt/Sound.html#beepSequence()">beepSequence</A></B>()</CODE>
147 Downward tones.</TD>
149 <TR BGCOLOR="white" CLASS="TableRowColor">
150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151 <CODE>static void</CODE></FONT></TD>
152 <TD><CODE><B><A HREF="../../lejos/nxt/Sound.html#beepSequenceUp()">beepSequenceUp</A></B>()</CODE>
155 Downward tones.</TD>
157 <TR BGCOLOR="white" CLASS="TableRowColor">
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159 <CODE>static void</CODE></FONT></TD>
160 <TD><CODE><B><A HREF="../../lejos/nxt/Sound.html#buzz()">buzz</A></B>()</CODE>
163 Low buzz</TD>
165 <TR BGCOLOR="white" CLASS="TableRowColor">
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167 <CODE>static void</CODE></FONT></TD>
168 <TD><CODE><B><A HREF="../../lejos/nxt/Sound.html#pause(int)">pause</A></B>(int t)</CODE>
171 </TD>
173 <TR BGCOLOR="white" CLASS="TableRowColor">
174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175 <CODE>static void</CODE></FONT></TD>
176 <TD><CODE><B><A HREF="../../lejos/nxt/Sound.html#playSample(java.io.File, int, int)">playSample</A></B>(<A HREF="../../java/io/File.html" title="class in java.io">File</A> file,
181 </TD>
183 <TR BGCOLOR="white" CLASS="TableRowColor">
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185 <CODE>static void</CODE></FONT></TD>
186 <TD><CODE><B><A HREF="../../lejos/nxt/Sound.html#playSample(int, int, int, int)">playSample</A></B>(int page,
192 Internal method used to play sound sample from a file</TD>
194 <TR BGCOLOR="white" CLASS="TableRowColor">
195 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196 <CODE>static void</CODE></FONT></TD>
197 <TD><CODE><B><A HREF="../../lejos/nxt/Sound.html#playTone(int, int)">playTone</A></B>(int aFrequency,
198 int aDuration)</CODE>
201 Plays a tone, given its frequency and duration.</TD>
203 <TR BGCOLOR="white" CLASS="TableRowColor">
204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
205 <CODE>static void</CODE></FONT></TD>
206 <TD><CODE><B><A HREF="../../lejos/nxt/Sound.html#systemSound(boolean, int)">systemSound</A></B>(boolean aQueued,
207 int aCode)</CODE>
210 </TD>
212 <TR BGCOLOR="white" CLASS="TableRowColor">
213 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214 <CODE>static void</CODE></FONT></TD>
215 <TD><CODE><B><A HREF="../../lejos/nxt/Sound.html#twoBeeps()">twoBeeps</A></B>()</CODE>
218 Beeps twice - not yet implemented.</TD>
221 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
222 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
223 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
224 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></B></TH>
226 <TR BGCOLOR="white" CLASS="TableRowColor">
227 <TD><CODE><A HREF="../../java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="../../java/lang/Object.html#getClass()">getClass</A>, <A HREF="../../java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="../../java/lang/Object.html#notify()">notify</A>, <A HREF="../../java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="../../java/lang/Object.html#toString()">toString</A>, <A HREF="../../java/lang/Object.html#wait()">wait</A>, <A HREF="../../java/lang/Object.html#wait(long)">wait</A></CODE></TD>
233 <!-- ============ FIELD DETAIL =========== -->
235 <A NAME="field_detail"><!-- --></A>
236 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
237 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
238 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
239 <B>Field Detail</B></FONT></TH>
243 <A NAME="C2"><!-- --></A><H3>
246 public static int <B>C2</B></PRE>
248 <DD>Play a system sound - not yet implemented.
250 <TR><TH>aCode</TH><TH>Resulting Sound</TH></TR>
251 <TR><TD>0</TD><TD>short beep</TD></TR>
252 <TR><TD>1</TD><TD>double beep</TD></TR>
253 <TR><TD>2</TD><TD>descending arpeggio</TD></TR>
254 <TR><TD>3</TD><TD>ascending arpeggio</TD></TR>
255 <TR><TD>4</TD><TD>long, low beep</TD></TR>
256 <TR><TD>5</TD><TD>quick ascending arpeggio</TD></TR>
263 <!-- ============ METHOD DETAIL ========== -->
265 <A NAME="method_detail"><!-- --></A>
266 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
267 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
268 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
269 <B>Method Detail</B></FONT></TH>
273 <A NAME="systemSound(boolean, int)"><!-- --></A><H3>
276 public static void <B>systemSound</B>(boolean aQueued,
277 int aCode)</PRE>
285 <A NAME="beep()"><!-- --></A><H3>
288 public static void <B>beep</B>()</PRE>
290 <DD>Beeps once - not yet implemented.
298 <A NAME="twoBeeps()"><!-- --></A><H3>
301 public static void <B>twoBeeps</B>()</PRE>
303 <DD>Beeps twice - not yet implemented.
311 <A NAME="beepSequence()"><!-- --></A><H3>
314 public static void <B>beepSequence</B>()</PRE>
324 <A NAME="beepSequenceUp()"><!-- --></A><H3>
327 public static void <B>beepSequenceUp</B>()</PRE>
337 <A NAME="buzz()"><!-- --></A><H3>
340 public static void <B>buzz</B>()</PRE>
350 <A NAME="pause(int)"><!-- --></A><H3>
353 public static void <B>pause</B>(int t)</PRE>
361 <A NAME="playTone(int, int)"><!-- --></A><H3>
364 public static void <B>playTone</B>(int aFrequency,
365 int aDuration)</PRE>
367 <DD>Plays a tone, given its frequency and duration. Frequency is audible from about 31 to 2100 Hertz. The
368 duration argument is in hundreds of a seconds (centiseconds, not milliseconds) and is truncated
369 at 256, so the maximum duration of a tone is 2.56 seconds.
372 <DT><B>Parameters:</B><DD><CODE>aFrequency</CODE> - The frequency of the tone in Hertz (Hz).<DD><CODE>aDuration</CODE> - The duration of the tone, in centiseconds. Value is truncated at 256 centiseconds.</DL>
377 <A NAME="playSample(int, int, int, int)"><!-- --></A><H3>
380 public static void <B>playSample</B>(int page,
385 <DD>Internal method used to play sound sample from a file
388 <DT><B>Parameters:</B><DD><CODE>page</CODE> - the start page of the file<DD><CODE>len</CODE> - the length of the file<DD><CODE>freq</CODE> - the frequency<DD><CODE>vol</CODE> - the volume</DL>
393 <A NAME="playSample(java.io.File, int, int)"><!-- --></A><H3>
396 public static void <B>playSample</B>(<A HREF="../../java/io/File.html" title="class in java.io">File</A> file,
401 <DT><B>Parameters:</B><DD><CODE>file</CODE> - the 8-bit PWM (WAV) sample file<DD><CODE>freq</CODE> - the average frequency to play the sample at<DD><CODE>vol</CODE> - the sound volume</DL>
404 <!-- ========= END OF CLASS DATA ========= -->
408 <!-- ======= START OF BOTTOM NAVBAR ====== -->
409 <A NAME="navbar_bottom"><!-- --></A>
410 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
411 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
413 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
414 <A NAME="navbar_bottom_firstrow"><!-- --></A>
415 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
416 <TR ALIGN="center" VALIGN="top">
417 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
418 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
419 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
420 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
421 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
422 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
423 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
427 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
433 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
434 <A HREF="../../lejos/nxt/SensorPortListener.html" title="interface in lejos.nxt"><B>PREV CLASS</B></A>
435 <A HREF="../../lejos/nxt/SoundSensor.html" title="class in lejos.nxt"><B>NEXT CLASS</B></A></FONT></TD>
436 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
437 <A HREF="../../index.html?lejos/nxt/Sound.html" target="_top"><B>FRAMES</B></A>
438 <A HREF="Sound.html" target="_top"><B>NO FRAMES</B></A>
439 <SCRIPT type="text/javascript">
442 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
447 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
454 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
455 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
456 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
457 DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
460 <A NAME="skip-navbar_bottom"></A>
461 <!-- ======== END OF BOTTOM NAVBAR ======= -->