ClanLib  2.3.7
List of all members
CL_SoundProvider_Vorbis Class Reference

Ogg Vorbis format sound provider. More...

#include <soundprovider_vorbis.h>

Inheritance diagram for CL_SoundProvider_Vorbis:
Inheritance graph
[legend]

Public Member Functions

Construction
 CL_SoundProvider_Vorbis (const CL_String &filename, const CL_VirtualDirectory &directory, bool stream=false)
 Constructs a sound provider based on an ogg vorbis (.ogg) file. More...
 
 CL_SoundProvider_Vorbis (const CL_String &fullname, bool stream=false)
 
 CL_SoundProvider_Vorbis (CL_IODevice &file, bool stream=false)
 
virtual ~CL_SoundProvider_Vorbis ()
 
Operations
virtual CL_SoundProvider_Sessionbegin_session ()
 Called by CL_SoundBuffer when a new session starts. More...
 
virtual void end_session (CL_SoundProvider_Session *session)
 Called by CL_SoundBuffer when a session has finished. After this call,. More...
 

Implementation

class CL_SoundProvider_Vorbis_Session
 

Detailed Description

Ogg Vorbis format sound provider.

Constructor & Destructor Documentation

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

Constructs a sound provider based on an ogg vorbis (.ogg) file.

Parameters
filenameFilename of module file.
providerInput source provider used to retrieve module file.
streamIf true, will stream from disk. If false, will load it to memory.
CL_SoundProvider_Vorbis::CL_SoundProvider_Vorbis ( const CL_String fullname,
bool  stream = false 
)
CL_SoundProvider_Vorbis::CL_SoundProvider_Vorbis ( CL_IODevice file,
bool  stream = false 
)
virtual CL_SoundProvider_Vorbis::~CL_SoundProvider_Vorbis ( )
virtual

Member Function Documentation

virtual CL_SoundProvider_Session* CL_SoundProvider_Vorbis::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_Vorbis::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_Vorbis_Session
friend

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