SFXStream

Inheritance diagram for SFXStream ↕

The base sound data streaming interface.

Public Types

void

Parent

~SFXStream()

Destructor.

SFXStream *

clone()

Make a copy of this stream with its own private state, so new independent read() operations can be issued on the same data stream.

U32

getDataLength()

The data size in bytes of the decompressed PCM data.

U32

getDuration()

The length of the sound in milliseconds.

const SFXFormat &

getFormat()

The format of the data in the stream.

U32

getSampleCount()

The number of samples in the data stream.

bool

isEOS()

Returns true if we've reached the end of the stream.

U32

read(U8 * buffer, U32 length)

Reads data from the stream and decompresses it into PCM samples.

void

reset()

Resets the stream to restart reading data from the begining.

The base sound data streaming interface.

note:
Streams that support seeking should implement the IPositionable interface.

note:
Since SFXStreams are byte streams, all offset/size information is in bytes and not in number of samples.

typedef void Parent

~SFXStream()

Destructor.

clone()

Make a copy of this stream with its own private state, so new independent read() operations can be issued on the same data stream.

return:

Returns a copy of the stream or NULL.

Reimplemented by: SFXWavStream

getDataLength()

The data size in bytes of the decompressed PCM data.

getDuration()

The length of the sound in milliseconds.

getFormat()

The format of the data in the stream.

getSampleCount()

The number of samples in the data stream.

isEOS()

Returns true if we've reached the end of the stream.

read(U8 * buffer, U32 length)

Reimplemented from: IInputStream

reset()

Reimplemented from: IResettable