clanVorbis Sound Providers

Classes

class  clan::SoundProvider_Vorbis
 Ogg Vorbis format sound provider. More...
 

Construction

 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. More...
 
 clan::SoundProvider_Vorbis::SoundProvider_Vorbis (const std::string &fullname, bool stream=false)
 
 clan::SoundProvider_Vorbis::SoundProvider_Vorbis (IODevice &file, bool stream=false)
 
virtual clan::SoundProvider_Vorbis::~SoundProvider_Vorbis ()
 

Operations

virtual SoundProvider_Sessionclan::SoundProvider_Vorbis::begin_session () override
 Called by SoundBuffer when a new session starts. More...
 
virtual void clan::SoundProvider_Vorbis::end_session (SoundProvider_Session *session) override
 Called by SoundBuffer when a session has finished. After this call,. More...
 

Implementation

class clan::SoundProvider_Vorbis::SoundProvider_Vorbis_Session
 

Detailed Description

Function 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()

virtual clan::SoundProvider_Vorbis::~SoundProvider_Vorbis ( )
virtual

◆ begin_session()

virtual 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()

virtual 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

◆ SoundProvider_Vorbis_Session

friend class SoundProvider_Vorbis_Session
friend