<html> <head><title>ClanLib Reference: CL_Streamed_MikModSample</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_Streamed_MikModSample</h1><p> <b> CL_Streamed_MikModSample is used to store MikMod modules in memory. <p>This class stores the ClanLib sample the way the MikMod MODULE struct does. It's only intended to store the module in memory, not to play it directly. To play the module, use CL_Streamed_MikModSample_Session instead.</p></b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <a href="CL_StreamSoundProvider.html">CL_StreamSoundProvider</a> <br> Derived by: <i>none</i> <br>Group: MikMod (Sound Providers) <p> #include <ClanLib/mikmod.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_Streamed_MikModSample.html#13"><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>filename</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>inputprovider</font></tt> = NULL, <tt><font color=purple>bool</font></tt> <tt><font color=blue>looped</font></tt> = false)</tt>;</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_Streamed_MikModSample.html#14"><tt><font color=blue><b>load</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>res_id</font></tt>, <a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a>* <tt><font color=blue>manager</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>looped</font></tt> = false)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Streamed_MikModSample.html#15"><tt><font color=blue><b>CL_Streamed_MikModSample</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filename</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>inputprovider</font></tt> = NULL, <tt><font color=purple>bool</font></tt> <tt><font color=blue>looped</font></tt> = false)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Streamed_MikModSample.html#16"><tt><font color=blue><b>CL_Streamed_MikModSample</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>res_id</font></tt>, <a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a>* <tt><font color=blue>manager</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>looped</font></tt> = false)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_Streamed_MikModSample.html#17"><tt><font color=blue><b>~CL_Streamed_MikModSample</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> <a href="CL_StreamSoundProvider_Session.html"><tt><font color=navy><b>CL_StreamSoundProvider_Session</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Streamed_MikModSample.html#18"><tt><font color=blue><b>begin_session</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_Streamed_MikModSample.html#19"><tt><font color=blue><b>end_session</b></font></tt></a></td><td><tt>(<a href="CL_StreamSoundProvider_Session.html"><tt><font color=navy><b>CL_StreamSoundProvider_Session</b></font></tt></a>* <tt><font color=blue>session</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="15"><font size=+1><b>CL_Streamed_MikModSample::CL_Streamed_MikModSample</b></font></a> - Use this function to create a module from a file for instance<br><tt></tt> <a href="CL_Streamed_MikModSample.html#15"><tt><font color=blue><b>CL_Streamed_MikModSample</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filename</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>inputprovider</font></tt> = NULL, <tt><font color=purple>bool</font></tt> <tt><font color=blue>looped</font></tt> = false)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="16"><font size=+1><b>CL_Streamed_MikModSample::CL_Streamed_MikModSample</b></font></a> - Loads a module from a resource file (.scr or .dat)<br><tt></tt> <a href="CL_Streamed_MikModSample.html#16"><tt><font color=blue><b>CL_Streamed_MikModSample</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>res_id</font></tt>, <a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a>* <tt><font color=blue>manager</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>looped</font></tt> = false)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="18"><font size=+1><b>CL_Streamed_MikModSample::begin_session</b></font></a> - Starts playing the module<br><tt><tt>virtual</tt> <a href="CL_StreamSoundProvider_Session.html"><tt><font color=navy><b>CL_StreamSoundProvider_Session</b></font></tt></a>*</tt> <a href="CL_Streamed_MikModSample.html#18"><tt><font color=blue><b>begin_session</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="13"><font size=+1><b>CL_Streamed_MikModSample::create</b></font></a> - Use this function to create a module from a file for instance<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_Streamed_MikModSample.html#13"><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>filename</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>inputprovider</font></tt> = NULL, <tt><font color=purple>bool</font></tt> <tt><font color=blue>looped</font></tt> = false)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="19"><font size=+1><b>CL_Streamed_MikModSample::end_session</b></font></a> - Ends the session<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_Streamed_MikModSample.html#19"><tt><font color=blue><b>end_session</b></font></tt></a><tt>(<a href="CL_StreamSoundProvider_Session.html"><tt><font color=navy><b>CL_StreamSoundProvider_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="14"><font size=+1><b>CL_Streamed_MikModSample::load</b></font></a> - Loads a module from a resource file (.scr or .dat)<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_Streamed_MikModSample.html#14"><tt><font color=blue><b>load</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>res_id</font></tt>, <a href="CL_ResourceManager.html"><tt><font color=navy><b>CL_ResourceManager</b></font></tt></a>* <tt><font color=blue>manager</font></tt>, <tt><font color=purple>bool</font></tt> <tt><font color=blue>looped</font></tt> = false)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="17"><font size=+1><b>CL_Streamed_MikModSample::~CL_Streamed_MikModSample</b></font></a> - Streamed MikModSample Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_Streamed_MikModSample.html#17"><tt><font color=blue><b>~CL_Streamed_MikModSample</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>
