WebSVN - AndroidProjects - Rev 307 - /libgdx-0.9.4/docs/api/com/badlogic/gdx/audio/Music.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
Music (libgdx API)
</TITLE>

<META NAME="date" CONTENT="2012-06-03">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Music (libgdx API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">
<HR>


<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html">Overview</A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  Class </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Music.html">Use</A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html">Help</A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>

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>

</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../../com/badlogic/gdx/audio/AudioRecorder.html" title="interface in com.badlogic.gdx.audio">PREV CLASS</A> 
 <A HREF="../../../../com/badlogic/gdx/audio/Sound.html" title="interface in com.badlogic.gdx.audio">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
<A HREF="../../../../index.html?com/badlogic/gdx/audio/Music.html" target="_top">FRAMES</A>  
 <A HREF="Music.html" target="_top">NO FRAMES</A>  
 <SCRIPT type="text/javascript">

</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>


<HR>

<H2>

com.badlogic.gdx.audio
 
Interface Music</H2>
<DL>
<DT>All Superinterfaces: <DD><A HREF="../../../../com/badlogic/gdx/utils/Disposable.html" title="interface in com.badlogic.gdx.utils">Disposable</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface Music<DT>extends <A HREF="../../../../com/badlogic/gdx/utils/Disposable.html" title="interface in com.badlogic.gdx.utils">Disposable</A></DL>
</PRE>



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.



Music instances are created via <A HREF="../../../../com/badlogic/gdx/Audio.html#newMusic(com.badlogic.gdx.files.FileHandle)"><CODE>Audio.newMusic(FileHandle)</CODE></A>.



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>.




<DL>
<DT>Author:</DT>
<DD>mzechner</DD>
</DL>
<HR>





<A NAME="method_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Method Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> void</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Music.html#dispose()">dispose</A>()</CODE>

 
          Needs to be called when the Music is no longer needed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> float</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Music.html#getPosition()">getPosition</A>()</CODE>

 
          Returns the playback position in milliseconds.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> boolean</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Music.html#isLooping()">isLooping</A>()</CODE>

 
           </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> boolean</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Music.html#isPlaying()">isPlaying</A>()</CODE>

 
           </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> void</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Music.html#pause()">pause</A>()</CODE>

 
          Pauses the play back.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> void</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Music.html#play()">play</A>()</CODE>

 
          Starts the play back of the music stream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> void</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Music.html#setLooping(boolean)">setLooping</A>(boolean isLooping)</CODE>

 
          Sets whether the music stream is looping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> void</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Music.html#setVolume(float)">setVolume</A>(float volume)</CODE>

 
          Sets the volume of this music stream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> void</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Music.html#stop()">stop</A>()</CODE>

 
          Stops a playing or paused Music instance.</TD>
</TR>
</TABLE>
 




<A NAME="method_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Method Detail</TH>
</TR>
</TABLE>

<A NAME="play()"></A><H3>
play</H3>
<PRE>
void play()</PRE>
<DL>
<DD>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.

<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="pause()"></A><H3>
pause</H3>
<PRE>
void pause()</PRE>
<DL>
<DD>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.

<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="stop()"></A><H3>
stop</H3>
<PRE>
void stop()</PRE>
<DL>
<DD>Stops a playing or paused Music instance. Next time play() is invoked the Music will start from the beginning.

<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isPlaying()"></A><H3>
isPlaying</H3>
<PRE>
boolean isPlaying()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>whether this music stream is playing</DL>
</DD>
</DL>
<HR>

<A NAME="setLooping(boolean)"></A><H3>
setLooping</H3>
<PRE>
void setLooping(boolean isLooping)</PRE>
<DL>
<DD>Sets whether the music stream is looping. This can be called at any time, whether the stream is playing.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>isLooping</CODE> - whether to loop the stream</DL>
</DD>
</DL>
<HR>

<A NAME="isLooping()"></A><H3>
isLooping</H3>
<PRE>
boolean isLooping()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>whether the music stream is playing.</DL>
</DD>
</DL>
<HR>

<A NAME="setVolume(float)"></A><H3>
setVolume</H3>
<PRE>
void setVolume(float volume)</PRE>
<DL>
<DD>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.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>volume</CODE> - </DL>
</DD>
</DL>
<HR>

<A NAME="getPosition()"></A><H3>
getPosition</H3>
<PRE>
float getPosition()</PRE>
<DL>
<DD>Returns the playback position in milliseconds.

<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="dispose()"></A><H3>
dispose</H3>
<PRE>
void dispose()</PRE>
<DL>
<DD>Needs to be called when the Music is no longer needed.

<DD><DL>
<DT>Specified by:<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></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>

<HR>


<A NAME="navbar_bottom"></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html">Overview</A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  Class </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Music.html">Use</A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html">Help</A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
libgdx API
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../../com/badlogic/gdx/audio/AudioRecorder.html" title="interface in com.badlogic.gdx.audio">PREV CLASS</A> 
 <A HREF="../../../../com/badlogic/gdx/audio/Sound.html" title="interface in com.badlogic.gdx.audio">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
<A HREF="../../../../index.html?com/badlogic/gdx/audio/Music.html" target="_top">FRAMES</A>  
 <A HREF="Music.html" target="_top">NO FRAMES</A>  
 <SCRIPT type="text/javascript">

</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>


<HR>

<div style="font-size:9pt">
Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
</div>

</BODY>
</HTML>

Subversion Repositories AndroidProjects

(root)/libgdx-0.9.4/docs/api/com/badlogic/gdx/audio/Music.html - Rev 307