Permalink
Browse files

Added done() method to Music interface to determine when a Music comp…

…letes. Updated docs.
  • Loading branch information...
finnkuusisto committed Sep 12, 2012
1 parent dc780ba commit cf6368ed6f471fceccc1f86c3cf0f994f20ade89
Showing with 261 additions and 70 deletions.
  1. +2 −2 doc/allclasses-frame.html
  2. +2 −2 doc/allclasses-noframe.html
  3. +2 −2 doc/constant-values.html
  4. +2 −2 doc/deprecated-list.html
  5. +2 −2 doc/help-doc.html
  6. +14 −2 doc/index-all.html
  7. +1 −1 doc/index.html
  8. +24 −2 doc/kuusisto/tinysound/Music.html
  9. +2 −2 doc/kuusisto/tinysound/Sound.html
  10. +2 −2 doc/kuusisto/tinysound/TinySound.html
  11. +2 −2 doc/kuusisto/tinysound/internal/ByteList.html
  12. +27 −2 doc/kuusisto/tinysound/internal/MemMusic.html
  13. +2 −2 doc/kuusisto/tinysound/internal/MemSound.html
  14. +2 −2 doc/kuusisto/tinysound/internal/Mixer.html
  15. +25 −2 doc/kuusisto/tinysound/internal/MusicReference.html
  16. +2 −2 doc/kuusisto/tinysound/internal/SoundReference.html
  17. +2 −2 doc/kuusisto/tinysound/internal/StreamInfo.html
  18. +27 −2 doc/kuusisto/tinysound/internal/StreamMusic.html
  19. +2 −2 doc/kuusisto/tinysound/internal/StreamSound.html
  20. +2 −2 doc/kuusisto/tinysound/internal/UpdateRunner.html
  21. +2 −2 doc/kuusisto/tinysound/internal/package-frame.html
  22. +2 −2 doc/kuusisto/tinysound/internal/package-summary.html
  23. +2 −2 doc/kuusisto/tinysound/internal/package-tree.html
  24. +2 −2 doc/kuusisto/tinysound/package-frame.html
  25. +2 −2 doc/kuusisto/tinysound/package-summary.html
  26. +2 −2 doc/kuusisto/tinysound/package-tree.html
  27. +2 −2 doc/overview-frame.html
  28. +2 −2 doc/overview-summary.html
  29. +2 −2 doc/overview-tree.html
  30. +6 −0 src/kuusisto/tinysound/Music.java
  31. +38 −8 src/kuusisto/tinysound/internal/MemMusic.java
  32. +7 −0 src/kuusisto/tinysound/internal/MusicReference.java
  33. +46 −5 src/kuusisto/tinysound/internal/StreamMusic.java
  34. BIN tinysound.zip
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
All Classes
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
All Classes
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
View
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
Constant Field Values
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
View
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
Deprecated List
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
View
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
API Help
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
View
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
Index
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="./stylesheet.css" TITLE="Style">
@@ -132,6 +132,18 @@
Method in interface kuusisto.tinysound.internal.<A HREF="./kuusisto/tinysound/internal/SoundReference.html" title="interface in kuusisto.tinysound.internal">SoundReference</A>
<DD>Does any cleanup necessary to dispose of resources in use by this
SoundReference.
+<DT><A HREF="./kuusisto/tinysound/internal/MemMusic.html#done()"><B>done()</B></A> -
+Method in class kuusisto.tinysound.internal.<A HREF="./kuusisto/tinysound/internal/MemMusic.html" title="class in kuusisto.tinysound.internal">MemMusic</A>
+<DD>Determine if this MemMusic has reached its end and is done playing.
+<DT><A HREF="./kuusisto/tinysound/internal/MusicReference.html#done()"><B>done()</B></A> -
+Method in interface kuusisto.tinysound.internal.<A HREF="./kuusisto/tinysound/internal/MusicReference.html" title="interface in kuusisto.tinysound.internal">MusicReference</A>
+<DD>Determine if there are no bytes remaining and play has stopped.
+<DT><A HREF="./kuusisto/tinysound/internal/StreamMusic.html#done()"><B>done()</B></A> -
+Method in class kuusisto.tinysound.internal.<A HREF="./kuusisto/tinysound/internal/StreamMusic.html" title="class in kuusisto.tinysound.internal">StreamMusic</A>
+<DD>Determine if this StreamMusic has reached its end and is done playing.
+<DT><A HREF="./kuusisto/tinysound/Music.html#done()"><B>done()</B></A> -
+Method in interface kuusisto.tinysound.<A HREF="./kuusisto/tinysound/Music.html" title="interface in kuusisto.tinysound">Music</A>
+<DD>Determine if this Music has reached its end and is done playing.
</DL>
<HR>
<A NAME="_F_"><!-- --></A><H2>
View
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Mon Aug 20 21:31:05 CDT 2012-->
+<!-- Generated by javadoc on Tue Sep 11 21:06:53 CDT 2012-->
<TITLE>
Generated Documentation (Untitled)
</TITLE>
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:04 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:52 CDT 2012 -->
<TITLE>
Music
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
@@ -123,6 +123,14 @@ <H2>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../kuusisto/tinysound/Music.html#done()">done</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine if this Music has reached its end and is done playing.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../kuusisto/tinysound/Music.html#getLoopPositionByFrame()">getLoopPositionByFrame</A></B>()</CODE>
@@ -378,6 +386,20 @@ <H2>
</DL>
<HR>
+<A NAME="done()"><!-- --></A><H3>
+done</H3>
+<PRE>
+boolean <B>done</B>()</PRE>
+<DL>
+<DD>Determine if this Music has reached its end and is done playing.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>true if this Music is at the end and is done playing</DL>
+</DD>
+</DL>
+<HR>
+
<A NAME="loop()"><!-- --></A><H3>
loop</H3>
<PRE>
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:52 CDT 2012 -->
<TITLE>
Sound
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:52 CDT 2012 -->
<TITLE>
TinySound
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
ByteList
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
MemMusic
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
@@ -145,6 +145,14 @@ <H2>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../kuusisto/tinysound/internal/MemMusic.html#done()">done</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine if this MemMusic has reached its end and is done playing.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../kuusisto/tinysound/internal/MemMusic.html#getLoopPositionByFrame()">getLoopPositionByFrame</A></B>()</CODE>
@@ -457,6 +465,23 @@ <H2>
</DL>
<HR>
+<A NAME="done()"><!-- --></A><H3>
+done</H3>
+<PRE>
+public boolean <B>done</B>()</PRE>
+<DL>
+<DD>Determine if this MemMusic has reached its end and is done playing.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../kuusisto/tinysound/Music.html#done()">done</A></CODE> in interface <CODE><A HREF="../../../kuusisto/tinysound/Music.html" title="interface in kuusisto.tinysound">Music</A></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>true if this MemMusic has reached the end and is done playing</DL>
+</DD>
+</DL>
+<HR>
+
<A NAME="loop()"><!-- --></A><H3>
loop</H3>
<PRE>
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
MemSound
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
Mixer
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
MusicReference
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
@@ -139,6 +139,14 @@ <H2>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../kuusisto/tinysound/internal/MusicReference.html#done()">done</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine if there are no bytes remaining and play has stopped.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../kuusisto/tinysound/internal/MusicReference.html#getLoop()">getLoop</A></B>()</CODE>
<BR>
@@ -397,6 +405,21 @@ <H2>
</DL>
<HR>
+<A NAME="done()"><!-- --></A><H3>
+done</H3>
+<PRE>
+boolean <B>done</B>()</PRE>
+<DL>
+<DD>Determine if there are no bytes remaining and play has stopped.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>true if there are no bytes remaining and the reference is no
+ longer playing</DL>
+</DD>
+</DL>
+<HR>
+
<A NAME="skipBytes(long)"><!-- --></A><H3>
skipBytes</H3>
<PRE>
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
SoundReference
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon Aug 20 21:31:05 CDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_11) on Tue Sep 11 21:06:53 CDT 2012 -->
<TITLE>
StreamInfo
</TITLE>
-<META NAME="date" CONTENT="2012-08-20">
+<META NAME="date" CONTENT="2012-09-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
Oops, something went wrong.

0 comments on commit cf6368e

Please sign in to comment.