<html> <head><title>ClanLib Reference: CL_StreamSoundProvider_Session</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_StreamSoundProvider_Session</h1><p> <b> Streamed soundprovider playback session</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <a href="CL_Streamed_MikModSample_Session.html">CL_Streamed_MikModSample_Session</a> <a href="CL_Streamed_RawSample_Session.html">CL_Streamed_RawSample_Session</a> <a href="CL_Streamed_WaveSample_Session.html">CL_Streamed_WaveSample_Session</a> <br>Group: Sound (Audio Mixing) <p> #include <ClanLib/sound.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_StreamSoundProvider_Session.html#1535"><tt><font color=blue><b>~CL_StreamSoundProvider_Session</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_StreamSoundProvider_Session.html#1536"><tt><font color=blue><b>eof</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_StreamSoundProvider_Session.html#1537"><tt><font color=blue><b>stop</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_StreamSoundProvider_Session.html#1538"><tt><font color=blue><b>play</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_StreamSoundProvider_Session.html#1539"><tt><font color=blue><b>set_position</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>pos</font></tt>)</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_StreamSoundProvider_Session.html#1540"><tt><font color=blue><b>get_data</b></font></tt></a></td><td><tt>(<tt><font color=purple>void</font></tt>* <tt><font color=blue>data_ptr</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>data_requested</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_StreamSoundProvider_Session.html#1541"><tt><font color=blue><b>get_frequency</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=navy>SoundFormat</font></tt></tt> </td><td align=right><a href="CL_StreamSoundProvider_Session.html#1542"><tt><font color=blue><b>get_format</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> Interface used by ClanLib during playback of streamed soundbuffers.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="1536"><font size=+1><b>CL_StreamSoundProvider_Session::eof</b></font></a> - Returns true if no more input data is available.<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_StreamSoundProvider_Session.html#1536"><tt><font color=blue><b>eof</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - True if end of input data. False otherwise.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1540"><font size=+1><b>CL_StreamSoundProvider_Session::get_data</b></font></a> - Called when a playback session needs more sample data.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_StreamSoundProvider_Session.html#1540"><tt><font color=blue><b>get_data</b></font></tt></a><tt>(<tt><font color=purple>void</font></tt>* <tt><font color=blue>data_ptr</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>data_requested</font></tt>)</tt>;<br><blockquote> data_ptr - Points to a buffer that should be filled with<br> sample data.<br> data_requested - Bytes of data requested.<br> Returns - Number of bytes actually filled with sample data.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1542"><font size=+1><b>CL_StreamSoundProvider_Session::get_format</b></font></a> - Returns the playback sample format.<br><tt><tt>virtual</tt> <tt><font color=navy>SoundFormat</font></tt></tt> <a href="CL_StreamSoundProvider_Session.html#1542"><tt><font color=blue><b>get_format</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - The playback Sample format.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1541"><font size=+1><b>CL_StreamSoundProvider_Session::get_frequency</b></font></a> - Returns the playback frequency of the input data.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_StreamSoundProvider_Session.html#1541"><tt><font color=blue><b>get_frequency</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Playback frequency.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1538"><font size=+1><b>CL_StreamSoundProvider_Session::play</b></font></a> - Start/continue playing of the stream.<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_StreamSoundProvider_Session.html#1538"><tt><font color=blue><b>play</b></font></tt></a><tt>()</tt>;<br><blockquote> Returns - True for success. False otherwise.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1539"><font size=+1><b>CL_StreamSoundProvider_Session::set_position</b></font></a> - Sets the position within the current stream.<br><tt><tt>virtual</tt> <tt><font color=purple>bool</font></tt></tt> <a href="CL_StreamSoundProvider_Session.html#1539"><tt><font color=blue><b>set_position</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>pos</font></tt>)</tt>;<br><blockquote> pos - Position to seek to.<br> Returns - True for success. False otherwise.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1537"><font size=+1><b>CL_StreamSoundProvider_Session::stop</b></font></a> - Stops the current stream.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_StreamSoundProvider_Session.html#1537"><tt><font color=blue><b>stop</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1535"><font size=+1><b>CL_StreamSoundProvider_Session::~CL_StreamSoundProvider_Session</b></font></a> - Stream Sound Provider Session Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_StreamSoundProvider_Session.html#1535"><tt><font color=blue><b>~CL_StreamSoundProvider_Session</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
554fa56029a60daf7aab25253fdab3d8
>
files
>
216
