Skip to content

Commit

Permalink
Deploying to javadoc from @ 02393e5 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
Hangman committed Jul 28, 2024
1 parent d0d2b8a commit 49e1092
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 70 deletions.
2 changes: 1 addition & 1 deletion javadoc/de/pottgames/tuningfork/decoder/package-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ <h2 title="Enum Hierarchy">Enum Hierarchy</h2>
<ul>
<li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
<ul>
<li type="circle">de.pottgames.tuningfork.decoder.<a href="../../../../de/pottgames/tuningfork/decoder/LawDecoder.Encoding.html" title="enum in de.pottgames.tuningfork.decoder"><span class="typeNameLink">LawDecoder.Encoding</span></a></li>
<li type="circle">de.pottgames.tuningfork.decoder.<a href="../../../../de/pottgames/tuningfork/decoder/WavAudioFormat.html" title="enum in de.pottgames.tuningfork.decoder"><span class="typeNameLink">WavAudioFormat</span></a></li>
<li type="circle">de.pottgames.tuningfork.decoder.<a href="../../../../de/pottgames/tuningfork/decoder/LawDecoder.Encoding.html" title="enum in de.pottgames.tuningfork.decoder"><span class="typeNameLink">LawDecoder.Encoding</span></a></li>
</ul>
</li>
</ul>
Expand Down
41 changes: 13 additions & 28 deletions javadoc/de/pottgames/tuningfork/jukebox/JukeBox.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -303,47 +303,42 @@ <h3>Method Summary</h3>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#notifySongStart-de.pottgames.tuningfork.jukebox.song.Song-">notifySongStart</a></span>(<a href="../../../../de/pottgames/tuningfork/jukebox/song/Song.html" title="class in de.pottgames.tuningfork.jukebox.song">Song</a>&nbsp;song)</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#notifyVolumeChange-float-float-">notifyVolumeChange</a></span>(float&nbsp;oldVolume,
float&nbsp;newVolume)</code>&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#pause--">pause</a></span>()</code>
<div class="block">Pauses playback.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#play--">play</a></span>()</code>
<div class="block">Starts playback.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<tr id="i19" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#pushEvent-de.pottgames.tuningfork.jukebox.JukeBoxEvent.JukeBoxEventType-">pushEvent</a></span>(<a href="../../../../de/pottgames/tuningfork/jukebox/JukeBoxEvent.JukeBoxEventType.html" title="enum in de.pottgames.tuningfork.jukebox">JukeBoxEvent.JukeBoxEventType</a>&nbsp;type)</code>&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<tr id="i20" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#pushEvent-de.pottgames.tuningfork.jukebox.JukeBoxEvent.JukeBoxEventType-de.pottgames.tuningfork.jukebox.playlist.PlayList-">pushEvent</a></span>(<a href="../../../../de/pottgames/tuningfork/jukebox/JukeBoxEvent.JukeBoxEventType.html" title="enum in de.pottgames.tuningfork.jukebox">JukeBoxEvent.JukeBoxEventType</a>&nbsp;type,
<a href="../../../../de/pottgames/tuningfork/jukebox/playlist/PlayList.html" title="class in de.pottgames.tuningfork.jukebox.playlist">PlayList</a>&nbsp;playList)</code>&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<tr id="i21" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#pushEvent-de.pottgames.tuningfork.jukebox.JukeBoxEvent.JukeBoxEventType-de.pottgames.tuningfork.jukebox.song.Song-">pushEvent</a></span>(<a href="../../../../de/pottgames/tuningfork/jukebox/JukeBoxEvent.JukeBoxEventType.html" title="enum in de.pottgames.tuningfork.jukebox">JukeBoxEvent.JukeBoxEventType</a>&nbsp;type,
<a href="../../../../de/pottgames/tuningfork/jukebox/song/Song.html" title="class in de.pottgames.tuningfork.jukebox.song">Song</a>&nbsp;song)</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#removeObserver-de.pottgames.tuningfork.jukebox.JukeBoxObserver-">removeObserver</a></span>(<a href="../../../../de/pottgames/tuningfork/jukebox/JukeBoxObserver.html" title="interface in de.pottgames.tuningfork.jukebox">JukeBoxObserver</a>&nbsp;observer)</code>
<div class="block">Removes an observer.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<tr id="i23" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#resetSoftStop-boolean-">resetSoftStop</a></span>(boolean&nbsp;clearResume)</code>&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#setVolume-float-">setVolume</a></span>(float&nbsp;volume)</code>
<div class="block">Sets the master volume of the Jukebox.<br>
Expand All @@ -354,7 +349,7 @@ <h3>Method Summary</h3>
</code></div>
</td>
</tr>
<tr id="i26" class="altColor">
<tr id="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#softStop-com.badlogic.gdx.math.Interpolation-float-">softStop</a></span>(com.badlogic.gdx.math.Interpolation&nbsp;fadeOutCurve,
float&nbsp;fadeOutDuration)</code>
Expand All @@ -367,7 +362,7 @@ <h3>Method Summary</h3>
- fadeOutDuration is smaller or equal 0<br></div>
</td>
</tr>
<tr id="i27" class="rowColor">
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#softStopAndResume-com.badlogic.gdx.math.Interpolation-float-">softStopAndResume</a></span>(com.badlogic.gdx.math.Interpolation&nbsp;fadeOutCurve,
float&nbsp;fadeOutDuration)</code>
Expand All @@ -380,17 +375,17 @@ <h3>Method Summary</h3>
1.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<tr id="i27" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#softStopFade-de.pottgames.tuningfork.jukebox.song.SongSource-">softStopFade</a></span>(<a href="../../../../de/pottgames/tuningfork/jukebox/song/SongSource.html" title="class in de.pottgames.tuningfork.jukebox.song">SongSource</a>&nbsp;source)</code>&nbsp;</td>
</tr>
<tr id="i29" class="rowColor">
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#stop--">stop</a></span>()</code>
<div class="block">Stops playback and resets the current <a href="../../../../de/pottgames/tuningfork/jukebox/playlist/PlayList.html" title="class in de.pottgames.tuningfork.jukebox.playlist"><code>PlayList</code></a> if applicable.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#update--">update</a></span>()</code>
<div class="block">Updates the JukeBox.</div>
Expand Down Expand Up @@ -853,16 +848,6 @@ <h4>handleEvents</h4>
<pre>protected&nbsp;void&nbsp;handleEvents()</pre>
</li>
</ul>
<a name="notifyVolumeChange-float-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyVolumeChange</h4>
<pre>protected&nbsp;void&nbsp;notifyVolumeChange(float&nbsp;oldVolume,
float&nbsp;newVolume)</pre>
</li>
</ul>
<a name="notifySongStart-de.pottgames.tuningfork.jukebox.song.Song-">
<!-- -->
</a>
Expand Down
37 changes: 7 additions & 30 deletions javadoc/de/pottgames/tuningfork/jukebox/JukeBoxObserver.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":18,"i4":6,"i5":6,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
Expand Down Expand Up @@ -114,7 +114,7 @@ <h2 title="Interface JukeBoxObserver" class="title">Interface JukeBoxObserver</h
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
Expand All @@ -138,31 +138,24 @@ <h3>Method Summary</h3>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBoxObserver.html#onMasterVolumeChanged-float-float-">onMasterVolumeChanged</a></span>(float&nbsp;oldVolume,
float&nbsp;newVolume)</code>
<div class="block">This method is called when the master volume of the <a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html" title="class in de.pottgames.tuningfork.jukebox"><code>JukeBox</code></a> changed by calling <a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#setVolume-float-"><code>JukeBox.setVolume(float)</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBoxObserver.html#onPlayListEnd-de.pottgames.tuningfork.jukebox.playlist.PlayList-">onPlayListEnd</a></span>(<a href="../../../../de/pottgames/tuningfork/jukebox/playlist/PlayList.html" title="class in de.pottgames.tuningfork.jukebox.playlist">PlayList</a>&nbsp;playList)</code>
<div class="block">This method is called when a <a href="../../../../de/pottgames/tuningfork/jukebox/playlist/PlayList.html" title="class in de.pottgames.tuningfork.jukebox.playlist"><code>PlayList</code></a> finished playing.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBoxObserver.html#onPlayListStart-de.pottgames.tuningfork.jukebox.playlist.PlayList-">onPlayListStart</a></span>(<a href="../../../../de/pottgames/tuningfork/jukebox/playlist/PlayList.html" title="class in de.pottgames.tuningfork.jukebox.playlist">PlayList</a>&nbsp;playList)</code>
<div class="block">This method is called when a new <a href="../../../../de/pottgames/tuningfork/jukebox/playlist/PlayList.html" title="class in de.pottgames.tuningfork.jukebox.playlist"><code>PlayList</code></a> is used to play songs.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBoxObserver.html#onSongEnd-de.pottgames.tuningfork.jukebox.song.Song-">onSongEnd</a></span>(<a href="../../../../de/pottgames/tuningfork/jukebox/song/Song.html" title="class in de.pottgames.tuningfork.jukebox.song">Song</a>&nbsp;song)</code>
<div class="block">This method is called when a song finished playing.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/pottgames/tuningfork/jukebox/JukeBoxObserver.html#onSongStart-de.pottgames.tuningfork.jukebox.song.Song-">onSongStart</a></span>(<a href="../../../../de/pottgames/tuningfork/jukebox/song/Song.html" title="class in de.pottgames.tuningfork.jukebox.song">Song</a>&nbsp;song)</code>
<div class="block">This method is called when a new song is played.</div>
Expand Down Expand Up @@ -262,29 +255,13 @@ <h4>onJukeBoxPause</h4>
<a name="onJukeBoxEnd--">
<!-- -->
</a>
<ul class="blockList">
<ul class="blockListLast">
<li class="blockList">
<h4>onJukeBoxEnd</h4>
<pre>void&nbsp;onJukeBoxEnd()</pre>
<div class="block">This method is called when the <a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html" title="class in de.pottgames.tuningfork.jukebox"><code>JukeBox</code></a> stops playing, either by running out of songs/playlists or by being stopped manually.</div>
</li>
</ul>
<a name="onMasterVolumeChanged-float-float-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onMasterVolumeChanged</h4>
<pre>default&nbsp;void&nbsp;onMasterVolumeChanged(float&nbsp;oldVolume,
float&nbsp;newVolume)</pre>
<div class="block">This method is called when the master volume of the <a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html" title="class in de.pottgames.tuningfork.jukebox"><code>JukeBox</code></a> changed by calling <a href="../../../../de/pottgames/tuningfork/jukebox/JukeBox.html#setVolume-float-"><code>JukeBox.setVolume(float)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>oldVolume</code> - the volume before the change</dd>
<dd><code>newVolume</code> - the new volume after the change</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
10 changes: 5 additions & 5 deletions javadoc/de/pottgames/tuningfork/package-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,14 +175,14 @@ <h2 title="Enum Hierarchy">Enum Hierarchy</h2>
<li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
<ul>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/AudioConfig.Virtualization.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">AudioConfig.Virtualization</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/DistanceAttenuationModel.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">DistanceAttenuationModel</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/ALExtension.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">ALExtension</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/PcmFormat.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">PcmFormat</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/AudioConfig.Spatialization.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">AudioConfig.Spatialization</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/PcmFormat.PcmDataType.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">PcmFormat.PcmDataType</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/OutputMode.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">OutputMode</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/StreamManager.TaskAction.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">StreamManager.TaskAction</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/OutputMode.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">OutputMode</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/PcmFormat.PcmDataType.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">PcmFormat.PcmDataType</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/SoundFileType.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">SoundFileType</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/DistanceAttenuationModel.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">DistanceAttenuationModel</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/AudioConfig.Spatialization.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">AudioConfig.Spatialization</span></a></li>
<li type="circle">de.pottgames.tuningfork.<a href="../../../de/pottgames/tuningfork/PcmFormat.html" title="enum in de.pottgames.tuningfork"><span class="typeNameLink">PcmFormat</span></a></li>
</ul>
</li>
</ul>
Expand Down
Loading

0 comments on commit 49e1092

Please sign in to comment.