clan::SoundProvider Class Referenceabstract

Sound provider. More...

#include <soundprovider.h>

+ Inheritance diagram for clan::SoundProvider:

Public Member Functions

 SoundProvider ()
 
virtual ~SoundProvider ()
 
virtual SoundProvider_Sessionbegin_session ()=0
 Called by SoundBuffer when a new session starts. More...
 
virtual void end_session (SoundProvider_Session *session)=0
 Called by SoundBuffer when a session has finished. After this call,. More...
 

Detailed Description

Sound provider.

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

Constructor & Destructor Documentation

clan::SoundProvider::SoundProvider ( )
virtual clan::SoundProvider::~SoundProvider ( )
virtual

Member Function Documentation

virtual SoundProvider_Session* clan::SoundProvider::begin_session ( )
pure virtual

Called by SoundBuffer when a new session starts.

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

Implemented in clan::SoundProvider_Vorbis, clan::SoundProvider_Wave, and clan::SoundProvider_Raw.

virtual void clan::SoundProvider::end_session ( SoundProvider_Session session)
pure virtual

Called by SoundBuffer when a session has finished. After this call,.

SoundBuffer will not access the session anymore. It can safely be deleted here (and in most cases should be delete here).

Implemented in clan::SoundProvider_Vorbis, clan::SoundProvider_Wave, and clan::SoundProvider_Raw.


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