---

CL_Streamed_RawSample Class Reference

also: CL_Sample_Raw - The static raw sample provider.also: CL_Sample - The static wave sample provider.also: CL_Streamed_WaveSample - The streamed wave sample provider.also: CL_SoundBuffer - Sound playback class in ClanLib.also: CL_StreamSoundProvider - Streamed sound provider interface.also: CL_StaticSoundProvider - Static sound provider interface. More...

#include <stream_provider_raw.h>

Inheritance diagram for CL_Streamed_RawSample:

[legend]Collaboration diagram for CL_Streamed_RawSample:

[legend]List of all members.

Public Methods
	CL_Streamed_RawSample (const char *filename, SoundFormat format, int frequency, CL_InputSourceProvider *inputprovider=NULL, bool looped=false)
	param: filename - Filename of the raw PCM stream.param: frequency - Default playback frequency.param: inputprovider - Input source (datafile, regular file). If NULLparam: it defaults to a regular file.param: looped - True if the streamed should be looped (stream never ends).retval: The soundbuffer created.
virtual	~CL_Streamed_RawSample ()
	param: filename - Filename of the raw PCM stream.param: frequency - Default playback frequency.param: inputprovider - Input source (datafile, regular file). If NULLparam: it defaults to a regular file.param: looped - True if the streamed should be looped (stream never ends).
virtual CL_StreamSoundProvider_Session*	begin_session ()
virtual void	end_session (CL_StreamSoundProvider_Session *session)
	retval: The soundbuffer session to be attached to the newlyretval: started session.
Static Public Methods
CL_SoundBuffer*	create (const char *filename, SoundFormat format, int frequency, CL_InputSourceProvider *inputprovider=NULL, bool looped=false)
Protected Attributes
std::string	filename
CL_InputSourceProvider*	inputprovider
bool	looped
SoundFormat	format
int	frequency

---

Detailed Description

also: CL_Sample_Raw - The static raw sample provider.also: CL_Sample - The static wave sample provider.also: CL_Streamed_WaveSample - The streamed wave sample provider.also: CL_SoundBuffer - Sound playback class in ClanLib.also: CL_StreamSoundProvider - Streamed sound provider interface.also: CL_StaticSoundProvider - Static sound provider interface.

Definition at line 27 of file stream_provider_raw.h.

---

Constructor & Destructor Documentation

CL_Streamed_RawSample::CL_Streamed_RawSample ( const char * filename, SoundFormat format, int frequency, CL_InputSourceProvider * inputprovider = NULL, bool looped = false )

param: filename - Filename of the raw PCM stream.param: frequency - Default playback frequency.param: inputprovider - Input source (datafile, regular file). If NULLparam: it defaults to a regular file.param: looped - True if the streamed should be looped (stream never ends).retval: The soundbuffer created.

CL_Streamed_RawSample::~CL_Streamed_RawSample ( ) [virtual]

param: filename - Filename of the raw PCM stream.param: frequency - Default playback frequency.param: inputprovider - Input source (datafile, regular file). If NULLparam: it defaults to a regular file.param: looped - True if the streamed should be looped (stream never ends).

---

Member Function Documentation

virtual CL_StreamSoundProvider_Session* CL_Streamed_RawSample::begin_session ( ) [virtual]

Reimplemented from CL_StreamSoundProvider.

CL_SoundBuffer* CL_Streamed_RawSample::create ( const char * filename, SoundFormat format, int frequency, CL_InputSourceProvider * inputprovider = NULL, bool looped = false ) [static]

virtual void CL_Streamed_RawSample::end_session ( CL_StreamSoundProvider_Session * session ) [virtual]

retval: The soundbuffer session to be attached to the newlyretval: started session. Reimplemented from CL_StreamSoundProvider.

---

Member Data Documentation

std::string CL_Streamed_RawSample::filename [protected]

Definition at line 83 of file stream_provider_raw.h.

SoundFormat CL_Streamed_RawSample::format [protected]

Definition at line 86 of file stream_provider_raw.h.

int CL_Streamed_RawSample::frequency [protected]

Definition at line 87 of file stream_provider_raw.h.

CL_InputSourceProvider* CL_Streamed_RawSample::inputprovider [protected]

Definition at line 84 of file stream_provider_raw.h.

bool CL_Streamed_RawSample::looped [protected]

Definition at line 85 of file stream_provider_raw.h.

---

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

• stream_provider_raw.h

---