Permalink
Browse files

Merged the streams_and_redesign branch. Removed the zip file from the…

… repoo (and moved to downloads page). Added version string to TinySound class.
  • Loading branch information...
2 parents cb7c0b7 + 406d542 commit 013f6914a2a120831283a974be383fef3444db72 @finnkuusisto committed Oct 24, 2012
Showing with 10,548 additions and 5,724 deletions.
  1. +17 −0 README
  2. +29 −44 doc/allclasses-frame.html
  3. +29 −44 doc/allclasses-noframe.html
  4. +128 −130 doc/constant-values.html
  5. +99 −130 doc/deprecated-list.html
  6. +200 −203 doc/help-doc.html
  7. +861 −430 doc/index-all.html
  8. +23 −29 doc/index.html
  9. +542 −598 doc/kuusisto/tinysound/Music.html
  10. +269 −319 doc/kuusisto/tinysound/Sound.html
  11. +629 −488 doc/kuusisto/tinysound/TinySound.html
  12. +331 −350 doc/kuusisto/tinysound/internal/ByteList.html
  13. +691 −0 doc/kuusisto/tinysound/internal/MemMusic.html
  14. +368 −0 doc/kuusisto/tinysound/internal/MemSound.html
  15. +401 −395 doc/kuusisto/tinysound/internal/Mixer.html
  16. +474 −541 doc/kuusisto/tinysound/internal/MusicReference.html
  17. +300 −378 doc/kuusisto/tinysound/internal/SoundReference.html
  18. +277 −0 doc/kuusisto/tinysound/internal/StreamInfo.html
  19. +696 −0 doc/kuusisto/tinysound/internal/StreamMusic.html
  20. +372 −0 doc/kuusisto/tinysound/internal/StreamSound.html
  21. +269 −275 doc/kuusisto/tinysound/internal/UpdateRunner.html
  22. +30 −39 doc/kuusisto/tinysound/internal/package-frame.html
  23. +189 −160 doc/kuusisto/tinysound/internal/package-summary.html
  24. +124 −138 doc/kuusisto/tinysound/internal/package-tree.html
  25. +23 −35 doc/kuusisto/tinysound/package-frame.html
  26. +142 −149 doc/kuusisto/tinysound/package-summary.html
  27. +117 −137 doc/kuusisto/tinysound/package-tree.html
  28. +20 −43 doc/overview-frame.html
  29. +114 −139 doc/overview-summary.html
  30. +128 −137 doc/overview-tree.html
  31. BIN doc/resources/background.gif
  32. BIN doc/resources/inherit.gif
  33. BIN doc/resources/tab.gif
  34. BIN doc/resources/titlebar.gif
  35. BIN doc/resources/titlebar_end.gif
  36. +473 −28 doc/stylesheet.css
  37. +49 −106 src/kuusisto/tinysound/Music.java
  38. +17 −48 src/kuusisto/tinysound/Sound.java
  39. +218 −12 src/kuusisto/tinysound/TinySound.java
  40. +536 −0 src/kuusisto/tinysound/internal/MemMusic.java
  41. +236 −0 src/kuusisto/tinysound/internal/MemSound.java
  42. +69 −14 src/kuusisto/tinysound/internal/Mixer.java
  43. +46 −119 src/kuusisto/tinysound/internal/MusicReference.java
  44. +25 −66 src/kuusisto/tinysound/internal/SoundReference.java
  45. +41 −0 src/kuusisto/tinysound/internal/StreamInfo.java
  46. +632 −0 src/kuusisto/tinysound/internal/StreamMusic.java
  47. +314 −0 src/kuusisto/tinysound/internal/StreamSound.java
  48. BIN tinysound.zip
