Torque3D Documentation / _generateds / SFXWavStream

SFXWavStream

Engine/source/sfx/media/sfxWavStream.h

An SFXFileStream that loads sample data from a WAV file.

More...

Public Types

SFXFileStream

Parent

Protected Attributes

U32

mDataStart

The file position of the start of the PCM data for fast reset().

Protected Functions

void

_close()

Overloaded for cleanup of file format specific structures.

bool

_readHeader()

Overloaded in the derived classes to read the file header.

Public Static Functions

SFXWavStream *

create(Stream * stream)

Public Functions

SFXWavStream()

SFXWavStream(const SFXWavStream & cloneFrom)

~SFXWavStream()

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

getPosition()

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.
void

setPosition(U32 pos)

Set the current position to be "pos".
Detailed Description
An SFXFileStream that loads sample data from a WAV file.
Public Types
typedef SFXFileStream Parent 

Protected Attributes
U32 mDataStart 

The file position of the start of the PCM data for fast reset().
Protected Functions
_close()

Reimplemented from: SFXFileStream
_readHeader()

Reimplemented from: SFXFileStream
Public Static Functions
create(Stream * stream)

Public Functions
SFXWavStream()

SFXWavStream(const SFXWavStream & cloneFrom)

~SFXWavStream()

Destructor.
clone()

Reimplemented from: SFXStream
getPosition()

Reimplemented from: IPositionable
read(U8 * buffer, U32 length)

Reimplemented from: SFXStream
reset()

Reimplemented from: SFXStream
setPosition(U32 pos)

Reimplemented from: IPositionable