[API function]
Seeks a stream to the substream inside a multi-stream FSB bank file, specified by its index.
signed char F_API FSOUND_Stream_SetSubStream(
FSOUND_STREAM *stream,
int index
);
Parameters
stream |
Handle to the stream to have its position set.
|
index |
The index of the stream within the FSB file.
|
Return Value
On success, TRUE is returned.
On failure, FALSE is returned.
Remarks
A stream will stop if this function is called, as it needs to seek and flush the buffer.
Indicies for this function are generated as user friendly constants when compiling the FSB bank, and are available in the relevant generated header file.
This function will be supported on all platforms in the future.
--------------
If the stream has been opened with FSOUND_NONBLOCKING, this function will ALWAYS succeed, but puts the stream back into a non-ready state. You then have to poll after calling this to make sure the stream is ready.
You can either do this by calling FSOUND_Stream_Play repeatedly/once a frame until it is succeeds, or FSOUND_Stream_GetOpenState.
___________________
Supported on the following platforms : PlayStation 2, GameCube
See Also
FSOUND_Stream_GetNumSubStreams
,
FSOUND_Stream_GetOpenState
,
FSOUND_Stream_Play
,
FSOUND_Stream_SetSubStreamSentence
This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Fri Sep 05 18:50:23 2003
by SourceDoc v0.10, the automated source code documenter.