FSOUND_Stream_SetLoopCount

##### [API function]

## FSOUND_Stream_SetLoopCount

Sets the stream to loop the number of times specified by the user. If not called it loops forever.

signed char F_API FSOUND_Stream_SetLoopCount(
FSOUND_STREAM *stream,
int count
);

### Parameters

stream | Pointer to the stream to set loop count on.
count | Number of times to loop. 0 would be similar to having FSOUND_LOOP_OFF set. <0 is infinity.

### Return Value

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

### Remarks

This specifies how many loops, not how many times to play the sound back. Therefore when you specify 0, you will hear the sound once, if you specify 1, you will hear the sound twice, and so on.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FSOUND_MODES , FSOUND_Stream_Play

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Thu Dec 15 17:31:36 2005 by SourceDoc v0.10, the automated source code documenter.