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

<HTML>
<HEAD>

<TITLE>
OpenALStreamPlayer (Slick - The 2D Library)
</TITLE>

<META NAME="keywords" CONTENT="org.newdawn.slick.openal.OpenALStreamPlayer class">

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

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="OpenALStreamPlayer (Slick - The 2D Library)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

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



<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>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/OpenALStreamPlayer.html">Use</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>

</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;<A HREF="../../../../org/newdawn/slick/openal/OggInputStream.html" title="class in org.newdawn.slick.openal">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../../org/newdawn/slick/openal/SoundStore.html" title="class in org.newdawn.slick.openal">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../../index.html?org/newdawn/slick/openal/OpenALStreamPlayer.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="OpenALStreamPlayer.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>


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


<HR>

<H2>

org.newdawn.slick.openal
 
Class OpenALStreamPlayer</H2>
<PRE>
java.lang.Object
 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">org.newdawn.slick.openal.OpenALStreamPlayer
</PRE>
<HR>
<DL>
<DT><PRE>public class OpenALStreamPlayer<DT>extends java.lang.Object</DL>
</PRE>


A generic tool to work on a supplied stream, pulling out PCM data and buffered it to OpenAL
 as required.



<DL>
<DT>Author:</DT>
 <DD>Kevin Glass, Nathan Sweet <misc@n4te.com>, Rockstar play and setPosition cleanup</DD>
</DL>
<HR>




<A NAME="field_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Field Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;int</CODE></TD>
<TD><CODE><A HREF="../../../../org/newdawn/slick/openal/OpenALStreamPlayer.html#BUFFER_COUNT">BUFFER_COUNT</A></CODE>

 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of buffers to maintain</TD>
</TR>
</TABLE>
&nbsp;


<A NAME="constructor_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Constructor Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/newdawn/slick/openal/OpenALStreamPlayer.html#OpenALStreamPlayer(int, java.lang.String)">OpenALStreamPlayer</A>(int&nbsp;source,
 java.lang.String&nbsp;ref)</CODE>

 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new player to work on an audio stream</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/newdawn/slick/openal/OpenALStreamPlayer.html#OpenALStreamPlayer(int, java.net.URL)">OpenALStreamPlayer</A>(int&nbsp;source,
 java.net.URL&nbsp;url)</CODE>

 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new player to work on an audio stream</TD>
</TR>
</TABLE>
&nbsp;


<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>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../../org/newdawn/slick/openal/OpenALStreamPlayer.html#done()">done</A>()</CODE>

 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check if the playback is complete.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;float</CODE></TD>
<TD><CODE><A HREF="../../../../org/newdawn/slick/openal/OpenALStreamPlayer.html#getPosition()">getPosition</A>()</CODE>

 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the current playing position in the sound</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../../org/newdawn/slick/openal/OpenALStreamPlayer.html#getSource()">getSource</A>()</CODE>

 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the source of this stream</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../../org/newdawn/slick/openal/OpenALStreamPlayer.html#play(boolean)">play</A>(boolean&nbsp;loop)</CODE>

 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Start this stream playing</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../../org/newdawn/slick/openal/OpenALStreamPlayer.html#setPosition(float)">setPosition</A>(float&nbsp;position)</CODE>

 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Seeks to a position in the music.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../../org/newdawn/slick/openal/OpenALStreamPlayer.html#setup(float)">setup</A>(float&nbsp;pitch)</CODE>

 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Setup the playback properties</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../../org/newdawn/slick/openal/OpenALStreamPlayer.html#stream(int)">stream</A>(int&nbsp;bufferId)</CODE>

 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stream some data from the audio stream to the buffer indicates by the ID</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../../org/newdawn/slick/openal/OpenALStreamPlayer.html#update()">update</A>()</CODE>

 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Poll the bufferNames - check if we need to fill the bufferNames with another
 section.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left">Methods inherited from class java.lang.Object</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;




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

<A NAME="BUFFER_COUNT"></A><H3>
BUFFER_COUNT</H3>
<PRE>
public static final int BUFFER_COUNT</PRE>
<DL>
<DD>The number of buffers to maintain

<DL>
<DT>See Also:<DD><A HREF="../../../../constant-values.html#org.newdawn.slick.openal.OpenALStreamPlayer.BUFFER_COUNT">Constant Field Values</A></DL>
</DL>



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

