<html> <head><title>ClanLib Reference: CL_Sample</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_Sample</h1><p> <b> ClanLib's datafile samples. This class can read samples from datafiles.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <a href="CL_StaticSoundProvider.html">CL_StaticSoundProvider</a> <br> Derived by: <i>none</i> <br>Group: Sound (Sound Providers) <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>static</tt> <a href="CL_SoundBuffer.html"><tt><font color=navy><b>CL_SoundBuffer</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Sample.html#133"><tt><font color=blue><b>create</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>sample_id</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>provider</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Sample.html#134"><tt><font color=blue><b>CL_Sample</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>sample_id</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>_provider</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_Sample.html#135"><tt><font color=blue><b>~CL_Sample</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_Sample.html#136"><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_Sample.html#137"><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_Sample.html#138"><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_Sample.html#139"><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_Sample.html#140"><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_Sample.html#141"><tt><font color=blue><b>get_frequency</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr><td> </td><tr><td colspan=3><h3>private function member index:</h3></td> <tr valign=top><td align=left><h3>Implementation:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Sample.html#154"><tt><font color=blue><b>load_data</b></font></tt></a></td><td><tt>()</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="134"><font size=+1><b>CL_Sample::CL_Sample</b></font></a> - Constructs a static sound provider that represents 'sample_id' from the<br> inputsource provider 'provider'.<br><tt></tt> <a href="CL_Sample.html#134"><tt><font color=blue><b>CL_Sample</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>sample_id</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>_provider</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="133"><font size=+1><b>CL_Sample::create</b></font></a> - Loads the sample 'sample_id' from the inputsource provider 'provider'. <br> Creates a <a href="CL_SoundBuffer.html">CL_SoundBuffer</a> using this sample and returns it.<br><tt><tt>static</tt> <a href="CL_SoundBuffer.html"><tt><font color=navy><b>CL_SoundBuffer</b></font></tt></a>*</tt> <a href="CL_Sample.html#133"><tt><font color=blue><b>create</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>sample_id</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>provider</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="139"><font size=+1><b>CL_Sample::data_size</b></font></a> - Returns the size of the sample.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Sample.html#139"><tt><font color=blue><b>data_size</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="140"><font size=+1><b>CL_Sample::get_data</b></font></a> - Returns the sample data. Must be locked before this is done.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt>*</tt> <a href="CL_Sample.html#140"><tt><font color=blue><b>get_data</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="138"><font size=+1><b>CL_Sample::get_format</b></font></a> - Returns the sample format used by this sample.<br><tt><tt>virtual</tt> <tt><font color=navy>SoundFormat</font></tt></tt> <a href="CL_Sample.html#138"><tt><font color=blue><b>get_format</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="141"><font size=+1><b>CL_Sample::get_frequency</b></font></a> - Returns the default frequency used when playing this sample.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_Sample.html#141"><tt><font color=blue><b>get_frequency</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="136"><font size=+1><b>CL_Sample::lock</b></font></a> - Locks the sample data.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Sample.html#136"><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="137"><font size=+1><b>CL_Sample::unlock</b></font></a> - Unlocks the sample data.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Sample.html#137"><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="135"><font size=+1><b>CL_Sample::~CL_Sample</b></font></a> - Sample Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_Sample.html#135"><tt><font color=blue><b>~CL_Sample</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>
