FSOUND_Stream_SetSubStreamSentence

##### [API function]

## FSOUND_Stream_SetSubStreamSentence

This function allows the user to describe the playback order of a list of substreams. The substreams will be played back in order seamlessly.

signed char F_API FSOUND_Stream_SetSubStreamSentence(
FSOUND_STREAM *stream,
const int *sentencelist,
int numitems
);

### Parameters

stream | Pointer to the stream to have its position returned.
sentencelist | This is a pointer to an array of 32bit integers, describing a list of substream indicies to play back.
numitems | The number of entries in the sentence list.

### Return Value

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

### Remarks

This feature only works with FSB files that have multiple streams stored within it.
To remove any sentence, simply call this function with NULL and 0.
FMOD copies the list from the supplied pointer. Once the pointer is used, the caller can discard the original array.
This function will fail if the stream is playing. The stream must be stopped for it to work.
------------
If the stream is opened with FSOUND_NONBLOCKING, and the stream is not ready (it is still opening), then this function will return FALSE.
When it is ready, it will return TRUE, but after this call the stream is put back into a non-ready state, because it is asynchronously seeking again.
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 : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FSOUND_Stream_GetNumSubStreams , FSOUND_Stream_GetOpenState , FSOUND_Stream_Play , FSOUND_Stream_SetSubStream

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.