clan::SoundProvider_Vorbis Class Reference

Ogg Vorbis format sound provider. More...

#include <soundprovider_vorbis.h>

+ Inheritance diagram for clan::SoundProvider_Vorbis:

Public Member Functions

 SoundProvider_Vorbis (const std::string &filename, const FileSystem &fs, bool stream=false)
 Constructs a sound provider based on an ogg vorbis (.ogg) file.
 
 SoundProvider_Vorbis (const std::string &fullname, bool stream=false)
 
 SoundProvider_Vorbis (IODevice &file, bool stream=false)
 
 ~SoundProvider_Vorbis () override
 
SoundProvider_Sessionbegin_session () override
 Called by SoundBuffer when a new session starts.
 
void end_session (SoundProvider_Session *session) override
 Called by SoundBuffer when a session has finished. After this call,.
 
- Public Member Functions inherited from clan::SoundProvider
 SoundProvider ()
 
virtual ~SoundProvider ()
 

Friends

class SoundProvider_Vorbis_Session
 

Detailed Description

Ogg Vorbis format sound provider.

Constructor & Destructor Documentation

◆ SoundProvider_Vorbis() [1/3]

clan::SoundProvider_Vorbis::SoundProvider_Vorbis ( const std::string & filename,
const FileSystem & fs,
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.

◆ SoundProvider_Vorbis() [2/3]

clan::SoundProvider_Vorbis::SoundProvider_Vorbis ( const std::string & fullname,
bool stream = false )

◆ SoundProvider_Vorbis() [3/3]

clan::SoundProvider_Vorbis::SoundProvider_Vorbis ( IODevice & file,
bool stream = false )

◆ ~SoundProvider_Vorbis()

clan::SoundProvider_Vorbis::~SoundProvider_Vorbis ( )
override

Member Function Documentation

◆ begin_session()

SoundProvider_Session * clan::SoundProvider_Vorbis::begin_session ( )
overridevirtual

Called by SoundBuffer when a new session starts.

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

Implements clan::SoundProvider.

◆ end_session()

void clan::SoundProvider_Vorbis::end_session ( SoundProvider_Session * session)
overridevirtual

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).

Implements clan::SoundProvider.

Friends And Related Symbol Documentation

◆ SoundProvider_Vorbis_Session

friend class SoundProvider_Vorbis_Session
friend

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