<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_17) on Sun Nov 03 15:35:46 CET 2013 -->
<title>Music (libgdx API)
</title>
<meta name="date" content="2013-11-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Music (libgdx API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.
</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/Music.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../index-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>
libgdx API
<style>
body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold }
.TableHeadingColor { background:#EEEEFF; }
a { text-decoration:none }
a:hover { text-decoration:underline }
a:link, a:visited { color:blue }
table { border:0px }
.TableRowColor td:first-child { border-left:1px solid black }
.TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
hr { border:0px; border-bottom:1px solid #333366; }
</style>
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/badlogic/gdx/audio/AudioRecorder.html" title="interface in com.badlogic.gdx.audio"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../com/badlogic/gdx/audio/Music.OnCompletionListener.html" title="interface in com.badlogic.gdx.audio"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/audio/Music.html" target="_top">Frames
</a></li>
<li><a href="Music.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li><a href="#nested_class_summary">Nested
</a> |
</li>
<li>Field
|
</li>
<li>Constr
|
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li>Constr
|
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.badlogic.gdx.audio
</div>
<h2 title="Interface Music" class="title">Interface Music
</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:
</dt>
<dd><a href="../../../../com/badlogic/gdx/utils/Disposable.html" title="interface in com.badlogic.gdx.utils">Disposable
</a></dd>
</dl>
<hr>
<br>
<pre>public interface
<span class="strong">Music
</span>
extends
<a href="../../../../com/badlogic/gdx/utils/Disposable.html" title="interface in com.badlogic.gdx.utils">Disposable
</a></pre>
<div class="block"><p>
A Music instance represents a streamed audio file. The interface supports setting the play back position, pausing and resuming
and so on. When you are done with using the Music instance you have to dispose it via the
<a href="../../../../com/badlogic/gdx/audio/Music.html#dispose()"><code>dispose()
</code></a> method.
</p>
<p>
Music instances are created via
<a href="../../../../com/badlogic/gdx/Audio.html#newMusic(com.badlogic.gdx.files.FileHandle)"><code>Audio.newMusic(FileHandle)
</code></a>.
</p>
<p>
Music instances are automatically paused and resumed when an
<a href="../../../../com/badlogic/gdx/Application.html" title="interface in com.badlogic.gdx"><code>Application
</code></a> is paused or resumed. See
<a href="../../../../com/badlogic/gdx/ApplicationListener.html" title="interface in com.badlogic.gdx"><code>ApplicationListener
</code></a>.
</p></div>
<dl><dt><span class="strong">Author:
</span></dt>
<dd>mzechner
</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Interface and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.OnCompletionListener.html" title="interface in com.badlogic.gdx.audio">Music.OnCompletionListener
</a></strong></code>
<div class="block">Interface definition for a callback to be invoked when playback of
a music stream has completed.
</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Method and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.html#dispose()">dispose
</a></strong>()
</code>
<div class="block">Needs to be called when the Music is no longer needed.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.html#getPosition()">getPosition
</a></strong>()
</code>
<div class="block">Returns the playback position in milliseconds.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.html#getVolume()">getVolume
</a></strong>()
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.html#isLooping()">isLooping
</a></strong>()
</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.html#isPlaying()">isPlaying
</a></strong>()
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.html#pause()">pause
</a></strong>()
</code>
<div class="block">Pauses the play back.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.html#play()">play
</a></strong>()
</code>
<div class="block">Starts the play back of the music stream.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.html#setLooping(boolean)">setLooping
</a></strong>(boolean
isLooping)
</code>
<div class="block">Sets whether the music stream is looping.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.html#setOnCompletionListener(com.badlogic.gdx.audio.Music.OnCompletionListener)">setOnCompletionListener
</a></strong>(
<a href="../../../../com/badlogic/gdx/audio/Music.OnCompletionListener.html" title="interface in com.badlogic.gdx.audio">Music.OnCompletionListener
</a> listener)
</code>
<div class="block">Register a callback to be invoked when the end of a music stream has been reached during playback.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.html#setPan(float, float)">setPan
</a></strong>(float
pan,
float
volume)
</code>
<div class="block">Sets the panning and volume of this music stream.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.html#setVolume(float)">setVolume
</a></strong>(float
volume)
</code>
<div class="block">Sets the volume of this music stream.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/audio/Music.html#stop()">stop
</a></strong>()
</code>
<div class="block">Stops a playing or paused Music instance.
</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail
</h3>
<a name="play()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>play
</h4>
<pre>void
play()
</pre>
<div class="block">Starts the play back of the music stream. In case the stream was paused this will resume the play back. In case the music
stream is finished playing this will restart the play back.
</div>
</li>
</ul>
<a name="pause()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pause
</h4>
<pre>void
pause()
</pre>
<div class="block">Pauses the play back. If the music stream has not been started yet or has finished playing a call to this method will be
ignored.
</div>
</li>
</ul>
<a name="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop
</h4>
<pre>void
stop()
</pre>
<div class="block">Stops a playing or paused Music instance. Next time play() is invoked the Music will start from the beginning.
</div>
</li>
</ul>
<a name="isPlaying()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPlaying
</h4>
<pre>boolean
isPlaying()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>whether this music stream is playing
</dd></dl>
</li>
</ul>
<a name="setLooping(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLooping
</h4>
<pre>void
setLooping(boolean
isLooping)
</pre>
<div class="block">Sets whether the music stream is looping. This can be called at any time, whether the stream is playing.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>isLooping
</code> - whether to loop the stream
</dd></dl>
</li>
</ul>
<a name="isLooping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLooping
</h4>
<pre>boolean
isLooping()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>whether the music stream is playing.
</dd></dl>
</li>
</ul>
<a name="setVolume(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVolume
</h4>
<pre>void
setVolume(float
volume)
</pre>
<div class="block">Sets the volume of this music stream. The volume must be given in the range [0,1] with 0 being silent and 1 being the
maximum volume.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>volume
</code> -
</dd></dl>
</li>
</ul>
<a name="getVolume()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVolume
</h4>
<pre>float
getVolume()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>the volume of this music stream.
</dd></dl>
</li>
</ul>
<a name="setPan(float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPan
</h4>
<pre>void
setPan(float
pan,
float
volume)
</pre>
<div class="block">Sets the panning and volume of this music stream.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>pan
</code> - panning in the range -1 (full left) to 1 (full right). 0 is center position.
</dd><dd><code>volume
</code> - the volume in the range [0,1].
</dd></dl>
</li>
</ul>
<a name="getPosition()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPosition
</h4>
<pre>float
getPosition()
</pre>
<div class="block">Returns the playback position in milliseconds.
</div>
</li>
</ul>
<a name="dispose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispose
</h4>
<pre>void
dispose()
</pre>
<div class="block">Needs to be called when the Music is no longer needed.
</div>
<dl>
<dt><strong>Specified by:
</strong></dt>
<dd><code><a href="../../../../com/badlogic/gdx/utils/Disposable.html#dispose()">dispose
</a></code> in interface
<code><a href="../../../../com/badlogic/gdx/utils/Disposable.html" title="interface in com.badlogic.gdx.utils">Disposable
</a></code></dd>
</dl>
</li>
</ul>
<a name="setOnCompletionListener(com.badlogic.gdx.audio.Music.OnCompletionListener)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setOnCompletionListener
</h4>
<pre>void
setOnCompletionListener(
<a href="../../../../com/badlogic/gdx/audio/Music.OnCompletionListener.html" title="interface in com.badlogic.gdx.audio">Music.OnCompletionListener
</a> listener)
</pre>
<div class="block">Register a callback to be invoked when the end of a music stream has been reached during playback.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>listener
</code> - the callback that will be run.
</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/Music.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../index-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>libgdx API
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/badlogic/gdx/audio/AudioRecorder.html" title="interface in com.badlogic.gdx.audio"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../com/badlogic/gdx/audio/Music.OnCompletionListener.html" title="interface in com.badlogic.gdx.audio"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/audio/Music.html" target="_top">Frames
</a></li>
<li><a href="Music.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li><a href="#nested_class_summary">Nested
</a> |
</li>
<li>Field
|
</li>
<li>Constr
|
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li>Constr
|
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
<div style="font-size:9pt"><i>
Copyright
© 2010-2013 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
</i></div>
</small></p>
</body>
</html>