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

<HTML>
<HEAD>
<META NAME="GENERATOR" Content="SOURCEDOC.EXE">
<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>FSOUND_GetNumSubChannels</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_GetNumHWChannels.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_GetOutput.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_GetNumSubChannels">FSOUND_GetNumSubChannels</A></H2>
This function returns the number of sub-channels stored in a multi-channel channel handle, which is only possible when playing back a multichannel .FSB file.<BR>
<P>
<B>int F_API </B><B> </B><B>FSOUND_GetNumSubChannels</B><B>(</B><BR>
<B>int </B><B> </B><I>channel</I><BR>
<B>);</B><BR>
<H3>Parameters</H3>
<TABLE>
<TR VALIGN=top><TD><I>channel</I></TD>
<TD>The value returned by FSOUND_Stream_Play, FSOUND_Stream_PlayEx, FSOUND_PlaySound, FSOUND_PlaySoundEx.<BR>
</TD></TABLE>
<H3>Return Value</H3>
On success, the number of subchannels is returned<BR>
On failure, 0 is returned.<BR>
<H3>Remarks</H3>
A multichannel sound, only possible with the .FSB format, can contain multiple subchannels.  When a multichannel sound is played, multiple channels are allocated at the same time.<BR>
For example, a 8 sounds/streams can be interleaved into a multichannel FSB.  This function would return 8, as 8 real hardware/software voices are used during playback.<BR>
FSOUND_GetSubChannel can be used to get access to the secondary channels.<BR>
___________________<BR>
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube<BR>
<H3>See Also</H3>
<A HREF="FSOUND_GetSubChannel.html">FSOUND_GetSubChannel</A>
, 
<A HREF="FSOUND_PlaySound.html">FSOUND_PlaySound</A>
, 
<A HREF="FSOUND_PlaySoundEx.html">FSOUND_PlaySoundEx</A>
, 
<A HREF="FSOUND_Stream_Play.html">FSOUND_Stream_Play</A>
, 
<A HREF="FSOUND_Stream_PlayEx.html">FSOUND_Stream_PlayEx</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:30 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_GetNumSubChannels</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_GetNumHWChannels.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_GetOutput.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_GetNumSubChannels">FSOUND_GetNumSubChannels</A></H2>`
			`This function returns the number of sub-channels stored in a multi-channel channel handle, which is only possible when playing back a multichannel .FSB file.<BR>`
			`<P>`
			`<B>int F_API </B><B> </B><B>FSOUND_GetNumSubChannels</B><B>(</B><BR>`
			`<B>int </B><B> </B><I>channel</I><BR>`
			`<B>);</B><BR>`
			`<H3>Parameters</H3>`
			`<TABLE>`
			`<TR VALIGN=top><TD><I>channel</I></TD>`
			`<TD>The value returned by FSOUND_Stream_Play, FSOUND_Stream_PlayEx, FSOUND_PlaySound, FSOUND_PlaySoundEx.<BR>`
			`</TD></TABLE>`
			`<H3>Return Value</H3>`
			`On success, the number of subchannels is returned<BR>`
			`On failure, 0 is returned.<BR>`
			`<H3>Remarks</H3>`
			`A multichannel sound, only possible with the .FSB format, can contain multiple subchannels. When a multichannel sound is played, multiple channels are allocated at the same time.<BR>`
			`For example, a 8 sounds/streams can be interleaved into a multichannel FSB. This function would return 8, as 8 real hardware/software voices are used during playback.<BR>`
			`FSOUND_GetSubChannel can be used to get access to the secondary channels.<BR>`
			`___________________<BR>`
			`Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube<BR>`
			`<H3>See Also</H3>`
			`<A HREF="FSOUND_GetSubChannel.html">FSOUND_GetSubChannel</A>`
			`,`
			`<A HREF="FSOUND_PlaySound.html">FSOUND_PlaySound</A>`
			`,`
			`<A HREF="FSOUND_PlaySoundEx.html">FSOUND_PlaySoundEx</A>`
			`,`
			`<A HREF="FSOUND_Stream_Play.html">FSOUND_Stream_Play</A>`
			`,`
			`<A HREF="FSOUND_Stream_PlayEx.html">FSOUND_Stream_PlayEx</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:30 2005`
			`by SourceDoc v0.10, the automated source code documenter.</FONT><BR>`
			`</BODY>`
			`</HTML>`