Previous Topic Index Next Topic
[API function]

FSOUND_Stream_SetEndCallback

Sets a callback function for when a stream has ended.

signed char F_API FSOUND_Stream_SetEndCallback(
FSOUND_STREAM *stream,
FSOUND_STREAMCALLBACK callback,
int userdata
);

Parameters

stream Pointer to the stream to callback on when it is finished.
userdata data that is passed into the callback at the end of the stream.

Return Value

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

Remarks

Only calls back when a stream stops. (not when a looping stream reaches its end point)
Note it uses a FSOUND_STREAMCALLBACK function callback. This is normally for user streams but for
the sake of re-usability this prototype is used. 'buff' and 'length' are NULL and 0 in this case
when the callback occurs. The return value can be TRUE or FALSE it is ignored.
A callback occurs if the stream is forcibly stopped or closed.
-----------
WMA/ASF/Internet streaming do not support this function.
--------------
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

See Also

FSOUND_MODES , FSOUND_Stream_Play , FSOUND_STREAMCALLBACK

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.