FSOUND_Stream_Stop

##### [API function]

## FSOUND_Stream_Stop

Stops a stream from playing.

signed char F_API FSOUND_Stream_Stop(
FSOUND_STREAM *stream
);

### Parameters

stream | Pointer to a stream to stop.

### Return Value

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

### Remarks

The stream is still prepared and sitting in memory ready to go. Use FSOUND_Stream_Close on the stream to completely remove it.
If the stream has been opened with FSOUND_NONBLOCKING, this function will not succeed until the stream is ready.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FSOUND_Stream_Close , FSOUND_Stream_Create , FSOUND_Stream_Net_GetBufferProperties , FSOUND_Stream_Net_GetLastServerStatus , FSOUND_Stream_Net_GetStatus , FSOUND_Stream_Net_SetBufferProperties , FSOUND_Stream_Net_SetMetadataCallback , FSOUND_Stream_Net_SetProxy , FSOUND_Stream_Net_SetTimeout , FSOUND_Stream_Open , FSOUND_Stream_Play , FSOUND_Stream_PlayEx

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.