---

CL_StreamSoundProvider_Session Class Reference

#include <stream_soundprovider.h>

Inheritance diagram for CL_StreamSoundProvider_Session:

[legend]List of all members.

Public Methods
virtual	~CL_StreamSoundProvider_Session ()
virtual bool	eof () const=0
virtual void	stop ()=0
	retval: True if end of input data. False otherwise.
virtual bool	play ()=0
virtual bool	set_position (int pos)=0
	retval: True for success. False otherwise.
virtual int	get_data (void *data_ptr, int data_requested)=0
	param: pos - Position to seek to.retval: True for success. False otherwise.
virtual int	get_frequency () const=0
	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=0
	retval: Playback frequency.

---

Constructor & Destructor Documentation

CL_StreamSoundProvider_Session::~CL_StreamSoundProvider_Session ( ) [inline, virtual]

Definition at line 47 of file stream_soundprovider.h.

---

Member Function Documentation

virtual bool CL_StreamSoundProvider_Session::eof ( ) const [pure virtual]

Reimplemented in CL_Streamed_MikModSample_Session, CL_MPEGSoundProvider_Session, CL_Streamed_RawSample_Session, CL_Streamed_WaveSample_Session, and CL_VorbisStream.

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

param: pos - Position to seek to.retval: True for success. False otherwise. Reimplemented in CL_Streamed_MikModSample_Session, CL_MPEGSoundProvider_Session, CL_Streamed_RawSample_Session, CL_Streamed_WaveSample_Session, and CL_VorbisStream.

SoundFormat CL_StreamSoundProvider_Session::get_format ( ) const [pure virtual]

retval: Playback frequency. Reimplemented in CL_Streamed_MikModSample_Session, CL_MPEGSoundProvider_Session, CL_Streamed_RawSample_Session, CL_Streamed_WaveSample_Session, and CL_VorbisStream.

int CL_StreamSoundProvider_Session::get_frequency ( ) const [pure 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 in CL_Streamed_MikModSample_Session, CL_MPEGSoundProvider_Session, CL_Streamed_RawSample_Session, CL_Streamed_WaveSample_Session, and CL_VorbisStream.

virtual bool CL_StreamSoundProvider_Session::play ( ) [pure virtual]

Reimplemented in CL_Streamed_MikModSample_Session, CL_MPEGSoundProvider_Session, CL_Streamed_RawSample_Session, CL_Streamed_WaveSample_Session, and CL_VorbisStream.

bool CL_StreamSoundProvider_Session::set_position ( int pos ) [pure virtual]

retval: True for success. False otherwise. Reimplemented in CL_Streamed_MikModSample_Session, CL_MPEGSoundProvider_Session, CL_Streamed_RawSample_Session, CL_Streamed_WaveSample_Session, and CL_VorbisStream.

void CL_StreamSoundProvider_Session::stop ( ) [pure virtual]

retval: True if end of input data. False otherwise. Reimplemented in CL_Streamed_MikModSample_Session, CL_MPEGSoundProvider_Session, CL_Streamed_RawSample_Session, CL_Streamed_WaveSample_Session, and CL_VorbisStream.

---

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

• stream_soundprovider.h

---