SoundResource Class Reference
[Framework Module]

#include <soundresource.h>

Inheritance diagram for SoundResource:

Resource Root Object TreeNode< Root > Referenced Counted Serialized List< Root > ListNode< Root > OpenALSoundResource

List of all members.


Detailed Description

A sound resource is a container for sound data which can be played back by the AudioServer subsystem.

Sound resources are generally shared and are referenced by Sound objects (there should be one Sound object per "sound instance", but several Sound objects should reference the same SoundResource object, if the Sound objects sound the same).

Public Member Functions

 SoundResource (const char *id)
virtual ~SoundResource ()
virtual bool UpdateStream ()
virtual void RewindStream ()
void SetStreaming (bool b)
void SetLooping (bool b)
bool IsStreaming () const
bool IsLooping () const

Protected Attributes

bool streaming
bool looping
AudioFileaudio_file


Constructor & Destructor Documentation

SoundResource::SoundResource ( const char *  id  ) 

Constructor.

SoundResource::~SoundResource (  )  [virtual]

Destructor.


Member Function Documentation

bool SoundResource::UpdateStream (  )  [virtual]

Reimplemented in OpenALSoundResource.

void SoundResource::RewindStream (  )  [virtual]

Reimplemented in OpenALSoundResource.

void SoundResource::SetStreaming ( bool  b  )  [inline]

Sets static/streaming type.

void SoundResource::SetLooping ( bool  b  )  [inline]

Sets the looping behaviour.

bool SoundResource::IsStreaming (  )  const [inline]

Gets static/streaming type.

bool SoundResource::IsLooping (  )  const [inline]

Gets the looping behaviour.


Member Data Documentation

bool SoundResource::streaming [protected]

bool SoundResource::looping [protected]

AudioFile* SoundResource::audio_file [protected]


The documentation for this class was generated from the following files:
Generated on Sat Oct 20 14:47:36 2007 for Dark Oberon by  doxygen 1.5.3