View
17 README
@@ -4,6 +4,11 @@ TinySound is a simple sound system that wraps the standard Java sound libraries.
It is "tiny" in that it is intended to have a small, easy-to-use interface with
everything that you need to play sounds and music, and nothing that you don't.
+Releases
+--------
+If you would just like to download the jar files, see the downloads page:
+https://github.com/finnkuusisto/TinySound/downloads
+
License
-------
TinySound is licensed under the BSD 2-Clause license. A copy of the license can
@@ -61,6 +66,18 @@ When a Sound is played it is queued to be played from the speakers once. Of
course, you can play a Sound multiple times in an overlapping fashion so it is
generally useful for sound effects. See the Javadocs for more detail.
+Memory Usage
+------------
+The basic loading functions for Music and Sound objects produce implementations
+that store all audio data in memory. This is good for maintaining low latency,
+but can also require a lot of heap space if you load many, or particularly long,
+audio resources. There are loading functions available that allow you to
+request that the audio data be streamed from a file. If this is requested, the
+audio data will first be converted as usual and then written to a temporary file
+from which it will be streamed. This will dramatically reduce the overall
+memory usage (after loading), but can potentially introduce occasional latency
+when reading from disk.
+
Example
-------
There is a very simple example provided in the example directory. You'll need
View
@@ -1,45 +1,30 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<!--NewPage-->
-<HTML>
-<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon May 14 23:38:16 CDT 2012 -->
-<TITLE>
-All Classes
-</TITLE>
-
-<META NAME="date" CONTENT="2012-05-14">
-
-<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
-
-
-</HEAD>
-
-<BODY BGCOLOR="white">
-<FONT size="+1" CLASS="FrameHeadingFont">
-<B>All Classes</B></FONT>
-<BR>
-
-<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
-<TR>
-<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="kuusisto/tinysound/internal/ByteList.html" title="class in kuusisto.tinysound.internal" target="classFrame">ByteList</A>
-<BR>
-<A HREF="kuusisto/tinysound/internal/Mixer.html" title="class in kuusisto.tinysound.internal" target="classFrame">Mixer</A>
-<BR>
-<A HREF="kuusisto/tinysound/Music.html" title="class in kuusisto.tinysound" target="classFrame">Music</A>
-<BR>
-<A HREF="kuusisto/tinysound/internal/MusicReference.html" title="class in kuusisto.tinysound.internal" target="classFrame">MusicReference</A>
-<BR>
-<A HREF="kuusisto/tinysound/Sound.html" title="class in kuusisto.tinysound" target="classFrame">Sound</A>
-<BR>
-<A HREF="kuusisto/tinysound/internal/SoundReference.html" title="class in kuusisto.tinysound.internal" target="classFrame">SoundReference</A>
-<BR>
-<A HREF="kuusisto/tinysound/TinySound.html" title="class in kuusisto.tinysound" target="classFrame">TinySound</A>
-<BR>
-<A HREF="kuusisto/tinysound/internal/UpdateRunner.html" title="class in kuusisto.tinysound.internal" target="classFrame">UpdateRunner</A>
-<BR>
-</FONT></TD>
-</TR>
-</TABLE>
-
-</BODY>
-</HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_03) on Tue Oct 23 22:04:13 CDT 2012 -->
+<title>All Classes</title>
+<meta name="date" content="2012-10-23">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+</head>
+<body>
+<h1 class="bar">All Classes</h1>
+<div class="indexContainer">
+<ul>
+<li><a href="kuusisto/tinysound/internal/ByteList.html" title="class in kuusisto.tinysound.internal" target="classFrame">ByteList</a></li>
+<li><a href="kuusisto/tinysound/internal/MemMusic.html" title="class in kuusisto.tinysound.internal" target="classFrame">MemMusic</a></li>
+<li><a href="kuusisto/tinysound/internal/MemSound.html" title="class in kuusisto.tinysound.internal" target="classFrame">MemSound</a></li>
+<li><a href="kuusisto/tinysound/internal/Mixer.html" title="class in kuusisto.tinysound.internal" target="classFrame">Mixer</a></li>
+<li><a href="kuusisto/tinysound/Music.html" title="interface in kuusisto.tinysound" target="classFrame"><i>Music</i></a></li>
+<li><a href="kuusisto/tinysound/internal/MusicReference.html" title="interface in kuusisto.tinysound.internal" target="classFrame"><i>MusicReference</i></a></li>
+<li><a href="kuusisto/tinysound/Sound.html" title="interface in kuusisto.tinysound" target="classFrame"><i>Sound</i></a></li>
+<li><a href="kuusisto/tinysound/internal/SoundReference.html" title="interface in kuusisto.tinysound.internal" target="classFrame"><i>SoundReference</i></a></li>
+<li><a href="kuusisto/tinysound/internal/StreamInfo.html" title="class in kuusisto.tinysound.internal" target="classFrame">StreamInfo</a></li>
+<li><a href="kuusisto/tinysound/internal/StreamMusic.html" title="class in kuusisto.tinysound.internal" target="classFrame">StreamMusic</a></li>
+<li><a href="kuusisto/tinysound/internal/StreamSound.html" title="class in kuusisto.tinysound.internal" target="classFrame">StreamSound</a></li>
+<li><a href="kuusisto/tinysound/TinySound.html" title="class in kuusisto.tinysound" target="classFrame">TinySound</a></li>
+<li><a href="kuusisto/tinysound/internal/UpdateRunner.html" title="class in kuusisto.tinysound.internal" target="classFrame">UpdateRunner</a></li>
+</ul>
+</div>
+</body>
+</html>
@@ -1,45 +1,30 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<!--NewPage-->
-<HTML>
-<HEAD>
-<!-- Generated by javadoc (build 1.6.0_11) on Mon May 14 23:38:16 CDT 2012 -->
-<TITLE>
-All Classes
-</TITLE>
-
-<META NAME="date" CONTENT="2012-05-14">
-
-<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
-
-
-</HEAD>
-
-<BODY BGCOLOR="white">
-<FONT size="+1" CLASS="FrameHeadingFont">
-<B>All Classes</B></FONT>
-<BR>
-
-<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
-<TR>
-<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="kuusisto/tinysound/internal/ByteList.html" title="class in kuusisto.tinysound.internal">ByteList</A>
-<BR>
-<A HREF="kuusisto/tinysound/internal/Mixer.html" title="class in kuusisto.tinysound.internal">Mixer</A>
-<BR>
-<A HREF="kuusisto/tinysound/Music.html" title="class in kuusisto.tinysound">Music</A>
-<BR>
-<A HREF="kuusisto/tinysound/internal/MusicReference.html" title="class in kuusisto.tinysound.internal">MusicReference</A>
-<BR>
-<A HREF="kuusisto/tinysound/Sound.html" title="class in kuusisto.tinysound">Sound</A>
-<BR>
-<A HREF="kuusisto/tinysound/internal/SoundReference.html" title="class in kuusisto.tinysound.internal">SoundReference</A>
-<BR>
-<A HREF="kuusisto/tinysound/TinySound.html" title="class in kuusisto.tinysound">TinySound</A>
-<BR>
-<A HREF="kuusisto/tinysound/internal/UpdateRunner.html" title="class in kuusisto.tinysound.internal">UpdateRunner</A>
-<BR>
-</FONT></TD>
-</TR>
-</TABLE>
-
-</BODY>
-</HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_03) on Tue Oct 23 22:04:13 CDT 2012 -->
+<title>All Classes</title>
+<meta name="date" content="2012-10-23">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+</head>
+<body>
+<h1 class="bar">All Classes</h1>
+<div class="indexContainer">
+<ul>
+<li><a href="kuusisto/tinysound/internal/ByteList.html" title="class in kuusisto.tinysound.internal">ByteList</a></li>
+<li><a href="kuusisto/tinysound/internal/MemMusic.html" title="class in kuusisto.tinysound.internal">MemMusic</a></li>
+<li><a href="kuusisto/tinysound/internal/MemSound.html" title="class in kuusisto.tinysound.internal">MemSound</a></li>
+<li><a href="kuusisto/tinysound/internal/Mixer.html" title="class in kuusisto.tinysound.internal">Mixer</a></li>
+<li><a href="kuusisto/tinysound/Music.html" title="interface in kuusisto.tinysound"><i>Music</i></a></li>
+<li><a href="kuusisto/tinysound/internal/MusicReference.html" title="interface in kuusisto.tinysound.internal"><i>MusicReference</i></a></li>
+<li><a href="kuusisto/tinysound/Sound.html" title="interface in kuusisto.tinysound"><i>Sound</i></a></li>
+<li><a href="kuusisto/tinysound/internal/SoundReference.html" title="interface in kuusisto.tinysound.internal"><i>SoundReference</i></a></li>
+<li><a href="kuusisto/tinysound/internal/StreamInfo.html" title="class in kuusisto.tinysound.internal">StreamInfo</a></li>
+<li><a href="kuusisto/tinysound/internal/StreamMusic.html" title="class in kuusisto.tinysound.internal">StreamMusic</a></li>
+<li><a href="kuusisto/tinysound/internal/StreamSound.html" title="class in kuusisto.tinysound.internal">StreamSound</a></li>
+<li><a href="kuusisto/tinysound/TinySound.html" title="class in kuusisto.tinysound">TinySound</a></li>
+<li><a href="kuusisto/tinysound/internal/UpdateRunner.html" title="class in kuusisto.tinysound.internal">UpdateRunner</a></li>
+</ul>
+</div>
+</body>
+</html>
Oops, something went wrong.

0 comments on commit 013f691

Please sign in to comment.