CL_SoundProvider_Wave Class Reference
[clanSound Sound Providers]

Windows WAVE sample format (.wav) sound provider. More...

#include <soundprovider_wave.h>

Inheritance diagram for CL_SoundProvider_Wave:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Construction

 CL_SoundProvider_Wave (const CL_String &filename, const CL_VirtualDirectory &directory, bool stream=false)
 Constructs a sound provider based on a Windows wave (.wav) file.
 CL_SoundProvider_Wave (const CL_String &fullname, bool stream=false)
 CL_SoundProvider_Wave (CL_IODevice &file, bool stream=false)
virtual ~CL_SoundProvider_Wave ()
Operations

virtual CL_SoundProvider_Sessionbegin_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_Wave_Session

Detailed Description

Windows WAVE sample format (.wav) sound provider.


Constructor & Destructor Documentation

CL_SoundProvider_Wave::CL_SoundProvider_Wave ( const CL_String filename,
const CL_VirtualDirectory directory,
bool  stream = false 
)

Constructs a sound provider based on a Windows wave (.wav) file.

Parameters:
filename Filename of wave file.
provider Input source provider used to retrieve wave file.
stream If true, will stream from disk. If false, will load it to memory.
CL_SoundProvider_Wave::CL_SoundProvider_Wave ( const CL_String fullname,
bool  stream = false 
)
CL_SoundProvider_Wave::CL_SoundProvider_Wave ( CL_IODevice file,
bool  stream = false 
)
virtual CL_SoundProvider_Wave::~CL_SoundProvider_Wave (  )  [virtual]

Member Function Documentation

virtual CL_SoundProvider_Session* CL_SoundProvider_Wave::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_Wave::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_Wave_Session [friend]

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