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

<HTML>
<HEAD>
<META NAME="GENERATOR" Content="SOURCEDOC.EXE">
<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>FSOUND_FX_SetFlanger</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_SetEcho.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_FX_SetGargle.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_SetFlanger">FSOUND_FX_SetFlanger</A></H2>
Sets the parameters for the flanger effect on a particular channel<BR>
<P>
<B>signed char F_API </B><B> </B><B>FSOUND_FX_SetFlanger</B><B>(</B><BR>
<B>int </B><B> </B><I>fxid</I><B>,</B><BR>
<B>float </B><B> </B><I>WetDryMix</I><B>,</B><BR>
<B>float </B><B> </B><I>Depth</I><B>,</B><BR>
<B>float </B><B> </B><I>Feedback</I><B>,</B><BR>
<B>float </B><B> </B><I>Frequency</I><B>,</B><BR>
<B>int </B><B> </B><I>Waveform</I><B>,</B><BR>
<B>float </B><B> </B><I>Delay</I><B>,</B><BR>
<B>int </B><B> </B><I>Phase</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, to set flanger parameters for.<BR>
</TD><TR VALIGN=top><TD><I>WetDryMix</I></TD>
<TD>Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 through 100 (all wet). <BR>
</TD><TR VALIGN=top><TD><I>Depth</I></TD>
<TD>Percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point. Must be in the range from 0 through 100. The default value is 25. <BR>
</TD><TR VALIGN=top><TD><I>Feedback</I></TD>
<TD>Percentage of output signal to feed back into the effects input, in the range from -99 to 99. The default value is 0. <BR>
</TD><TR VALIGN=top><TD><I>Frequency</I></TD>
<TD>Frequency of the LFO, in the range from 0 to 10. The default value is 0. <BR>
</TD><TR VALIGN=top><TD><I>Waveform</I></TD>
<TD>Waveform of the LFO. By default, the waveform is a sine. Possible values are defined as follows: <BR>
0 - Triangle. <BR>
1 - Sine. <BR>
</TD><TR VALIGN=top><TD><I>Delay</I></TD>
<TD>Number of milliseconds the input is delayed before it is played back, in the range from 0 to 4. The default value is 0 ms. <BR>
</TD><TR VALIGN=top><TD><I>Phase</I></TD>
<TD>Phase differential between left and right LFOs, in the range from 0 through 4. Possible values are defined as follows: <BR>
0 -180 degrees<BR>
1 - 90 degrees<BR>
2    0 degrees<BR>
3   90 degrees<BR>
4  180 degrees<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_Enable and FSOUND_FX_FLANGER 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_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>
, 
<A HREF="FSOUND_FX_SetWavesReverb.html">FSOUND_FX_SetWavesReverb</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>
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_FX_SetFlanger</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_SetEcho.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_FX_SetGargle.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_SetFlanger">FSOUND_FX_SetFlanger</A></H2>`
			`Sets the parameters for the flanger effect on a particular channel<BR>`
			`<P>`
			`<B>signed char F_API </B><B> </B><B>FSOUND_FX_SetFlanger</B><B>(</B><BR>`
			`<B>int </B><B> </B><I>fxid</I><B>,</B><BR>`
			`<B>float </B><B> </B><I>WetDryMix</I><B>,</B><BR>`
			`<B>float </B><B> </B><I>Depth</I><B>,</B><BR>`
			`<B>float </B><B> </B><I>Feedback</I><B>,</B><BR>`
			`<B>float </B><B> </B><I>Frequency</I><B>,</B><BR>`
			`<B>int </B><B> </B><I>Waveform</I><B>,</B><BR>`
			`<B>float </B><B> </B><I>Delay</I><B>,</B><BR>`
			`<B>int </B><B> </B><I>Phase</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, to set flanger parameters for.<BR>`
			`</TD><TR VALIGN=top><TD><I>WetDryMix</I></TD>`
			`<TD>Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 through 100 (all wet). <BR>`
			`</TD><TR VALIGN=top><TD><I>Depth</I></TD>`
			`<TD>Percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point. Must be in the range from 0 through 100. The default value is 25. <BR>`
			`</TD><TR VALIGN=top><TD><I>Feedback</I></TD>`
			`<TD>Percentage of output signal to feed back into the effects input, in the range from -99 to 99. The default value is 0. <BR>`
			`</TD><TR VALIGN=top><TD><I>Frequency</I></TD>`
			`<TD>Frequency of the LFO, in the range from 0 to 10. The default value is 0. <BR>`
			`</TD><TR VALIGN=top><TD><I>Waveform</I></TD>`
			`<TD>Waveform of the LFO. By default, the waveform is a sine. Possible values are defined as follows: <BR>`
			`0 - Triangle. <BR>`
			`1 - Sine. <BR>`
			`</TD><TR VALIGN=top><TD><I>Delay</I></TD>`
			`<TD>Number of milliseconds the input is delayed before it is played back, in the range from 0 to 4. The default value is 0 ms. <BR>`
			`</TD><TR VALIGN=top><TD><I>Phase</I></TD>`
			`<TD>Phase differential between left and right LFOs, in the range from 0 through 4. Possible values are defined as follows: <BR>`
			`0 -180 degrees<BR>`
			`1 - 90 degrees<BR>`
			`2 0 degrees<BR>`
			`3 90 degrees<BR>`
			`4 180 degrees<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_Enable and FSOUND_FX_FLANGER 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_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>`
			`,`
			`<A HREF="FSOUND_FX_SetWavesReverb.html">FSOUND_FX_SetWavesReverb</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:29 2005`
			`by SourceDoc v0.10, the automated source code documenter.</FONT><BR>`
			`</BODY>`
			`</HTML>`