Module format (.mod, .s3m, .xm, etc) sound provider. More...
#include <soundprovider_mikmod.h>
Inheritance diagram for CL_SoundProvider_MikMod:
Public Member Functions | |
Construction | |
| CL_SoundProvider_MikMod (const CL_String &filename, const CL_VirtualDirectory &provider, bool stream=false) | |
| Constructs a sound provider based on a MikMod compatible module file. | |
| CL_SoundProvider_MikMod (const CL_String &fullname, bool stream=false) | |
| CL_SoundProvider_MikMod (CL_IODevice &file, bool stream=false) | |
| virtual | ~CL_SoundProvider_MikMod () |
Operations | |
| virtual CL_SoundProvider_Session * | begin_session () |
| Called by CL_SoundBuffer when a new session starts. | |
| virtual void | end_session (CL_SoundProvider_Session *session) |
| Called by CL_SoundBuffer when a session has finished. After this call,. | |
Implementation | |
|
| |
| class | CL_SoundProvider_MikMod_Session |
Detailed Description
Module format (.mod, .s3m, .xm, etc) sound provider.
Constructor & Destructor Documentation
| CL_SoundProvider_MikMod::CL_SoundProvider_MikMod | ( | const CL_String & | filename, | |
| const CL_VirtualDirectory & | provider, | |||
| bool | stream = false | |||
| ) |
Constructs a sound provider based on a MikMod compatible module file.
- Parameters:
-
filename Filename of module file. provider Input source provider used to retrieve module file. stream If true, will stream from disk. If false, will load it to memory.
| CL_SoundProvider_MikMod::CL_SoundProvider_MikMod | ( | const CL_String & | fullname, | |
| bool | stream = false | |||
| ) |
| CL_SoundProvider_MikMod::CL_SoundProvider_MikMod | ( | CL_IODevice & | file, | |
| bool | stream = false | |||
| ) |
| virtual CL_SoundProvider_MikMod::~CL_SoundProvider_MikMod | ( | ) | [virtual] |
Member Function Documentation
| virtual CL_SoundProvider_Session* CL_SoundProvider_MikMod::begin_session | ( | ) | [virtual] |
Called by CL_SoundBuffer when a new session starts.
- Returns:
- The soundbuffer session to be attached to the newly started session.
Implements CL_SoundProvider.
| virtual void CL_SoundProvider_MikMod::end_session | ( | CL_SoundProvider_Session * | session | ) | [virtual] |
Called by CL_SoundBuffer when a session has finished. After this call,.
CL_SoundBuffer will not access the session anymore. It can safely be deleted here (and in most cases should be delete here).
Implements CL_SoundProvider.
Friends And Related Function Documentation
friend class CL_SoundProvider_MikMod_Session [friend] |
The documentation for this class was generated from the following file:
