# Home    # nevrax.com   
Nevrax
Nevrax.org
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
Docs
 
Documentation  
Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  

NLSOUND::ISoundDriver Class Reference

Abstract sound driver (implemented in sound driver dynamic library). More...

#include <sound_driver.h>

Inheritance diagram for NLSOUND::ISoundDriver:

NLSOUND::CSoundDriverAL NLSOUND::CSoundDriverDSound List of all members.

Public Methods

virtual IBuffercreateBuffer ()=0
 Create a sound buffer. More...

virtual IListenercreateListener ()=0
 Create the listener instance. More...

virtual uint countMaxSources ()=0
 Return the maximum number of sources that can created. More...

virtual ISourcecreateSource ()=0
 Create a source. More...

virtual bool loadWavFile (IBuffer *destbuffer, const char *filename)=0
 Temp. More...

virtual void commit3DChanges ()=0
 Commit all the changes made to 3D settings of listener and sources. More...

virtual void writeProfile (std::ostream &out)=0
 Write information about the driver to the output stream. More...

virtual ~ISoundDriver ()
 Destructor. More...


Static Public Methods

ISoundDriver * createDriver ()
 The static method which builds the sound driver instance In case of failure, can throw one of these ESoundDriver exception objects: ESoundDriverNotFound, ESoundDriverCorrupted, ESoundDriverOldVersion, ESoundDriverUnknownVersion. More...


Static Public Attributes

const uint32 InterfaceVersion = 0x04
 Version of the driver interface. To increment when the interface change. More...


Protected Methods

 ISoundDriver ()
 Constructor. More...

virtual void removeBuffer (IBuffer *buffer)=0
 Remove a buffer (should be called by the friend destructor of the buffer class). More...

virtual void removeSource (ISource *source)=0
 Remove a source (should be called by the friend destructor of the source class). More...


Detailed Description

Abstract sound driver (implemented in sound driver dynamic library).

The caller of the create methods is responsible for the deletion of the created objects. These objects must be deleted before deleting the ISoundDriver instance.

The driver is a singleton. To access, only the pointer returned by createDriver() is provided.

Author:
Olivier Cado , Nevrax France
Date:
2001

Definition at line 95 of file sound_driver.h.


Constructor & Destructor Documentation

virtual NLSOUND::ISoundDriver::~ISoundDriver   [inline, virtual]
 

Destructor.

Definition at line 133 of file sound_driver.h.

NLSOUND::ISoundDriver::ISoundDriver   [inline, protected]
 

Constructor.

Definition at line 138 of file sound_driver.h.

Referenced by createDriver.


Member Function Documentation

virtual void NLSOUND::ISoundDriver::commit3DChanges   [pure virtual]
 

Commit all the changes made to 3D settings of listener and sources.

Implemented in NLSOUND::CSoundDriverDSound.

virtual uint NLSOUND::ISoundDriver::countMaxSources   [pure virtual]
 

Return the maximum number of sources that can created.

Implemented in NLSOUND::CSoundDriverDSound.

virtual IBuffer* NLSOUND::ISoundDriver::createBuffer   [pure virtual]
 

Create a sound buffer.

Implemented in NLSOUND::CSoundDriverDSound.

ISoundDriver * NLSOUND::ISoundDriver::createDriver   [static]
 

The static method which builds the sound driver instance In case of failure, can throw one of these ESoundDriver exception objects: ESoundDriverNotFound, ESoundDriverCorrupted, ESoundDriverOldVersion, ESoundDriverUnknownVersion.

Definition at line 59 of file sound_driver.cpp.

References NLSOUND::IDRV_CREATE_PROC_NAME, NLSOUND::IDRV_VERSION_PROC_NAME, NLSOUND::ISDRV_CREATE_PROC, NLSOUND::ISDRV_VERSION_PROC, ISoundDriver, nlinfo, and nlwarning.

virtual IListener* NLSOUND::ISoundDriver::createListener   [pure virtual]
 

Create the listener instance.

Implemented in NLSOUND::CSoundDriverDSound.

virtual ISource* NLSOUND::ISoundDriver::createSource   [pure virtual]
 

Create a source.

Implemented in NLSOUND::CSoundDriverDSound.

virtual bool NLSOUND::ISoundDriver::loadWavFile IBuffer   destbuffer,
const char *    filename
[pure virtual]
 

Temp.

Implemented in NLSOUND::CSoundDriverDSound.

virtual void NLSOUND::ISoundDriver::removeBuffer IBuffer   buffer [protected, pure virtual]
 

Remove a buffer (should be called by the friend destructor of the buffer class).

Implemented in NLSOUND::CSoundDriverDSound.

virtual void NLSOUND::ISoundDriver::removeSource ISource   source [protected, pure virtual]
 

Remove a source (should be called by the friend destructor of the source class).

Implemented in NLSOUND::CSoundDriverDSound.

virtual void NLSOUND::ISoundDriver::writeProfile std::ostream &    out [pure virtual]
 

Write information about the driver to the output stream.

Implemented in NLSOUND::CSoundDriverDSound.


Member Data Documentation

const uint32 NLSOUND::ISoundDriver::InterfaceVersion = 0x04 [static]
 

Version of the driver interface. To increment when the interface change.

Definition at line 46 of file sound_driver.cpp.


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