iSoundData Struct Reference
The sound data is a template used to play sounds. More...
#include <data.h>
Inheritance diagram for iSoundData:
Public Methods | |
| virtual bool | Initialize (const csSoundFormat *fmt)=0 |
| Prepare the sound for output using the given format. | |
| virtual const csSoundFormat* | GetFormat ()=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). More... | |
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.
Member Function Documentation
|
|
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(). |
The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000