<html> <head><title>ClanLib Reference: CL_StaticSoundProvider</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_StaticSoundProvider</h1><p> <b> Static Soundprovider class.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <a href="CL_Sample.html">CL_Sample</a> <a href="CL_Sample_RawData.html">CL_Sample_RawData</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_StaticSoundProvider.html#46"><tt><font color=blue><b>~CL_StaticSoundProvider</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>void</font></tt></tt> </td><td align=right><a href="CL_StaticSoundProvider.html#47"><tt><font color=blue><b>lock</b></font></tt></a></td><td><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_StaticSoundProvider.html#48"><tt><font color=blue><b>unlock</b></font></tt></a></td><td><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=navy>SoundFormat</font></tt></tt> </td><td align=right><a href="CL_StaticSoundProvider.html#49"><tt><font color=blue><b>get_format</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>int</font></tt></tt> </td><td align=right><a href="CL_StaticSoundProvider.html#50"><tt><font color=blue><b>data_size</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_StaticSoundProvider.html#51"><tt><font color=blue><b>get_data</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>int</font></tt></tt> </td><td align=right><a href="CL_StaticSoundProvider.html#52"><tt><font color=blue><b>get_frequency</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> The static soundprovider provides the data for any static (non-streamed) samples played using the ClanLib sound system.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="50"><font size=+1><b>CL_StaticSoundProvider::data_size</b></font></a> - Returns the total size in bytes of the data stored. <br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_StaticSoundProvider.html#50"><tt><font color=blue><b>data_size</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Size of data stored (in bytes).</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="51"><font size=+1><b>CL_StaticSoundProvider::get_data</b></font></a> - Returns a pointer to the data stored. <br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt>*</tt> <a href="CL_StaticSoundProvider.html#51"><tt><font color=blue><b>get_data</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - A pointer to the data stored.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="49"><font size=+1><b>CL_StaticSoundProvider::get_format</b></font></a> - Returns the soundformat of the data stored by the provider. <br> The data stored can be either 8-bit signed, 8-bit unsigned, 16-bit signed and 16-bit unsigned.<br><tt><tt>virtual</tt> <tt><font color=navy>SoundFormat</font></tt></tt> <a href="CL_StaticSoundProvider.html#49"><tt><font color=blue><b>get_format</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - The soundformat of the data stored.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="52"><font size=+1><b>CL_StaticSoundProvider::get_frequency</b></font></a> - Returns the frequency of the data stored. <br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_StaticSoundProvider.html#52"><tt><font color=blue><b>get_frequency</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Frequency of data stored.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="47"><font size=+1><b>CL_StaticSoundProvider::lock</b></font></a> - Locks the soundprovider. Locking a provider means, that the contents of the provider should be available following the call to lock(), which means that lock loads any files from disk, and performs any necessary initializations.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_StaticSoundProvider.html#47"><tt><font color=blue><b>lock</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="48"><font size=+1><b>CL_StaticSoundProvider::unlock</b></font></a> - Unlocks the soundprovider. Unlocking a provider means, that the contents of the provider should be deinitialized, thus removing any loaded sample data from memory.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_StaticSoundProvider.html#48"><tt><font color=blue><b>unlock</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="46"><font size=+1><b>CL_StaticSoundProvider::~CL_StaticSoundProvider</b></font></a> - Static Sound Provider Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_StaticSoundProvider.html#46"><tt><font color=blue><b>~CL_StaticSoundProvider</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> </body> </html>
