ClanSoft logo
ClanSoft logo
Entire Class Index Main Class Index Cross Index Global Index

Class CL_VorbisSoundProvider

Vorbis Sound Provider Class
Contained in: global
Derived from: CL_StreamSoundProvider
Derived by: none
Group: Vorbis (Sound Providers)

#include <ClanLib/vorbis.h>


public function member index:

Construction:

CL_VorbisSoundProvider(const std::string& name, CL_InputSourceProvider* provider = NULL, bool delete_provider = false);
CL_VorbisSoundProvider(const std::string& name, CL_ResourceManager* resources);
virtual ~CL_VorbisSoundProvider();

Operations:

virtual CL_StreamSoundProvider_Session* begin_session();
virtual void end_session(CL_StreamSoundProvider_Session* session);
 

private function member index:

Implementation:

CL_VorbisSoundProvider(const CL_VorbisSoundProvider& copy);
 

Description:


Function Member Descriptions:

CL_VorbisSoundProvider::CL_VorbisSoundProvider - Vorbis Sound Provider Constructor
CL_VorbisSoundProvider(const std::string& name, CL_InputSourceProvider* provider = NULL, bool delete_provider = false);
name - The name of the file, either it's filename or descriptor from 'provider'
provider - the InputsourceProvider to use
delete_provider - If true, 'provider' will be delete when the destructor is called



CL_VorbisSoundProvider::CL_VorbisSoundProvider - Vorbis Sound Provider Constructor
CL_VorbisSoundProvider(const std::string& name, CL_ResourceManager* resources);
name - The name of the vorbis file in 'resources'
resources - The ResourceManager to use to access the resource identified by 'name'



CL_VorbisSoundProvider::begin_session - Begin Session
virtual CL_StreamSoundProvider_Session* begin_session();
Returns - A CL_StreamSoundProvider_Session object for the resource named in the constructor



CL_VorbisSoundProvider::end_session - End Session
Deletes the object 'session'
virtual void end_session(CL_StreamSoundProvider_Session* session);
session - The CL_StreamSoundProvider_Session to be deleted



CL_VorbisSoundProvider::~CL_VorbisSoundProvider - Vorbis Sound Provider Destructor
virtual ~CL_VorbisSoundProvider();



Variable Member Descriptions: