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

<HTML>
<HEAD>
<META NAME="GENERATOR" Content="SOURCEDOC.EXE">
<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>FSOUND_Reverb_SetChannelProperties</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_Reverb_GetProperties.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_Reverb_SetProperties.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_Reverb_SetChannelProperties">FSOUND_Reverb_SetChannelProperties</A></H2>
Sets the channel specific reverb properties for hardware, including wet/dry mix (room size), and things like obstruction and occlusion properties.<BR>
<P>
<B>signed char F_API </B><B> </B><B>FSOUND_Reverb_SetChannelProperties</B><B>(</B><BR>
<B>int </B><B> </B><I>channel</I><B>,</B><BR>
<B>const FSOUND_REVERB_CHANNELPROPERTIES *</B><I>prop</I><BR>
<B>);</B><BR>
<H3>Parameters</H3>
<TABLE>
<TR VALIGN=top><TD><I>channel</I></TD>
<TD>The channel to have its reverb properties changed.  FSOUND_ALL can also be used (see remarks)<BR>
</TD><TR VALIGN=top><TD><I>prop</I></TD>
<TD>Pointer to a FSOUND_REVERB_CHANNELPROPERTIES structure definition.  The definition for this structure is given in the link below.<BR>
</TD></TABLE>
<H3>Return Value</H3>
On success, TRUE is returned.<BR>
On failure, FALSE is returned.<BR>
<H3>Remarks</H3>
FSOUND_ALL is supported here.  Passing this will set ALL channels to specified reverb properties.<BR>
If FSOUND_ALL is used the last channel success flag will be returned.  This return value not useful in most circumstances.<BR>
-----------------<BR>
Under Win32, you must be using FSOUND_OUTPUT_DSOUND as the output mode for this to work.  <BR>
In DSound, the reverb will only work if you have an	EAX compatible soundcard such as the SBLive, and your sample/stream was created with the FSOUND_HW3D flag.<BR>
-----------------<BR>
On PlayStation2, the 'Room' parameter is the only parameter supported.  The hardware only allows 'on' or 'off', so the reverb will be off when 'Room' is -10000 and on for every other value.<BR>
-----------------<BR>
On XBox, it is possible to apply reverb to 2d voices using this function.  By default reverb is turned off for 2d voices.<BR>
If this 2d voice was being positioned in a 5.1 array with the xbox only function FSOUND_SetLevels, then calling this function will disable that capability in favour of enabling reverb for the 2d voice.<BR>
It is a limitation of the xbox hardware that only one of the other of these features can be executed at one time.<BR>
___________________<BR>
Supported on the following platforms : Win32, XBox, PlayStation 2.<BR>
<H3>See Also</H3>
<A HREF="FSOUND_REVERB_CHANNELPROPERTIES.html">FSOUND_REVERB_CHANNELPROPERTIES</A>
, 
<A HREF="FSOUND_Reverb_GetChannelProperties.html">FSOUND_Reverb_GetChannelProperties</A>
, 
<A HREF="FSOUND_Reverb_GetProperties.html">FSOUND_Reverb_GetProperties</A>
, 
<A HREF="FSOUND_Reverb_SetProperties.html">FSOUND_Reverb_SetProperties</A>
, 
<A HREF="FSOUND_SetLevels.html">FSOUND_SetLevels</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:31 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_Reverb_SetChannelProperties</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_Reverb_GetProperties.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_Reverb_SetProperties.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_Reverb_SetChannelProperties">FSOUND_Reverb_SetChannelProperties</A></H2>`
			`Sets the channel specific reverb properties for hardware, including wet/dry mix (room size), and things like obstruction and occlusion properties.<BR>`
			`<P>`
			`<B>signed char F_API </B><B> </B><B>FSOUND_Reverb_SetChannelProperties</B><B>(</B><BR>`
			`<B>int </B><B> </B><I>channel</I><B>,</B><BR>`
			`<B>const FSOUND_REVERB_CHANNELPROPERTIES *</B><I>prop</I><BR>`
			`<B>);</B><BR>`
			`<H3>Parameters</H3>`
			`<TABLE>`
			`<TR VALIGN=top><TD><I>channel</I></TD>`
			`<TD>The channel to have its reverb properties changed. FSOUND_ALL can also be used (see remarks)<BR>`
			`</TD><TR VALIGN=top><TD><I>prop</I></TD>`
			`<TD>Pointer to a FSOUND_REVERB_CHANNELPROPERTIES structure definition. The definition for this structure is given in the link below.<BR>`
			`</TD></TABLE>`
			`<H3>Return Value</H3>`
			`On success, TRUE is returned.<BR>`
			`On failure, FALSE is returned.<BR>`
			`<H3>Remarks</H3>`
			`FSOUND_ALL is supported here. Passing this will set ALL channels to specified reverb properties.<BR>`
			`If FSOUND_ALL is used the last channel success flag will be returned. This return value not useful in most circumstances.<BR>`
			`-----------------<BR>`
			`Under Win32, you must be using FSOUND_OUTPUT_DSOUND as the output mode for this to work. <BR>`
			`In DSound, the reverb will only work if you have an EAX compatible soundcard such as the SBLive, and your sample/stream was created with the FSOUND_HW3D flag.<BR>`
			`-----------------<BR>`
			`On PlayStation2, the 'Room' parameter is the only parameter supported. The hardware only allows 'on' or 'off', so the reverb will be off when 'Room' is -10000 and on for every other value.<BR>`
			`-----------------<BR>`
			`On XBox, it is possible to apply reverb to 2d voices using this function. By default reverb is turned off for 2d voices.<BR>`
			`If this 2d voice was being positioned in a 5.1 array with the xbox only function FSOUND_SetLevels, then calling this function will disable that capability in favour of enabling reverb for the 2d voice.<BR>`
			`It is a limitation of the xbox hardware that only one of the other of these features can be executed at one time.<BR>`
			`___________________<BR>`
			`Supported on the following platforms : Win32, XBox, PlayStation 2.<BR>`
			`<H3>See Also</H3>`
			`<A HREF="FSOUND_REVERB_CHANNELPROPERTIES.html">FSOUND_REVERB_CHANNELPROPERTIES</A>`
			`,`
			`<A HREF="FSOUND_Reverb_GetChannelProperties.html">FSOUND_Reverb_GetChannelProperties</A>`
			`,`
			`<A HREF="FSOUND_Reverb_GetProperties.html">FSOUND_Reverb_GetProperties</A>`
			`,`
			`<A HREF="FSOUND_Reverb_SetProperties.html">FSOUND_Reverb_SetProperties</A>`
			`,`
			`<A HREF="FSOUND_SetLevels.html">FSOUND_SetLevels</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:31 2005`
			`by SourceDoc v0.10, the automated source code documenter.</FONT><BR>`
			`</BODY>`
			`</HTML>`