CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iSoundData Struct Reference

The sound data is a template used to play sounds. More...

#include <data.h>

Inheritance diagram for iSoundData:

iBase List of all members.

Public Methods

virtual bool Initialize (const csSoundFormat *fmt)=0
 Prepare the sound for output using the given format.

virtual const csSoundFormatGetFormat ()=0
 Get the format of the sound data.

virtual bool IsStatic ()=0
 Return true if this is a static sound, false if it is streamed.

virtual long GetStaticSampleCount ()=0
 Get size of this sound in samples (static sounds only).

virtual void * GetStaticData ()=0
 Get a pointer to the data buffer (static sounds only).

virtual void ResetStreamed ()=0
 Reset the sound to the beginning (streamed sounds only).

virtual void * ReadStreamed (long &NumSamples)=0
 Read a data buffer from the sound (streamed sounds only).


Detailed Description

The sound data is a template used to play sounds.

It represents a sound file just after it was loaded. To play the sound, you must first prepare it and obtain a sound handle.

Definition at line 45 of file data.h.


Member Function Documentation

virtual const csSoundFormat* iSoundData::GetFormat   [pure virtual]
 

Get the format of the sound data.

virtual void* iSoundData::GetStaticData   [pure virtual]
 

Get a pointer to the data buffer (static sounds only).

virtual long iSoundData::GetStaticSampleCount   [pure virtual]
 

Get size of this sound in samples (static sounds only).

virtual bool iSoundData::Initialize const csSoundFormat   fmt [pure virtual]
 

Prepare the sound for output using the given format.

virtual bool iSoundData::IsStatic   [pure virtual]
 

Return true if this is a static sound, false if it is streamed.

virtual void* iSoundData::ReadStreamed long &    NumSamples [pure virtual]
 

Read a data buffer from the sound (streamed sounds only).

The NumSamples parameter is modified to a smaller value if not all samples could be read (i.e. the stream is finished). The returned buffer is valid until the next call to Read().

virtual void iSoundData::ResetStreamed   [pure virtual]
 

Reset the sound to the beginning (streamed sounds only).


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18