Previous Topic Index Next Topic
[API function]

FSOUND_Stream_SetBufferSize

Sets the internal file buffersize for audio streaming of data for the NEXT stream opened with
FSOUND_Stream_OpenFile. Larger values will consume more memory (see remarks), whereas smaller values may be subject to large delays in disk access, especially from CDROM.

signed char F_API FSOUND_Stream_SetBufferSize(
int ms
);

Parameters

ms Time in milliseconds between stream updates. FMOD tries to access the disk and
decompress data every period specified. Values less than 50 result in an error.

Return Value

On success, TRUE is returned.
On failure, FALSE is returned.

Remarks

The default setting is 200ms. Under Windows CE it is default to 100ms.
To calculate memory usage for a stream buffer, it is a simple matter of calculating sizebytes = streambuffersize * sample rate / 1000 * (bitdepth / 8) * numchannels * 2, where numchannels is 1 for mono,
or 2 for stereo files. It is multiplied by 2 because FSOUND stream buffers are double buffers.
Note this function does not affect user created streams, as the buffer size is specified in FSOUND_Stream_Create.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2

See Also

FSOUND_Stream_Create , FSOUND_Stream_OpenFile

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Fri Dec 20 16:31:09 2002 by SourceDoc v0.10, the automated source code documenter.