ClanSoft logo
ClanSoft logo
Entire Class Index Main Class Index Cross Index Global Index

Class CL_Streamed_MikModSample

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>
Contained in: global
Derived from: CL_StreamSoundProvider
Derived by: none
Group: MikMod (Sound Providers)

#include <ClanLib/mikmod.h>


public function member index:

Construction:

static CL_SoundBuffer* create(const std::string& filename, CL_InputSourceProvider* inputprovider = NULL, bool looped = false);
static CL_SoundBuffer* load(const std::string& res_id, CL_ResourceManager* manager, bool looped = false);
CL_Streamed_MikModSample(const std::string& filename, CL_InputSourceProvider* inputprovider = NULL, bool looped = false);
CL_Streamed_MikModSample(const std::string& res_id, CL_ResourceManager* manager, bool looped = false);
virtual ~CL_Streamed_MikModSample();

Operations:

virtual CL_StreamSoundProvider_Session* begin_session();
virtual void end_session(CL_StreamSoundProvider_Session* session);
 

Description:


Function Member Descriptions:

CL_Streamed_MikModSample::CL_Streamed_MikModSample - Use this function to create a module from a file for instance
CL_Streamed_MikModSample(const std::string& filename, CL_InputSourceProvider* inputprovider = NULL, bool looped = false);


CL_Streamed_MikModSample::CL_Streamed_MikModSample - Loads a module from a resource file (.scr or .dat)
CL_Streamed_MikModSample(const std::string& res_id, CL_ResourceManager* manager, bool looped = false);


CL_Streamed_MikModSample::begin_session - Starts playing the module
virtual CL_StreamSoundProvider_Session* begin_session();


CL_Streamed_MikModSample::create - Use this function to create a module from a file for instance
static CL_SoundBuffer* create(const std::string& filename, CL_InputSourceProvider* inputprovider = NULL, bool looped = false);


CL_Streamed_MikModSample::end_session - Ends the session
virtual void end_session(CL_StreamSoundProvider_Session* session);


CL_Streamed_MikModSample::load - Loads a module from a resource file (.scr or .dat)
static CL_SoundBuffer* load(const std::string& res_id, CL_ResourceManager* manager, bool looped = false);


CL_Streamed_MikModSample::~CL_Streamed_MikModSample - Streamed MikModSample Destructor
virtual ~CL_Streamed_MikModSample();



Variable Member Descriptions: