ClanLib  2.3.7
List of all members
CL_SoundProvider Class Referenceabstract

Sound provider. More...

#include <soundprovider.h>

Inheritance diagram for CL_SoundProvider:
Inheritance graph
[legend]

Public Member Functions

Construction
 CL_SoundProvider ()
 
virtual ~CL_SoundProvider ()
 
Operations
virtual CL_SoundProvider_Sessionbegin_session ()=0
 Called by CL_SoundBuffer when a new session starts. More...
 
virtual void end_session (CL_SoundProvider_Session *session)=0
 Called by CL_SoundBuffer when a session has finished. After this call,. More...
 

Detailed Description

Sound provider.

Interface to sound sources. Used by the CL_SoundBuffer class to start and stop playback.

Constructor & Destructor Documentation

CL_SoundProvider::CL_SoundProvider ( )
virtual CL_SoundProvider::~CL_SoundProvider ( )
virtual

Member Function Documentation

virtual CL_SoundProvider_Session* CL_SoundProvider::begin_session ( )
pure virtual

Called by CL_SoundBuffer when a new session starts.

Returns
The soundbuffer session to be attached to the newly started session.

Implemented in CL_SoundProvider_MikMod, CL_SoundProvider_Wave, CL_SoundProvider_Vorbis, CL_SoundProvider_Raw, and CL_SoundProvider_Recorder.

virtual void CL_SoundProvider::end_session ( CL_SoundProvider_Session session)
pure 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).

Implemented in CL_SoundProvider_MikMod, CL_SoundProvider_Wave, CL_SoundProvider_Vorbis, CL_SoundProvider_Raw, and CL_SoundProvider_Recorder.


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