<A NAME="OpenALStreamPlayer(int, java.lang.String)"></A><H3>
OpenALStreamPlayer</H3>
<PRE>
public OpenALStreamPlayer(int&nbsp;source,
 java.lang.String&nbsp;ref)</PRE>
<DL>
<DD>Create a new player to work on an audio stream

<DL>
<DT>Parameters:<DD><CODE>source</CODE> - The source on which we'll play the audio<DD><CODE>ref</CODE> - A reference to the audio file to stream</DL>
</DL>
<HR>

<A NAME="OpenALStreamPlayer(int, java.net.URL)"></A><H3>
OpenALStreamPlayer</H3>
<PRE>
public OpenALStreamPlayer(int&nbsp;source,
 java.net.URL&nbsp;url)</PRE>
<DL>
<DD>Create a new player to work on an audio stream

<DL>
<DT>Parameters:<DD><CODE>source</CODE> - The source on which we'll play the audio<DD><CODE>url</CODE> - A reference to the audio file to stream</DL>
</DL>



<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="getSource()"></A><H3>
getSource</H3>
<PRE>
public java.lang.String getSource()</PRE>
<DL>
<DD>Get the source of this stream

<DD><DL>

<DT>Returns:<DD>The name of the source of string</DL>
</DD>
</DL>
<HR>

<A NAME="play(boolean)"></A><H3>
play</H3>
<PRE>
public void play(boolean&nbsp;loop)
 throws java.io.IOException</PRE>
<DL>
<DD>Start this stream playing

<DD><DL>
<DT>Parameters:<DD><CODE>loop</CODE> - True if the stream should loop
<DT>Throws:
<DD><CODE>java.io.IOException</CODE> - Indicates a failure to read from the stream</DL>
</DD>
</DL>
<HR>

<A NAME="setup(float)"></A><H3>
setup</H3>
<PRE>
public void setup(float&nbsp;pitch)</PRE>
<DL>
<DD>Setup the playback properties

<DD><DL>
<DT>Parameters:<DD><CODE>pitch</CODE> - The pitch to play back at</DL>
</DD>
</DL>
<HR>

<A NAME="done()"></A><H3>
done</H3>
<PRE>
public boolean done()</PRE>
<DL>
<DD>Check if the playback is complete. Note this will never
 return true if we're looping

<DD><DL>

<DT>Returns:<DD>True if we're looping</DL>
</DD>
</DL>
<HR>

<A NAME="update()"></A><H3>
update</H3>
<PRE>
public void update()</PRE>
<DL>
<DD>Poll the bufferNames - check if we need to fill the bufferNames with another
 section. 
 
 Most of the time this should be reasonably quick

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

<A NAME="stream(int)"></A><H3>
stream</H3>
<PRE>
public boolean stream(int&nbsp;bufferId)</PRE>
<DL>
<DD>Stream some data from the audio stream to the buffer indicates by the ID

<DD><DL>
<DT>Parameters:<DD><CODE>bufferId</CODE> - The ID of the buffer to fill
<DT>Returns:<DD>True if another section was available</DL>
</DD>
</DL>
<HR>

<A NAME="setPosition(float)"></A><H3>
setPosition</H3>
<PRE>
public boolean setPosition(float&nbsp;position)</PRE>
<DL>
<DD>Seeks to a position in the music.

<DD><DL>
<DT>Parameters:<DD><CODE>position</CODE> - Position in seconds.
<DT>Returns:<DD>True if the setting of the position was successful</DL>
</DD>
</DL>
<HR>

<A NAME="getPosition()"></A><H3>
getPosition</H3>
<PRE>
public float getPosition()</PRE>
<DL>
<DD>Return the current playing position in the sound

<DD><DL>

<DT>Returns:<DD>The current position in seconds.</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>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/OpenALStreamPlayer.html">Use</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>

</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;<A HREF="../../../../org/newdawn/slick/openal/OggInputStream.html" title="class in org.newdawn.slick.openal">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../../org/newdawn/slick/openal/SoundStore.html" title="class in org.newdawn.slick.openal">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../../index.html?org/newdawn/slick/openal/OpenALStreamPlayer.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="OpenALStreamPlayer.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>


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


<HR>
Copyright &#169; 2006 New Dawn Software. All Rights Reserved.
</BODY>
</HTML>

Collaborative Calculation and Data Science

colby

sagemath

Product

Resources

Company