<html> <head><title>ClanLib Reference: CL_SoundBuffer_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_SoundBuffer_Session</h1><p> <b> CL_SoundBuffer_Session provides control over a playing soundeffect.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <i>none</i> <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> </td><td align=right><a href="CL_SoundBuffer_Session.html#195"><tt><font color=blue><b>CL_SoundBuffer_Session</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#196"><tt><font color=blue><b>CL_SoundBuffer_Session</b></font></tt></a></td><td><tt>(<tt><font color=purple>void</font></tt>* <tt><font color=blue>handle</font></tt>, <a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>* <tt><font color=blue>_card</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#197"><tt><font color=blue><b>CL_SoundBuffer_Session</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_SoundBuffer_Session.html#197"><tt><font color=blue><b>CL_SoundBuffer_Session</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#198"><tt><font color=blue><b>~CL_SoundBuffer_Session</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Operators:</h3></td> <tr valign=top><td align=right><tt><a href="CL_SoundBuffer_Session.html#197"><tt><font color=blue><b>CL_SoundBuffer_Session</b></font></tt></a>&</tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#199"><tt><font color=black><b>operator</b></font></tt><tt> =</tt></a></td><td><tt>(<tt>const</tt> <a href="CL_SoundBuffer_Session.html#197"><tt><font color=blue><b>CL_SoundBuffer_Session</b></font></tt></a>& <tt><font color=blue>session</font></tt>)</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt>*</tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#200"><tt><font color=blue><b>get_handle</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>*</tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#201"><tt><font color=blue><b>get_card</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#202"><tt><font color=blue><b>get_position</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>float</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#203"><tt><font color=blue><b>get_position_relative</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#204"><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>new_pos</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#205"><tt><font color=blue><b>set_position_relative</b></font></tt></a></td><td><tt>(<tt><font color=purple>float</font></tt> <tt><font color=blue>new_pos</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#206"><tt><font color=blue><b>get_length</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#207"><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><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#208"><tt><font color=blue><b>set_frequency</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>new_freq</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>float</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#209"><tt><font color=blue><b>get_volume</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>float</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#210"><tt><font color=blue><b>get_pan</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#211"><tt><font color=blue><b>set_volume</b></font></tt></a></td><td><tt>(<tt><font color=purple>float</font></tt> <tt><font color=blue>new_volume</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#212"><tt><font color=blue><b>set_pan</b></font></tt></a></td><td><tt>(<tt><font color=purple>float</font></tt> <tt><font color=blue>new_pan</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#213"><tt><font color=blue><b>play</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#214"><tt><font color=blue><b>stop</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#215"><tt><font color=blue><b>is_playing</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#216"><tt><font color=blue><b>set_looping</b></font></tt></a></td><td><tt>(<tt><font color=purple>bool</font></tt> <tt><font color=blue>loop</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#217"><tt><font color=blue><b>add_filter</b></font></tt></a></td><td><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_SoundFilter</font></tt>* <tt><font color=blue>filter</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>delete_filter</font></tt> = false)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_SoundBuffer_Session.html#218"><tt><font color=blue><b>remove_filter</b></font></tt></a></td><td><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_SoundFilter</font></tt>* <tt><font color=blue>filter</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> Whenever a soundbuffer is played, it returns a <a href="CL_SoundBuffer_Session.html">CL_SoundBuffer_Session</a> class, which can be used to control the sound (its volume, pitch, pan, position). It can of course also be used to retrigger the sound or to stop it. The soundeffect is stored in the layer1 soundmanager until all references to the sound played are removed, meaning that the soundeffect (session) will be ready to play and remember its state and settings (volume, frequency...) until no <a href="CL_SoundBuffer_Session.html">CL_SoundBuffer_Session</a> refers to it, via a soundbuffer session reference system.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="195"><font size=+1><b>CL_SoundBuffer_Session::CL_SoundBuffer_Session</b></font></a> - Creates a soundbuffer session not attached to any object.<br><tt></tt> <a href="CL_SoundBuffer_Session.html#195"><tt><font color=blue><b>CL_SoundBuffer_Session</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="196"><font size=+1><b>CL_SoundBuffer_Session::CL_SoundBuffer_Session</b></font></a> - Sound Buffer Session Constructor<br><tt></tt> <a href="CL_SoundBuffer_Session.html#196"><tt><font color=blue><b>CL_SoundBuffer_Session</b></font></tt></a><tt>(<tt><font color=purple>void</font></tt>* <tt><font color=blue>handle</font></tt>, <a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>* <tt><font color=blue>_card</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="197"><font size=+1><b>CL_SoundBuffer_Session::CL_SoundBuffer_Session</b></font></a> - Copy constructor.<br><tt></tt> <a href="CL_SoundBuffer_Session.html#197"><tt><font color=blue><b>CL_SoundBuffer_Session</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_SoundBuffer_Session.html#197"><tt><font color=blue><b>CL_SoundBuffer_Session</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="217"><font size=+1><b>CL_SoundBuffer_Session::add_filter</b></font></a> - Adds the sound filter to the session. See <a href="CL_SoundFilter.html">CL_SoundFilter</a> for details.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_SoundBuffer_Session.html#217"><tt><font color=blue><b>add_filter</b></font></tt></a><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_SoundFilter</font></tt>* <tt><font color=blue>filter</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>delete_filter</font></tt> = false)</tt>;<br><blockquote> filter - Sound filter to pass sound through.<br> delete_filter - If true, the filter will be deleted when the session is destroyed.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="201"><font size=+1><b>CL_SoundBuffer_Session::get_card</b></font></a> - Returns a pointer to the card on which the soundbuffer controlled<br> is played/playing.<br><tt><a href="CL_SoundCard.html"><tt><font color=navy><b>CL_SoundCard</b></font></tt></a>*</tt> <a href="CL_SoundBuffer_Session.html#201"><tt><font color=blue><b>get_card</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Pointer to soundcard</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="207"><font size=+1><b>CL_SoundBuffer_Session::get_frequency</b></font></a> - Returns the frequency of the soundeffect played.<br><tt><tt><font color=purple>int</font></tt></tt> <a href="CL_SoundBuffer_Session.html#207"><tt><font color=blue><b>get_frequency</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Frequency of soundeffect played.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="200"><font size=+1><b>CL_SoundBuffer_Session::get_handle</b></font></a> - Get Handle<br><tt><tt><font color=purple>void</font></tt>*</tt> <a href="CL_SoundBuffer_Session.html#200"><tt><font color=blue><b>get_handle</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="206"><font size=+1><b>CL_SoundBuffer_Session::get_length</b></font></a> - Returns the total length of the soundeffect played.<br> Value returned will be -1 if the length is unknown (in case of non-static soundeffects like streamed sound)<br><tt><tt><font color=purple>int</font></tt></tt> <a href="CL_SoundBuffer_Session.html#206"><tt><font color=blue><b>get_length</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Length of the soundeffect.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="210"><font size=+1><b>CL_SoundBuffer_Session::get_pan</b></font></a> - Returns the current pan (in a measure from -1 -> 1), where -1 means the soundeffect is only playing in the left speaker, and 1 means the soundeffect is only playing in the right speaker.<br><tt><tt><font color=purple>float</font></tt></tt> <a href="CL_SoundBuffer_Session.html#210"><tt><font color=blue><b>get_pan</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Current pan of the soundeffect played.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="202"><font size=+1><b>CL_SoundBuffer_Session::get_position</b></font></a> - Returns the current position of the soundeffect<br><tt><tt><font color=purple>int</font></tt></tt> <a href="CL_SoundBuffer_Session.html#202"><tt><font color=blue><b>get_position</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Current position of soundeffect.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="203"><font size=+1><b>CL_SoundBuffer_Session::get_position_relative</b></font></a> - Returns the soundeffects relative position, compared to the total length of the soundeffect.<br> The value returned will be between 0->1, where 0 means the soundeffect is at the beginning, and 1 means that the soundeffect has reached the end.<br><tt><tt><font color=purple>float</font></tt></tt> <a href="CL_SoundBuffer_Session.html#203"><tt><font color=blue><b>get_position_relative</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Relative position of the soundeffect.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="209"><font size=+1><b>CL_SoundBuffer_Session::get_volume</b></font></a> - Returns the linear relative volume of the soundeffect.<br> 0 means the soundeffect is muted, 1 means the soundeffect is playing at "max" volume.<br><tt><tt><font color=purple>float</font></tt></tt> <a href="CL_SoundBuffer_Session.html#209"><tt><font color=blue><b>get_volume</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Volume of soundeffect played.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="215"><font size=+1><b>CL_SoundBuffer_Session::is_playing</b></font></a> - Returns true if the session is playing<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_SoundBuffer_Session.html#215"><tt><font color=blue><b>is_playing</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="199"><font size=+1><b>CL_SoundBuffer_Session::operator =</b></font></a> - Copy operator<br><tt><a href="CL_SoundBuffer_Session.html#197"><tt><font color=blue><b>CL_SoundBuffer_Session</b></font></tt></a>&</tt> <a href="CL_SoundBuffer_Session.html#199"><tt><font color=black><b>operator</b></font></tt><tt> =</tt></a><tt>(<tt>const</tt> <a href="CL_SoundBuffer_Session.html#197"><tt><font color=blue><b>CL_SoundBuffer_Session</b></font></tt></a>& <tt><font color=blue>session</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="213"><font size=+1><b>CL_SoundBuffer_Session::play</b></font></a> - Starts playback of the session.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_SoundBuffer_Session.html#213"><tt><font color=blue><b>play</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="218"><font size=+1><b>CL_SoundBuffer_Session::remove_filter</b></font></a> - Remove the sound filter from the session. See <a href="CL_SoundFilter.html">CL_SoundFilter</a> for details.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_SoundBuffer_Session.html#218"><tt><font color=blue><b>remove_filter</b></font></tt></a><tt>(<tt><font color=navy>class</font></tt> <tt><font color=blue>CL_SoundFilter</font></tt>* <tt><font color=blue>filter</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="208"><font size=+1><b>CL_SoundBuffer_Session::set_frequency</b></font></a> - Sets the frequency of the soundeffect played.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_SoundBuffer_Session.html#208"><tt><font color=blue><b>set_frequency</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>new_freq</font></tt>)</tt>;<br><blockquote> New frequency of soundeffect.<br> Returns - Returns true, if the operation completed succesfully.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="216"><font size=+1><b>CL_SoundBuffer_Session::set_looping</b></font></a> - Determines whether this session should loop<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_SoundBuffer_Session.html#216"><tt><font color=blue><b>set_looping</b></font></tt></a><tt>(<tt><font color=purple>bool</font></tt> <tt><font color=blue>loop</font></tt>)</tt>;<br><blockquote> loop - true if session should loop, false otherwise</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="212"><font size=+1><b>CL_SoundBuffer_Session::set_pan</b></font></a> - Sets the panning of the soundeffect played in measures from -1 -> 1<br> Setting the pan with a value of -1 will pan the soundeffect to the extreme left (left speaker only), 1 will pan the soundeffect to the extreme right (right speaker only).<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_SoundBuffer_Session.html#212"><tt><font color=blue><b>set_pan</b></font></tt></a><tt>(<tt><font color=purple>float</font></tt> <tt><font color=blue>new_pan</font></tt>)</tt>;<br><blockquote> new_pan - New pan of the soundeffect played.<br> Returns - Returns true if the operation completed sucecsfully.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="204"><font size=+1><b>CL_SoundBuffer_Session::set_position</b></font></a> - Sets the soundeffects position to 'new_pos'.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_SoundBuffer_Session.html#204"><tt><font color=blue><b>set_position</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>new_pos</font></tt>)</tt>;<br><blockquote> The new position of the soundeffect.<br> Returns - Returns true if operation completed succesfully.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="205"><font size=+1><b>CL_SoundBuffer_Session::set_position_relative</b></font></a> - Sets the relative position of the soundeffect.<br> Value must be between 0->1, where 0 sets the soundeffect to the beginning, and 1 sets it to the end of the soundbuffer.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_SoundBuffer_Session.html#205"><tt><font color=blue><b>set_position_relative</b></font></tt></a><tt>(<tt><font color=purple>float</font></tt> <tt><font color=blue>new_pos</font></tt>)</tt>;<br><blockquote> New relative position<br> Returns - Returns true if operation completed succesfully.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="211"><font size=+1><b>CL_SoundBuffer_Session::set_volume</b></font></a> - Sets the volume of the soundeffect in a relative measure (0->1)<br> A value of 0 will effectively mute the sound (although it will still be sampled), and a value of 1 will set the volume to "max".<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_SoundBuffer_Session.html#211"><tt><font color=blue><b>set_volume</b></font></tt></a><tt>(<tt><font color=purple>float</font></tt> <tt><font color=blue>new_volume</font></tt>)</tt>;<br><blockquote> new_volume - New volume of soundeffect <br> Returns - Returns true if the operation completed succesfully.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="214"><font size=+1><b>CL_SoundBuffer_Session::stop</b></font></a> - Stops playback of the session.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_SoundBuffer_Session.html#214"><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="198"><font size=+1><b>CL_SoundBuffer_Session::~CL_SoundBuffer_Session</b></font></a> - Sound Buffer Session Destructor<br><tt></tt> <a href="CL_SoundBuffer_Session.html#198"><tt><font color=blue><b>~CL_SoundBuffer_Session</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <hr noshade> </body> </html>
