Previous Topic Index Next Topic
[API function]

FSOUND_Stream_GetOpenState

If a stream is opened with FSOUND_NONBLOCKING, this function returns the state of the opening stream.

int F_API FSOUND_Stream_GetOpenState(
FSOUND_STREAM *stream
);

Parameters

stream Pointer to the stream to be closed down.

Return Value

0 = stream is opened and ready.
-1 = stream handle passed in is invalid.
-2 = stream is still opening
-3 = stream failed to open. (file not found, out of memory or other error).

Remarks

A blocking stream will return NULL from FSOUND_Stream_OpenFile so a return value of -3 is redundant in this case.
A blocking stream will always return 0 if it is not NULL.
On PlayStation 2, it is faster to use FSOUND_Stream_Play than call this function.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2

See Also

FSOUND_Stream_OpenFile , FSOUND_Stream_Play

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.