---

CL_Streamed_MikModSample_Session Class Reference

#include <streamed_mikmod_sample.h>

Inheritance diagram for CL_Streamed_MikModSample_Session:

[legend]Collaboration diagram for CL_Streamed_MikModSample_Session:

[legend]List of all members.

Public Methods
virtual	~CL_Streamed_MikModSample_Session ()
virtual void	stop ()
	retval: True if end of input data. False otherwise.
virtual bool	play ()
virtual bool	set_position (int pos)
	retval: True for success. False otherwise.
virtual bool	eof () const
virtual int	get_data (void *data_ptr, int data_requested)
	param: pos - Position to seek to.retval: True for success. False otherwise.
virtual int	get_frequency () const
	param: data_ptr - Points to a buffer that should be filled withparam: sample data.param: data_requested - Bytes of data requested.retval: Number of bytes actually filled with sample data.
virtual SoundFormat	get_format () const
	retval: Playback frequency.
Static Public Methods
BOOL	clanMikMod_IsPresent ()
void	clanMikMod_Update ()
Protected Methods
	CL_Streamed_MikModSample_Session (MODULE *_module, bool _looped)
Protected Attributes
friend	CL_Streamed_MikModSample
MODULE*	module
bool	looped
SoundFormat	sample_format
int	sample_size
int	sample_freq
int	sample_left

---

Constructor & Destructor Documentation

CL_Streamed_MikModSample_Session::CL_Streamed_MikModSample_Session ( MODULE * _module, bool _looped ) [protected]

virtual CL_Streamed_MikModSample_Session::~CL_Streamed_MikModSample_Session ( ) [virtual]

---

Member Function Documentation

BOOL CL_Streamed_MikModSample_Session::clanMikMod_IsPresent ( ) [inline, static]

Definition at line 112 of file streamed_mikmod_sample.h.

void CL_Streamed_MikModSample_Session::clanMikMod_Update ( ) [inline, static]

Definition at line 113 of file streamed_mikmod_sample.h.

virtual bool CL_Streamed_MikModSample_Session::eof ( ) const [virtual]

Reimplemented from CL_StreamSoundProvider_Session.

virtual int CL_Streamed_MikModSample_Session::get_data ( void * data_ptr, int data_requested ) [virtual]

param: pos - Position to seek to.retval: True for success. False otherwise. Reimplemented from CL_StreamSoundProvider_Session.

virtual SoundFormat CL_Streamed_MikModSample_Session::get_format ( ) const [virtual]

retval: Playback frequency. Reimplemented from CL_StreamSoundProvider_Session.

virtual int CL_Streamed_MikModSample_Session::get_frequency ( ) const [virtual]

param: data_ptr - Points to a buffer that should be filled withparam: sample data.param: data_requested - Bytes of data requested.retval: Number of bytes actually filled with sample data. Reimplemented from CL_StreamSoundProvider_Session.

virtual bool CL_Streamed_MikModSample_Session::play ( ) [virtual]

Reimplemented from CL_StreamSoundProvider_Session.

virtual bool CL_Streamed_MikModSample_Session::set_position ( int pos ) [virtual]

retval: True for success. False otherwise. Reimplemented from CL_StreamSoundProvider_Session.

virtual void CL_Streamed_MikModSample_Session::stop ( ) [virtual]

retval: True if end of input data. False otherwise. Reimplemented from CL_StreamSoundProvider_Session.

---

Member Data Documentation

friend CL_Streamed_MikModSample_Session::CL_Streamed_MikModSample [protected]

Definition at line 84 of file streamed_mikmod_sample.h.

bool CL_Streamed_MikModSample_Session::looped [protected]

Definition at line 89 of file streamed_mikmod_sample.h.

MODULE* CL_Streamed_MikModSample_Session::module [protected]

Definition at line 88 of file streamed_mikmod_sample.h.

SoundFormat CL_Streamed_MikModSample_Session::sample_format [protected]

Definition at line 91 of file streamed_mikmod_sample.h.

int CL_Streamed_MikModSample_Session::sample_freq [protected]

Definition at line 93 of file streamed_mikmod_sample.h.

int CL_Streamed_MikModSample_Session::sample_left [protected]

Definition at line 94 of file streamed_mikmod_sample.h.

int CL_Streamed_MikModSample_Session::sample_size [protected]

Definition at line 92 of file streamed_mikmod_sample.h.

---

The documentation for this class was generated from the following file:

• streamed_mikmod_sample.h

---