WebSVN - AndroidProjects - Rev 195 - /libgdx-0.9.2/docs/api/com/badlogic/gdx/audio/io/Decoder.html

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

<HTML>
<HEAD>

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

<META NAME="date" CONTENT="2011-09-18">

<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="Decoder (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/Decoder.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">
 PREV CLASS 
 <A HREF="../../../../../com/badlogic/gdx/audio/io/Mpg123Decoder.html" title="class in com.badlogic.gdx.audio.io">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
<A HREF="../../../../../index.html?com/badlogic/gdx/audio/io/Decoder.html" target="_top">FRAMES</A>  
 <A HREF="Decoder.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.io
 
Interface Decoder</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>
<DL>
<DT>All Known Implementing Classes: <DD><A HREF="../../../../../com/badlogic/gdx/audio/io/Mpg123Decoder.html" title="class in com.badlogic.gdx.audio.io">Mpg123Decoder</A>, <A HREF="../../../../../com/badlogic/gdx/audio/io/VorbisDecoder.html" title="class in com.badlogic.gdx.audio.io">VorbisDecoder</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface Decoder<DT>extends <A HREF="../../../../../com/badlogic/gdx/utils/Disposable.html" title="interface in com.badlogic.gdx.utils">Disposable</A></DL>
</PRE>


Interface for audio decoders that return successive amplitude frames. When a decoder is no longer used it has to be disposed.



<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/io/Decoder.html#dispose()">dispose</A>()</CODE>

 
          Disposes the decoder and frees all associated resources</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/io/Decoder.html#getLength()">getLength</A>()</CODE>

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

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

 
           </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> int</CODE></TD>
<TD><CODE><A HREF="../../../../../com/badlogic/gdx/audio/io/Decoder.html#readSamples(java.nio.ShortBuffer)">readSamples</A>(java.nio.ShortBuffer samples)</CODE>

 
          Reads in samples.capacity() samples in 16-bit signed PCM format from the decoder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE> int</CODE></TD>
<TD><CODE><A HREF="../../../../../com/badlogic/gdx/audio/io/Decoder.html#skipSamples(int)">skipSamples</A>(int numSamples)</CODE>

 
          Skips numSamples samples.</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="readSamples(java.nio.ShortBuffer)"></A><H3>
readSamples</H3>
<PRE>
int readSamples(java.nio.ShortBuffer samples)</PRE>
<DL>
<DD>Reads in samples.capacity() samples in 16-bit signed PCM format from the decoder. Returns the actual number read in. If this
number is smaller than the capacity of the buffer then the end of stream has been reached. The provided ShortBuffer must be
a direct buffer.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>samples</CODE> - The number of read samples.</DL>
</DD>
</DL>
<HR>

<A NAME="skipSamples(int)"></A><H3>
skipSamples</H3>
<PRE>
int skipSamples(int numSamples)</PRE>
<DL>
<DD>Skips numSamples samples. If the decoded file is in stereo the left and right channel samples are counted as 2 samples.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>numSamples</CODE> - the number of samples to skip
<DT>Returns:<DD>the number of samples actually skipped. If this is < numSamples then the end of the file has been reached.</DL>
</DD>
</DL>
<HR>

<A NAME="getNumChannels()"></A><H3>
getNumChannels</H3>
<PRE>
int getNumChannels()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>the number of channels</DL>
</DD>
</DL>
<HR>

<A NAME="getRate()"></A><H3>
getRate</H3>
<PRE>
int getRate()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>the sampling rate in herz, e.g. 44100</DL>
</DD>
</DL>
<HR>

<A NAME="getLength()"></A><H3>
getLength</H3>
<PRE>
float getLength()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT>Returns:<DD>the length of the file in seconds</DL>
</DD>
</DL>
<HR>

<A NAME="dispose()"></A><H3>
dispose</H3>
<PRE>
void dispose()</PRE>
<DL>
<DD>Disposes the decoder and frees all associated 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="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/Decoder.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">
 PREV CLASS 
 <A HREF="../../../../../com/badlogic/gdx/audio/io/Mpg123Decoder.html" title="class in com.badlogic.gdx.audio.io">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
<A HREF="../../../../../index.html?com/badlogic/gdx/audio/io/Decoder.html" target="_top">FRAMES</A>  
 <A HREF="Decoder.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.2/docs/api/com/badlogic/gdx/audio/io/Decoder.html @ 500 - Rev 195