WebSVN - AndroidProjects - Rev 356 - /libgdx-0.9.8/docs/api/com/badlogic/gdx/Audio.html

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

<HTML>
<HEAD>

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

<META NAME="date" CONTENT="2013-01-27">

<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="Audio (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/Audio.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/ApplicationListener.html" title="interface in com.badlogic.gdx">PREV CLASS</A> 
 <A HREF="../../../com/badlogic/gdx/Files.html" title="interface in com.badlogic.gdx">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
<A HREF="../../../index.html?com/badlogic/gdx/Audio.html" target="_top">FRAMES</A>  
 <A HREF="Audio.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
 
Interface Audio</H2>
<HR>
<DL>
<DT><PRE>public interface Audio</DL>
</PRE>


This interface encapsulates the creation and management of audio resources. It allows you to get direct access to the audio
hardware via the <A HREF="../../../com/badlogic/gdx/audio/AudioDevice.html" title="interface in com.badlogic.gdx.audio"><CODE>AudioDevice</CODE></A> and <A HREF="../../../com/badlogic/gdx/audio/AudioRecorder.html" title="interface in com.badlogic.gdx.audio"><CODE>AudioRecorder</CODE></A> interfaces, create sound effects via the <A HREF="../../../com/badlogic/gdx/audio/Sound.html" title="interface in com.badlogic.gdx.audio"><CODE>Sound</CODE></A> interface
and play music streams via the <A HREF="../../../com/badlogic/gdx/audio/Music.html" title="interface in com.badlogic.gdx.audio"><CODE>Music</CODE></A> interface.


All resources created via this interface have to be disposed as soon as they are no longer used.



Note that all <A HREF="../../../com/badlogic/gdx/audio/Music.html" title="interface in com.badlogic.gdx.audio"><CODE>Music</CODE></A> instances will be automatically paused when the <A HREF="../../../com/badlogic/gdx/ApplicationListener.html#pause()"><CODE>ApplicationListener.pause()</CODE></A> method is
called, and automatically resumed when the <A HREF="../../../com/badlogic/gdx/ApplicationListener.html#resume()"><CODE>ApplicationListener.resume()</CODE></A> method is called.




<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> <A HREF="../../../com/badlogic/gdx/audio/AudioDevice.html" title="interface in com.badlogic.gdx.audio">AudioDevice</A></CODE></TD>
<TD><CODE><A HREF="../../../com/badlogic/gdx/Audio.html#newAudioDevice(int, boolean)">newAudioDevice</A>(int samplingRate,
boolean isMono)</CODE>

 
          Creates a new <A HREF="../../../com/badlogic/gdx/audio/AudioDevice.html" title="interface in com.badlogic.gdx.audio"><CODE>AudioDevice</CODE></A> either in mono or stereo mode.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> <A HREF="../../../com/badlogic/gdx/audio/AudioRecorder.html" title="interface in com.badlogic.gdx.audio">AudioRecorder</A></CODE></TD>
<TD><CODE><A HREF="../../../com/badlogic/gdx/Audio.html#newAudioRecorder(int, boolean)">newAudioRecorder</A>(int samplingRate,
boolean isMono)</CODE>

 
          Creates a new <A HREF="../../../com/badlogic/gdx/audio/AudioRecorder.html" title="interface in com.badlogic.gdx.audio"><CODE>AudioRecorder</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> <A HREF="../../../com/badlogic/gdx/audio/Music.html" title="interface in com.badlogic.gdx.audio">Music</A></CODE></TD>
<TD><CODE><A HREF="../../../com/badlogic/gdx/Audio.html#newMusic(com.badlogic.gdx.files.FileHandle)">newMusic</A>(<A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</A> file)</CODE>

 
          Creates a new <A HREF="../../../com/badlogic/gdx/audio/Music.html" title="interface in com.badlogic.gdx.audio"><CODE>Music</CODE></A> instance which is used to play back a music stream from a file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> <A HREF="../../../com/badlogic/gdx/audio/Sound.html" title="interface in com.badlogic.gdx.audio">Sound</A></CODE></TD>
<TD><CODE><A HREF="../../../com/badlogic/gdx/Audio.html#newSound(com.badlogic.gdx.files.FileHandle)">newSound</A>(<A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</A> fileHandle)</CODE>

 
          
Creates a new <A HREF="../../../com/badlogic/gdx/audio/Sound.html" title="interface in com.badlogic.gdx.audio"><CODE>Sound</CODE></A> which is used to play back audio effects such as gun shots or explosions.</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="newAudioDevice(int, boolean)"></A><H3>
newAudioDevice</H3>
<PRE>
<A HREF="../../../com/badlogic/gdx/audio/AudioDevice.html" title="interface in com.badlogic.gdx.audio">AudioDevice</A> newAudioDevice(int samplingRate,
boolean isMono)</PRE>
<DL>
<DD>Creates a new <A HREF="../../../com/badlogic/gdx/audio/AudioDevice.html" title="interface in com.badlogic.gdx.audio"><CODE>AudioDevice</CODE></A> either in mono or stereo mode. The AudioDevice has to be disposed via its
<A HREF="../../../com/badlogic/gdx/audio/AudioDevice.html#dispose()"><CODE>AudioDevice.dispose()</CODE></A> method when it is no longer used.

