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

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

<HTML>
<HEAD>

<TITLE>
Sound (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="Sound (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/Sound.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/Music.html" title="interface in com.badlogic.gdx.audio">PREV CLASS</A> 
 NEXT CLASS</TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
<A HREF="../../../../index.html?com/badlogic/gdx/audio/Sound.html" target="_top">FRAMES</A>  
 <A HREF="Sound.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 Sound</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 Sound<DT>extends <A HREF="../../../../com/badlogic/gdx/utils/Disposable.html" title="interface in com.badlogic.gdx.utils">Disposable</A></DL>
</PRE>



A Sound is a short audio clip that can be played numerous times in parallel. It's completely loaded into memory so only load
small audio files. Call the <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#dispose()"><CODE>dispose()</CODE></A> method when you're done using the Sound.



Sound instances are created via a call to <A HREF="../../../../com/badlogic/gdx/Audio.html#newSound(com.badlogic.gdx.files.FileHandle)"><CODE>Audio.newSound(FileHandle)</CODE></A>.



Calling the <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play()"><CODE>play()</CODE></A> or <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play(float)"><CODE>play(float)</CODE></A> method will return a long which is an id to that instance of the sound. You
can use this id to modify the playback of that sound instance.




<DL>
<DT>Author:</DT>
<DD>badlogicgames@gmail.com</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/Sound.html#dispose()">dispose</A>()</CODE>

 
          Releases all the resources.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> long</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Sound.html#loop()">loop</A>()</CODE>

 
          Plays the sound, looping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> long</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Sound.html#loop(float)">loop</A>(float volume)</CODE>

 
          Plays the sound, looping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> long</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Sound.html#loop(float, float, float)">loop</A>(float volume,
float pitch,
float pan)</CODE>

 
          Plays the sound, looping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> long</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play()">play</A>()</CODE>

 
          Plays the sound.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> long</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play(float)">play</A>(float volume)</CODE>

 
          Plays the sound.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> long</CODE></TD>
<TD><CODE><A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play(float, float, float)">play</A>(float volume,
float pitch,
float pan)</CODE>

 
          Plays the sound.</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/Sound.html#setLooping(long, boolean)">setLooping</A>(long soundId,
boolean looping)</CODE>

 
          Sets the sound instance with the given id to be 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/Sound.html#setPan(long, float, float)">setPan</A>(long soundId,
float pan,
float volume)</CODE>

 
          Sets the panning and volume of the sound instance with the given id as returned by <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play()"><CODE>play()</CODE></A> or <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play(float)"><CODE>play(float)</CODE></A>.</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/Sound.html#setPitch(long, float)">setPitch</A>(long soundId,
float pitch)</CODE>

 
          Changes the pitch multiplier of the sound instance with the given id as returned by <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play()"><CODE>play()</CODE></A> or <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play(float)"><CODE>play(float)</CODE></A>.</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/Sound.html#setVolume(long, float)">setVolume</A>(long soundId,
float volume)</CODE>

 
          Changes the volume of the sound instance with the given id as returned by <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play()"><CODE>play()</CODE></A> or <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play(float)"><CODE>play(float)</CODE></A>.</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/Sound.html#stop()">stop</A>()</CODE>

 
          Stops playing all instances of this sound.</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/Sound.html#stop(long)">stop</A>(long soundId)</CODE>

 
          Stops the sound instance with the given id as returned by <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play()"><CODE>play()</CODE></A> or <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play(float)"><CODE>play(float)</CODE></A>.</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>
long play()</PRE>
<DL>
<DD>Plays the sound. If the sound is already playing, it will be played again, concurrently.

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

<DT>Returns:<DD>the id of the sound instance.</DL>
</DD>
</DL>
<HR>

<A NAME="play(float)"></A><H3>
play</H3>
<PRE>
long play(float volume)</PRE>
<DL>
<DD>Plays the sound. If the sound is already playing, it will be played again, concurrently.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>volume</CODE> - the volume in the range [0,1]
<DT>Returns:<DD>the id of the sound instance</DL>
</DD>
</DL>
<HR>

<A NAME="play(float, float, float)"></A><H3>
play</H3>
<PRE>
long play(float volume,
float pitch,
float pan)</PRE>
<DL>
<DD>Plays the sound. If the sound is already playing, it will be played again, concurrently.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>volume</CODE> - the volume in the range [0,1]<DD><CODE>pitch</CODE> - the pitch multiplier, 1 == default, >1 == faster, <1 == slower, the value has to be between 0.5 and 2.0<DD><CODE>pan</CODE> - panning in the range -1 (full right) to 1 (full left). 0 is center position.
<DT>Returns:<DD>the id of the sound instance</DL>
</DD>
</DL>
<HR>

<A NAME="loop()"></A><H3>
loop</H3>
<PRE>
long loop()</PRE>
<DL>
<DD>Plays the sound, looping. If the sound is already playing, it will be played again, concurrently.

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

