<!-- clanlib header begin -->
<HTML>
<HEAD>
<TITLE>CL_SoundBuffer - 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_SoundBuffer</h1>
<p> Sample interface in ClanLib. <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_SoundBuffer__CL_SoundBuffer.html">CL_SoundBuffer</a></p></td><td valign=top><p> Construct sound buffer.</p></td></tr></table>
<p><b>Attributes:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_SoundBuffer__get_sound_provider.html">get_sound_provider</a></p></td><td valign=top><p> Returns the sound provider to be used for playback.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundBuffer__get_volume.html">get_volume</a></p></td><td valign=top><p> Returns the start/default volume used when the buffer is played.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundBuffer__get_pan.html">get_pan</a></p></td><td valign=top><p> Returns the default panning position when the buffer is played.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundBuffer__is_playing.html">is_playing</a></p></td><td valign=top><p> Returns true if an instance of this soundbuffer is playing</p></td></tr></table>
<p><b>Operations:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_SoundBuffer__operator =.html">operator =</a></p></td><td valign=top><p> Copy assignment operator.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundBuffer__set_volume.html">set_volume</a></p></td><td valign=top><p> Sets the volume of the sound buffer in a relative measure (0->1)</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundBuffer__set_pan.html">set_pan</a></p></td><td valign=top><p> Sets the panning of the sound buffer played in measures from -1 -> 1</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundBuffer__add_filter.html">add_filter</a></p></td><td valign=top><p> Adds the sound filter to the sound buffer.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundBuffer__remove_filter.html">remove_filter</a></p></td><td valign=top><p> Remove the sound filter from the sound buffer.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundBuffer__stop.html">stop</a></p></td><td valign=top><p> Stops any sessions playing this soundbuffer</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundBuffer__play.html">play</a></p></td><td valign=top><p> Plays the soundbuffer on the specified soundcard.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SoundBuffer__prepare.html">prepare</a></p></td><td valign=top><p> Prepares the soundbuffer for playback on the specified soundcard.</p></td></tr></table>
<a name="#description"><p><b>Detailed description:</b></p>
!group=Sound/Audio Mixing!
!header=sound.h!
<p>The CL_SoundBuffer class represents a sample in ClanLib. It can
either be static or streamed. The soundbuffer gets its sample data from
a soundprovider, that is passed during construction.</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 -->
