NS/main/source/includes/fmodapi375linux/documentation/HTML/FSOUND_Stream_SetSubStreamSentence.html

<HTML>
<HEAD>
<META NAME="GENERATOR" Content="SOURCEDOC.EXE">
<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>FSOUND_Stream_SetSubStreamSentence</TITLE>
<STYLE>
#flush {margin-left: -10p; margin-right: -0p}
#buttonbar {color: white}
</STYLE>
</HEAD>
<BODY TOPMARGIN=0 BGPROPERTIES="FIXED" BGCOLOR="white">
<FONT FACE="ARIAL">
<SPAN ID="flush">
<A NAME="SEE ALSO">
<TABLE WIDTH="100%" COLS=2 BORDER=0 BGCOLOR="#000000">
<TR ALIGN=RIGHT>
<TD ALIGN=LEFT>
<IMG SRC="banner03.gif" WIDTH="88" HEIGHT="31"  BORDER=0>
</TD>
<TD ALIGN=RIGHT VALIGN=TOP>
<FONT FACE="ARIAL" SIZE="2">
<A ID=buttonbar HREF="FSOUND_Stream_SetSubStream.html">
<IMG SRC="u_prev.gif" WIDTH="71" HEIGHT="16"  BORDER=0 ALT="Previous Topic">
</A>
<A ID=buttonbar HREF="FSOUND.html">
<IMG SRC="u_index.gif" WIDTH="47" HEIGHT="16"  BORDER=0 ALT="Index">
</A>
<A ID=buttonbar HREF="FSOUND_Stream_SetSyncCallback.html">
<IMG SRC="u_next.gif" WIDTH="48" HEIGHT="16"  BORDER=0 ALT="Next Topic">
</A>
</FONT></TD><TD WIDTH=15></TD>
</TR>
</TABLE>
</A>
</SPAN>
<A HREF="FSOUND.html#Functions"><H5>[API function]</A></H5>
<H2><A NAME="FSOUND_Stream_SetSubStreamSentence">FSOUND_Stream_SetSubStreamSentence</A></H2>
This function allows the user to describe the playback order of a list of substreams.  The substreams will be played back in order seamlessly.<BR>
<P>
<B>signed char F_API </B><B> </B><B>FSOUND_Stream_SetSubStreamSentence</B><B>(</B><BR>
<B>FSOUND_STREAM *</B><I>stream</I><B>,</B><BR>
<B>const int *</B><I>sentencelist</I><B>,</B><BR>
<B>int </B><B> </B><I>numitems</I><BR>
<B>);</B><BR>
<H3>Parameters</H3>
<TABLE>
<TR VALIGN=top><TD><I>stream</I></TD>
<TD>Pointer to the stream to have its position returned.<BR>
</TD><TR VALIGN=top><TD><I>sentencelist</I></TD>
<TD>This is a pointer to an array of 32bit integers, describing a list of substream indicies to play back.<BR>
</TD><TR VALIGN=top><TD><I>numitems</I></TD>
<TD>The number of entries in the sentence list.<BR>
</TD></TABLE>
<H3>Return Value</H3>
On success, TRUE is returned.<BR>
On failure, FALSE is returned.<BR>
<H3>Remarks</H3>
This feature only works with FSB files that have multiple streams stored within it.<BR>
To remove any sentence, simply call this function with NULL and 0.<BR>
FMOD copies the list from the supplied pointer.  Once the pointer is used, the caller can discard the original array.<BR>
This function will fail if the stream is playing.  The stream must be stopped for it to work.<BR>
------------<BR>
If the stream is opened with FSOUND_NONBLOCKING, and the stream is not ready (it is still opening), then this function will return FALSE.<BR>
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.<BR>
You then have to poll after calling this to make sure the stream is ready.<BR>
You can either do this by calling FSOUND_Stream_Play repeatedly/once a frame until it is succeeds, or FSOUND_Stream_GetOpenState.<BR>
___________________<BR>
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube<BR>
<H3>See Also</H3>
<A HREF="FSOUND_Stream_GetNumSubStreams.html">FSOUND_Stream_GetNumSubStreams</A>
, 
<A HREF="FSOUND_Stream_GetOpenState.html">FSOUND_Stream_GetOpenState</A>
, 
<A HREF="FSOUND_Stream_Play.html">FSOUND_Stream_Play</A>
, 
<A HREF="FSOUND_Stream_SetSubStream.html">FSOUND_Stream_SetSubStream</A>
<HR><BR><FONT SIZE="-2">This document copyright &copy;Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.</FONT><BR>
<FONT SIZE="-2">Generated Thu Dec 15 17:31:36 2005
 by SourceDoc v0.10, the automated source code documenter.</FONT><BR>
