<!-- clanlib header begin -->
<HTML>
<HEAD>
<TITLE>CL_SoundProvider_Session - ClanLib Game SDK</TITLE>
<STYLE TYPE="text/css"><!--
HTML BODY
{
font-family: verdana, helvetica, sans-serif;
font-size: 12px;
}
H1 { font-size: 22px; }
H2 { font-size: 18px; }
H3 { font-size: 16px; }
H4 { font-size: 14px; }
P { font-size: 12px; }
LI { font-size: 12px; }
--></STYLE>
</HEAD>
<body bgcolor=white text=black link=blue vlink=#800080>
<center>
<img src="http://clanlib.org/gfx/clanlib.png">
</center>
<!-- clanlib header end -->
<center>
<p>
<a href="http://clanlib.org/docs.html">Home</a> |
<a href="classes.html">All Classes</a> |
<a href="modules.html">Grouped Classes</a> |
<a href="index.html">Index</a> |
<a href="search.html">Search</a>
</p>
</center>
<h1>Class CL_SoundProvider_Session</h1>
<p> Sound provider playback session. <a href="#description">More...</a></p>
<p>Derived from:
<i>none</i>
<br>
Derived by:
<i>none</i>
<br>Group: Sound (Audio Mixing)</p>
<p>
#include <ClanLib/sound.h>
<p>
<table border=0 width=100%>
</table>
<p><b>Construction:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_SoundProvider_Session__CL_SoundProvider_Session.html">CL_SoundProvider_Session</a></p></td><td valign=top><p></p></td></tr></table>
<p><b>Attributes:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_SoundProvider_Session__get_num_samples.html">get_num_samples</a></p></td><td valign=top><p> Returns the number of samples in the soundbuffer.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundProvider_Session__get_frequency.html">get_frequency</a></p></td><td valign=top><p> Returns the playback frequency of the input data.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundProvider_Session__get_position.html">get_position</a></p></td><td valign=top><p> Returns the current position in the playback stream.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundProvider_Session__get_format.html">get_format</a></p></td><td valign=top><p> Returns the playback sample format.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundProvider_Session__get_num_channels.html">get_num_channels</a></p></td><td valign=top><p> Returns the number of channels filled when get_data is called.</p></td></tr></table>
<p><b>Operations:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_SoundProvider_Session__set_looping.html">set_looping</a></p></td><td valign=top><p> Enable/disable session looping.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundProvider_Session__eof.html">eof</a></p></td><td valign=top><p> Returns true if no more input data is available.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundProvider_Session__stop.html">stop</a></p></td><td valign=top><p> Stops the current stream.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundProvider_Session__play.html">play</a></p></td><td valign=top><p> Start/continue playing of the stream.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundProvider_Session__set_position.html">set_position</a></p></td><td valign=top><p> Sets the position within the current stream.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundProvider_Session__get_data.html">get_data</a></p></td><td valign=top><p> Called when a playback session needs more sample data.</p></td></tr></table>
<a name="#description"><p><b>Detailed description:</b></p>
!group=Sound/Audio Mixing!
!header=sound.h!
<p>Interface used by ClanLib during playback of sound providers.</p>
<!-- clanlib footer begin -->
<center><br><br><font color="#a0a0a0">
Questions or comments, write to the <a href="http://clanlib.org/contact.html">ClanLib mailing list</a>.
</font></center>
</body>
</html>
<!-- clanlib footer end -->