<DD><DL>
<DT>Parameters:<DD><CODE>samplingRate</CODE> - the sampling rate.<DD><CODE>isMono</CODE> - whether the AudioDevice should be in mono or stereo mode
<DT>Returns:<DD>the AudioDevice
<DT>Throws:
<DD><CODE><A HREF="../../../com/badlogic/gdx/utils/GdxRuntimeException.html" title="class in com.badlogic.gdx.utils">GdxRuntimeException</A></CODE> - in case the device could not be created</DL>
</DD>
</DL>
<HR>

<A NAME="newAudioRecorder(int, boolean)"></A><H3>
newAudioRecorder</H3>
<PRE>
<A HREF="../../../com/badlogic/gdx/audio/AudioRecorder.html" title="interface in com.badlogic.gdx.audio">AudioRecorder</A> newAudioRecorder(int samplingRate,
boolean isMono)</PRE>
<DL>
<DD>Creates a new <A HREF="../../../com/badlogic/gdx/audio/AudioRecorder.html" title="interface in com.badlogic.gdx.audio"><CODE>AudioRecorder</CODE></A>. The AudioRecorder has to be disposed after it is no longer used.

<DD><DL>
<DT>Parameters:<DD><CODE>samplingRate</CODE> - the sampling rate in Herz<DD><CODE>isMono</CODE> - whether the recorder records in mono or stereo
<DT>Returns:<DD>the AudioRecorder
<DT>Throws:
<DD><CODE><A HREF="../../../com/badlogic/gdx/utils/GdxRuntimeException.html" title="class in com.badlogic.gdx.utils">GdxRuntimeException</A></CODE> - in case the recorder could not be created</DL>
</DD>
</DL>
<HR>

<A NAME="newSound(com.badlogic.gdx.files.FileHandle)"></A><H3>
newSound</H3>
<PRE>
<A HREF="../../../com/badlogic/gdx/audio/Sound.html" title="interface in com.badlogic.gdx.audio">Sound</A> newSound(<A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</A> fileHandle)</PRE>
<DL>
<DD>
Creates a new <A HREF="../../../com/badlogic/gdx/audio/Sound.html" title="interface in com.badlogic.gdx.audio"><CODE>Sound</CODE></A> which is used to play back audio effects such as gun shots or explosions. The Sound's audio data
is retrieved from the file specified via the <A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files"><CODE>FileHandle</CODE></A>. Note that the complete audio data is loaded into RAM. You
should therefore not load big audio files with this methods. The current upper limit for decoded audio is 1 MB.



Currently supported formats are WAV, MP3 and OGG.



The Sound has to be disposed if it is no longer used via the <A HREF="../../../com/badlogic/gdx/audio/Sound.html#dispose()"><CODE>Sound.dispose()</CODE></A> method.


<DD><DL>

<DT>Returns:<DD>the new Sound
<DT>Throws:
<DD><CODE><A HREF="../../../com/badlogic/gdx/utils/GdxRuntimeException.html" title="class in com.badlogic.gdx.utils">GdxRuntimeException</A></CODE> - in case the sound could not be loaded</DL>
</DD>
</DL>
<HR>

<A NAME="newMusic(com.badlogic.gdx.files.FileHandle)"></A><H3>
newMusic</H3>
<PRE>
<A HREF="../../../com/badlogic/gdx/audio/Music.html" title="interface in com.badlogic.gdx.audio">Music</A> newMusic(<A HREF="../../../com/badlogic/gdx/files/FileHandle.html" title="class in com.badlogic.gdx.files">FileHandle</A> file)</PRE>
<DL>
<DD>Creates a new <A HREF="../../../com/badlogic/gdx/audio/Music.html" title="interface in com.badlogic.gdx.audio"><CODE>Music</CODE></A> instance which is used to play back a music stream from a file. Currently supported formats are
WAV, MP3 and OGG. The Music instance has to be disposed if it is no longer used via the <A HREF="../../../com/badlogic/gdx/audio/Music.html#dispose()"><CODE>Music.dispose()</CODE></A> method.
Music instances are automatically paused when <A HREF="../../../com/badlogic/gdx/ApplicationListener.html#pause()"><CODE>ApplicationListener.pause()</CODE></A> is called and resumed when
<A HREF="../../../com/badlogic/gdx/ApplicationListener.html#resume()"><CODE>ApplicationListener.resume()</CODE></A> is called.

<DD><DL>
<DT>Parameters:<DD><CODE>file</CODE> - the FileHandle
<DT>Returns:<DD>the new Music or null if the Music could not be loaded
<DT>Throws:
<DD><CODE><A HREF="../../../com/badlogic/gdx/utils/GdxRuntimeException.html" title="class in com.badlogic.gdx.utils">GdxRuntimeException</A></CODE> - in case the music could not be loaded</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/Audio.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/ApplicationListener.html" title="interface in com.badlogic.gdx">PREV CLASS</A> 
 <A HREF="../../../com/badlogic/gdx/Files.html" title="interface in com.badlogic.gdx">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
<A HREF="../../../index.html?com/badlogic/gdx/Audio.html" target="_top">FRAMES</A>  
 <A HREF="Audio.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.8/docs/api/com/badlogic/gdx/Audio.html - Rev 356