<DT>Returns:<DD>the id of the sound instance</DL>
</DD>
</DL>
<HR>

<A NAME="loop(float)"></A><H3>
loop</H3>
<PRE>
long loop(float volume)</PRE>
<DL>
<DD>Plays the sound, looping. If the sound is already playing, it will be played again, concurrently. You need
to stop the sound via a call to <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#stop(long)"><CODE>stop(long)</CODE></A> using the returned id.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>volume</CODE> - the volume in the range [0, 1]
<DT>Returns:<DD>the id of the sound instance</DL>
</DD>
</DL>
<HR>

<A NAME="loop(float, float, float)"></A><H3>
loop</H3>
<PRE>
long loop(float volume,
float pitch,
float pan)</PRE>
<DL>
<DD>Plays the sound, looping. If the sound is already playing, it will be played again, concurrently. You need
to stop the sound via a call to <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#stop(long)"><CODE>stop(long)</CODE></A> using the returned id.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>volume</CODE> - the volume in the range [0,1]<DD><CODE>pitch</CODE> - the pitch multiplier, 1 == default, >1 == faster, <1 == slower, the value has to be between 0.5 and 2.0<DD><CODE>pan</CODE> - panning in the range -1 (full right) to 1 (full left). 0 is center position.
<DT>Returns:<DD>the id of the sound instance</DL>
</DD>
</DL>
<HR>

<A NAME="stop()"></A><H3>
stop</H3>
<PRE>
void stop()</PRE>
<DL>
<DD>Stops playing all instances of this sound.

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

<A NAME="dispose()"></A><H3>
dispose</H3>
<PRE>
void dispose()</PRE>
<DL>
<DD>Releases all the resources.

<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="stop(long)"></A><H3>
stop</H3>
<PRE>
void stop(long soundId)</PRE>
<DL>
<DD>Stops the sound instance with the given id as returned by <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play()"><CODE>play()</CODE></A> or <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play(float)"><CODE>play(float)</CODE></A>. If the sound is no longer
playing, this has no effect.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>soundId</CODE> - the sound id</DL>
</DD>
</DL>
<HR>

<A NAME="setLooping(long, boolean)"></A><H3>
setLooping</H3>
<PRE>
void setLooping(long soundId,
boolean looping)</PRE>
<DL>
<DD>Sets the sound instance with the given id to be looping. If the sound is no longer playing this has no effect.s

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>soundId</CODE> - the sound id<DD><CODE>looping</CODE> - whether to loop or not.</DL>
</DD>
</DL>
<HR>

<A NAME="setPitch(long, float)"></A><H3>
setPitch</H3>
<PRE>
void setPitch(long soundId,
float pitch)</PRE>
<DL>
<DD>Changes the pitch multiplier of the sound instance with the given id as returned by <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play()"><CODE>play()</CODE></A> or <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play(float)"><CODE>play(float)</CODE></A>.
If the sound is no longer playing, this has no effect.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>soundId</CODE> - the sound id<DD><CODE>pitch</CODE> - the pitch multiplier, 1 == default, >1 == faster, <1 == slower, the value has to be between 0.5 and 2.0</DL>
</DD>
</DL>
<HR>

<A NAME="setVolume(long, float)"></A><H3>
setVolume</H3>
<PRE>
void setVolume(long soundId,
float volume)</PRE>
<DL>
<DD>Changes the volume of the sound instance with the given id as returned by <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play()"><CODE>play()</CODE></A> or <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play(float)"><CODE>play(float)</CODE></A>. If the
sound is no longer playing, this has no effect.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>soundId</CODE> - the sound id<DD><CODE>volume</CODE> - the volume in the range 0 (silent) to 1 (max volume).</DL>
</DD>
</DL>
<HR>

<A NAME="setPan(long, float, float)"></A><H3>
setPan</H3>
<PRE>
void setPan(long soundId,
float pan,
float volume)</PRE>
<DL>
<DD>Sets the panning and volume of the sound instance with the given id as returned by <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play()"><CODE>play()</CODE></A> or <A HREF="../../../../com/badlogic/gdx/audio/Sound.html#play(float)"><CODE>play(float)</CODE></A>.
If the sound is no longer playing, this has no effect.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>soundId</CODE> - the sound id<DD><CODE>pan</CODE> - panning in the range -1 (full right) to 1 (full left). 0 is center position.<DD><CODE>volume</CODE> - the volume in the range [0,1].</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/Sound.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/Music.html" title="interface in com.badlogic.gdx.audio">PREV CLASS</A> 
 NEXT CLASS</TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
<A HREF="../../../../index.html?com/badlogic/gdx/audio/Sound.html" target="_top">FRAMES</A>  
 <A HREF="Sound.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/Sound.html - Rev 307