NS/main/source/includes/fmodapi375linux/documentation/HTML/FSOUND_FX_SetWavesReverb.html
2014-12-16 14:36:27 +01:00

93 lines
3.6 KiB
HTML

<HTML>
<HEAD>
<META NAME="GENERATOR" Content="SOURCEDOC.EXE">
<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>FSOUND_FX_SetWavesReverb</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_FX_SetParamEQ.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_GetAmplitude.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_FX_SetWavesReverb">FSOUND_FX_SetWavesReverb</A></H2>
Sets the parameters for the Waves Reverb effect on a particular channel<BR>
<P>
<B>signed char F_API </B><B> </B><B>FSOUND_FX_SetWavesReverb</B><B>(</B><BR>
<B>int </B><B> </B><I>fxid</I><B>,</B><BR>
<B>float </B><B> </B><I>InGain</I><B>,</B><BR>
<B>float </B><B> </B><I>ReverbMix</I><B>,</B><BR>
<B>float </B><B> </B><I>ReverbTime</I><B>,</B><BR>
<B>float </B><B> </B><I>HighFreqRTRatio</I><BR>
<B>);</B><BR>
<H3>Parameters</H3>
<TABLE>
<TR VALIGN=top><TD><I>fxid</I></TD>
<TD>fx handle generated by FSOUND_FX_Enable, number/handle to set Waves Reverb parameters for.<BR>
</TD><TR VALIGN=top><TD><I>InGain</I></TD>
<TD>Input gain of signal, in decibels (dB), in the range from -96 through 0. The default value is 0 dB. <BR>
</TD><TR VALIGN=top><TD><I>ReverbMix</I></TD>
<TD>Reverb mix, in dB, in the range from -96 through 0. The default value is 0 dB. <BR>
</TD><TR VALIGN=top><TD><I>ReverbTime</I></TD>
<TD>Reverb time, in milliseconds, in the range from .001 through 3000. The default value is 1000. <BR>
</TD><TR VALIGN=top><TD><I>HighFreqRTRatio</I></TD>
<TD>In the range from .001 through .999. The default value is 0.001. <BR>
</TD></TABLE>
<H3>Return Value</H3>
On success, TRUE is returned.<BR>
On failure, FALSE is returned.<BR>
<H3>Remarks</H3>
Make sure you have enabled this effect with FSOUND_FX_WAVES_REVERB before using this function.<BR>
___________________<BR>
Supported on the following platforms : Win32<BR>
<H3>See Also</H3>
<A HREF="FSOUND_FX_Disable.html">FSOUND_FX_Disable</A>
,
<A HREF="FSOUND_FX_Enable.html">FSOUND_FX_Enable</A>
,
<A HREF="FSOUND_FX_MODES.html">FSOUND_FX_MODES</A>
,
<A HREF="FSOUND_FX_SetChorus.html">FSOUND_FX_SetChorus</A>
,
<A HREF="FSOUND_FX_SetCompressor.html">FSOUND_FX_SetCompressor</A>
,
<A HREF="FSOUND_FX_SetDistortion.html">FSOUND_FX_SetDistortion</A>
,
<A HREF="FSOUND_FX_SetEcho.html">FSOUND_FX_SetEcho</A>
,
<A HREF="FSOUND_FX_SetFlanger.html">FSOUND_FX_SetFlanger</A>
,
<A HREF="FSOUND_FX_SetGargle.html">FSOUND_FX_SetGargle</A>
,
<A HREF="FSOUND_FX_SetI3DL2Reverb.html">FSOUND_FX_SetI3DL2Reverb</A>
,
<A HREF="FSOUND_FX_SetParamEQ.html">FSOUND_FX_SetParamEQ</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:29 2005
by SourceDoc v0.10, the automated source code documenter.</FONT><BR>
</BODY>
</HTML>