</BODY>
</HTML>
Update line endings Change CRLF to LF in repo. 2018-04-22 15:55:55 +00:00			`<HTML>`
			`<HEAD>`
			`<META NAME="GENERATOR" Content="SOURCEDOC.EXE">`
			`<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">`
			`<TITLE>FSOUND_Stream_SetSubStreamSentence</TITLE>`
			`<STYLE>`
			`#flush {margin-left: -10p; margin-right: -0p}`
			`#buttonbar {color: white}`
			`</STYLE>`
			`</HEAD>`
			`<BODY TOPMARGIN=0 BGPROPERTIES="FIXED" BGCOLOR="white">`
			`<FONT FACE="ARIAL">`
			`<SPAN ID="flush">`
			`<A NAME="SEE ALSO">`
			`<TABLE WIDTH="100%" COLS=2 BORDER=0 BGCOLOR="#000000">`
			`<TR ALIGN=RIGHT>`
			`<TD ALIGN=LEFT>`
			`<IMG SRC="banner03.gif" WIDTH="88" HEIGHT="31" BORDER=0>`
			`</TD>`
			`<TD ALIGN=RIGHT VALIGN=TOP>`
			`<FONT FACE="ARIAL" SIZE="2">`
			`<A ID=buttonbar HREF="FSOUND_Stream_SetSubStream.html">`
			`<IMG SRC="u_prev.gif" WIDTH="71" HEIGHT="16" BORDER=0 ALT="Previous Topic">`
			`</A>`
			`<A ID=buttonbar HREF="FSOUND.html">`
			`<IMG SRC="u_index.gif" WIDTH="47" HEIGHT="16" BORDER=0 ALT="Index">`
			`</A>`
			`<A ID=buttonbar HREF="FSOUND_Stream_SetSyncCallback.html">`
			`<IMG SRC="u_next.gif" WIDTH="48" HEIGHT="16" BORDER=0 ALT="Next Topic">`
			`</A>`
			`</FONT></TD><TD WIDTH=15></TD>`
			`</TR>`
			`</TABLE>`
			`</A>`
			`</SPAN>`
			`<A HREF="FSOUND.html#Functions"><H5>[API function]</A></H5>`
			`<H2><A NAME="FSOUND_Stream_SetSubStreamSentence">FSOUND_Stream_SetSubStreamSentence</A></H2>`
			`This function allows the user to describe the playback order of a list of substreams. The substreams will be played back in order seamlessly.<BR>`
			`<P>`
			`<B>signed char F_API </B><B> </B><B>FSOUND_Stream_SetSubStreamSentence</B><B>(</B><BR>`
			`<B>FSOUND_STREAM *</B><I>stream</I><B>,</B><BR>`
			`<B>const int *</B><I>sentencelist</I><B>,</B><BR>`
			`<B>int </B><B> </B><I>numitems</I><BR>`
			`<B>);</B><BR>`
			`<H3>Parameters</H3>`
			`<TABLE>`
			`<TR VALIGN=top><TD><I>stream</I></TD>`
			`<TD>Pointer to the stream to have its position returned.<BR>`
			`</TD><TR VALIGN=top><TD><I>sentencelist</I></TD>`
			`<TD>This is a pointer to an array of 32bit integers, describing a list of substream indicies to play back.<BR>`
			`</TD><TR VALIGN=top><TD><I>numitems</I></TD>`
			`<TD>The number of entries in the sentence list.<BR>`
			`</TD></TABLE>`
			`<H3>Return Value</H3>`
			`On success, TRUE is returned.<BR>`
			`On failure, FALSE is returned.<BR>`
			`<H3>Remarks</H3>`
			`This feature only works with FSB files that have multiple streams stored within it.<BR>`
			`To remove any sentence, simply call this function with NULL and 0.<BR>`
			`FMOD copies the list from the supplied pointer. Once the pointer is used, the caller can discard the original array.<BR>`
			`This function will fail if the stream is playing. The stream must be stopped for it to work.<BR>`
			`------------<BR>`
			`If the stream is opened with FSOUND_NONBLOCKING, and the stream is not ready (it is still opening), then this function will return FALSE.<BR>`
			`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.<BR>`
			`You then have to poll after calling this to make sure the stream is ready.<BR>`
			`You can either do this by calling FSOUND_Stream_Play repeatedly/once a frame until it is succeeds, or FSOUND_Stream_GetOpenState.<BR>`
			`___________________<BR>`
			`Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube<BR>`
			`<H3>See Also</H3>`
			`<A HREF="FSOUND_Stream_GetNumSubStreams.html">FSOUND_Stream_GetNumSubStreams</A>`
			`,`
			`<A HREF="FSOUND_Stream_GetOpenState.html">FSOUND_Stream_GetOpenState</A>`
			`,`
			`<A HREF="FSOUND_Stream_Play.html">FSOUND_Stream_Play</A>`
			`,`
			`<A HREF="FSOUND_Stream_SetSubStream.html">FSOUND_Stream_SetSubStream</A>`
			`<HR><BR><FONT SIZE="-2">This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.</FONT><BR>`
			`<FONT SIZE="-2">Generated Thu Dec 15 17:31:36 2005`
			`by SourceDoc v0.10, the automated source code documenter.</FONT><BR>`
			`</BODY>`
			`</HTML>`