---

CL_MPEGSoundProvider_Session Class Reference

#include <mpeg_soundprovider.h>

Inheritance diagram for CL_MPEGSoundProvider_Session:

[legend]Collaboration diagram for CL_MPEGSoundProvider_Session:

[legend]List of all members.

Public Methods
	CL_MPEGSoundProvider_Session (const char *filename)
virtual	~CL_MPEGSoundProvider_Session ()
virtual bool	eof () const
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 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.
Protected Methods
virtual bool	Open (MPEGAudioSpec *desired, MPEGAudioSpec *optained)
	retval: The playback Sample format.
virtual void	Close ()
virtual void	Pause (bool enable)
virtual void	Mix (Uint8 *dst, Uint8 *src, Uint32 len, int volume)
virtual void	Lock ()
virtual void	Unlock ()
virtual int	GetMaxVolume ()
virtual char*	GetError ()
Private Attributes
MPEG*	mpeg
MPEGAudioSpec	audiospec

---

Constructor & Destructor Documentation

CL_MPEGSoundProvider_Session::CL_MPEGSoundProvider_Session ( const char * filename )

virtual CL_MPEGSoundProvider_Session::~CL_MPEGSoundProvider_Session ( ) [virtual]

---

Member Function Documentation

virtual void CL_MPEGSoundProvider_Session::Close ( ) [protected, virtual]

virtual char* CL_MPEGSoundProvider_Session::GetError ( ) [protected, virtual]

virtual int CL_MPEGSoundProvider_Session::GetMaxVolume ( ) [protected, virtual]

virtual void CL_MPEGSoundProvider_Session::Lock ( ) [protected, virtual]

virtual void CL_MPEGSoundProvider_Session::Mix ( Uint8 * dst, Uint8 * src, Uint32 len, int volume ) [protected, virtual]

bool CL_MPEGSoundProvider_Session::Open ( MPEGAudioSpec * desired, MPEGAudioSpec * optained ) [protected, virtual]

retval: The playback Sample format.

virtual void CL_MPEGSoundProvider_Session::Pause ( bool enable ) [protected, virtual]

virtual void CL_MPEGSoundProvider_Session::Unlock ( ) [protected, virtual]

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

Reimplemented from CL_StreamSoundProvider_Session.

int CL_MPEGSoundProvider_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.

SoundFormat CL_MPEGSoundProvider_Session::get_format ( ) const [virtual]

retval: Playback frequency. Reimplemented from CL_StreamSoundProvider_Session.

int CL_MPEGSoundProvider_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_MPEGSoundProvider_Session::play ( ) [virtual]

Reimplemented from CL_StreamSoundProvider_Session.

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

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

void CL_MPEGSoundProvider_Session::stop ( ) [virtual]

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

---

Member Data Documentation

MPEGAudioSpec CL_MPEGSoundProvider_Session::audiospec [private]

Definition at line 85 of file mpeg_soundprovider.h.

MPEG* CL_MPEGSoundProvider_Session::mpeg [private]

Definition at line 84 of file mpeg_soundprovider.h.

---

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

• mpeg_soundprovider.h

---