Crizomb/RythmGame
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
RythmGame/SimpleGame/FMOD/doc/FMOD API User Manual/core-api-common-dsp-effects.html
antpoms 2ace28d941 cmake windows
2025-06-11 16:50:48 +02:00

4999 lines
302 KiB
HTML
Raw Blame History

<html>
<head>
<title>Core API Reference | Effect Parameters</title>
<link rel="stylesheet" href="style/docs.css">
<link rel="stylesheet" href="style/code_highlight.css">
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
<body>
<div class="docs-body">
<div class="manual-toc">
<p>FMOD Engine User Manual 2.03</p>
<ul>
<li><a href="welcome.html">Welcome to the FMOD Engine</a></li>
<li><a href="studio-guide.html">Studio API Guide</a></li>
<li><a href="core-guide.html">Core API Guide</a></li>
<li><a href="platforms.html">Platform Details</a></li>
<li><a href="white-papers.html">White Papers</a></li>
<li><a href="studio-api.html">Studio API Reference</a></li>
<li class="manual-current-chapter manual-inactive-chapter"><a href="core-api.html">Core API Reference</a><ul class="subchapters"><li><a href="core-api-common.html">Common</a></li><li class="manual-current-chapter manual-active-chapter"><a href="core-api-common-dsp-effects.html">Effect Parameters</a></li><li><a href="core-api-system.html">System</a></li><li><a href="core-api-sound.html">Sound</a></li><li><a href="core-api-channelcontrol.html">ChannelControl</a></li><li><a href="core-api-channel.html">Channel</a></li><li><a href="core-api-channelgroup.html">ChannelGroup</a></li><li><a href="core-api-soundgroup.html">SoundGroup</a></li><li><a href="core-api-dsp.html">DSP</a></li><li><a href="core-api-dspconnection.html">DSPConnection</a></li><li><a href="core-api-geometry.html">Geometry</a></li><li><a href="core-api-reverb3d.html">Reverb3D</a></li><li><a href="core-api-platform-ios.html">iOS Specific</a></li><li><a href="core-api-platform-android.html">Android Specific</a></li></ul></li>
<li><a href="fsbank-api.html">FSBank API Reference</a></li>
<li><a href="plugin-api.html">Plug-in API Reference</a></li>
<li><a href="effects-reference.html">Effects Reference</a></li>
<li><a href="troubleshooting.html">Troubleshooting</a></li>
<li><a href="glossary.html">Glossary</a></li>
</ul>
</div>
<div class="manual-content api">
<h1>7. Core API Reference | Effect Parameters</h1>
<p>These are the parameters for controlling <a href="glossary.html#dsp">digital signal processors</a>.</p>
<p><strong>DSP Types:</strong></p>
<ul>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type" title="DSP types.">FMOD_DSP_TYPE</a> <a href="glossary.html#dsp">DSP</a> types.</span></li>
</ul>
<p><strong>DSP Parameters:</strong></p>
<ul>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_channelmix" title="Channel Mix DSP parameter types.">FMOD_DSP_CHANNELMIX</a> <a href="effects-reference.html#channel-mix">Channel Mix DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_chorus" title="Chorus DSP parameter types.">FMOD_DSP_CHORUS</a> <a href="effects-reference.html#chorus">Chorus DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_compressor" title="Compressor DSP parameter types.">FMOD_DSP_COMPRESSOR</a> <a href="effects-reference.html#compressor">Compressor DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_convolution_reverb" title="Convolution reverb DSP parameter types.">FMOD_DSP_CONVOLUTION_REVERB</a> <a href="effects-reference.html#convolution-reverb">Convolution reverb DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_delay" title="Delay DSP parameter types.">FMOD_DSP_DELAY</a> <a href="effects-reference.html#delay">Delay DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_distortion" title="Distortion DSP parameter types.">FMOD_DSP_DISTORTION</a> <a href="effects-reference.html#distortion">Distortion DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_echo" title="Echo DSP parameter types.">FMOD_DSP_ECHO</a> <a href="effects-reference.html#echo">Echo DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fader" title="Fader DSP parameter types.">FMOD_DSP_FADER</a> <a href="effects-reference.html#fader">Fader DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft" title="FFT DSP parameter types.">FMOD_DSP_FFT</a> <a href="effects-reference.html#fft">FFT DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_flange" title="Flange DSP parameter types.">FMOD_DSP_FLANGE</a> <a href="effects-reference.html#flange">Flange DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_highpass" title="Highpass DSP parameter types.">FMOD_DSP_HIGHPASS</a> <a href="effects-reference.html#high-pass">Highpass DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_highpass_simple" title="High pass simple DSP parameter types.">FMOD_DSP_HIGHPASS_SIMPLE</a> <a href="effects-reference.html#high-pass-simple">High pass simple DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_itecho" title="IT echo DSP parameter types.">FMOD_DSP_ITECHO</a> <a href="effects-reference.html#it-echo">IT echo DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_itlowpass" title="Lowpass DSP parameter types.">FMOD_DSP_ITLOWPASS</a> Lowpass <a href="glossary.html#dsp">DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_limiter" title="Limiter DSP parameter types.">FMOD_DSP_LIMITER</a> <a href="effects-reference.html#limiter">Limiter DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_loudness_meter" title="Loudness meter DSP parameter types.">FMOD_DSP_LOUDNESS_METER</a> <span class="dead-link" href="effects-reference.html#loudness-meter">Loudness meter DSP</span class="dead-link"> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_lowpass" title="Low pass DSP parameter types.">FMOD_DSP_LOWPASS</a> <a href="effects-reference.html#low-pass">Low pass DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_lowpass_simple" title="Low pass simple DSP parameter types.">FMOD_DSP_LOWPASS_SIMPLE</a> <a href="effects-reference.html#low-pass-simple">Low pass simple DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_dynamics" title="Three-band compressor/expander effect.">FMOD_DSP_MULTIBAND_DYNAMICS</a> Three-band compressor/expander effect.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq" title="Multiband equalizer DSP parameter types.">FMOD_DSP_MULTIBAND_EQ</a> <a href="effects-reference.html#multiband-equalizer">Multiband equalizer DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_normalize" title="Normalize DSP parameter types.">FMOD_DSP_NORMALIZE</a> <a href="effects-reference.html#normalize">Normalize DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_objectpan" title="Object based spatializer parameters.">FMOD_DSP_OBJECTPAN</a> <a href="effects-reference.html#object-panner">Object based spatializer</a> parameters.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_oscillator" title="Oscillator DSP parameter types.">FMOD_DSP_OSCILLATOR</a> <a href="effects-reference.html#oscillator">Oscillator DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan" title="Pan DSP parameter types.">FMOD_DSP_PAN</a> <a href="effects-reference.html#pan">Pan DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_parameq" title="Parametric EQ DSP parameter types.">FMOD_DSP_PARAMEQ</a> <a href="effects-reference.html#parametric-eq">Parametric EQ DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pitchshift" title="Pitch shifter DSP parameter types.">FMOD_DSP_PITCHSHIFT</a> <a href="effects-reference.html#pitch-shifter">Pitch shifter DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_return" title="Return DSP parameter types.">FMOD_DSP_RETURN</a> <a href="effects-reference.html#return">Return DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_send" title="Send DSP parameter types.">FMOD_DSP_SEND</a> <a href="effects-reference.html#send">Send DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_sfxreverb" title="SFX reverb DSP parameter types.">FMOD_DSP_SFXREVERB</a> <a href="effects-reference.html#sfx-reverb">SFX reverb DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_three_eq" title="Three EQ DSP parameter types.">FMOD_DSP_THREE_EQ</a> <a href="effects-reference.html#three-eq">Three EQ DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_transceiver" title="Transceiver DSP parameter types.">FMOD_DSP_TRANSCEIVER</a> <a href="effects-reference.html#transceiver">Transceiver DSP</a> parameter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_tremolo" title="Tremolo DSP parameter types.">FMOD_DSP_TREMOLO</a> <a href="effects-reference.html#tremolo">Tremolo DSP</a> parameter types.</span></li>
</ul>
<p><strong>DSP Parameter Types:</strong></p>
<ul>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_channelmix_output" title="Channel mix DSP output grouping types for the FMOD_DSP_CHANNELMIX_OUTPUTGROUPING parameter. Output grouping sets the output speaker format for the Channel Mix DSP. This determines the number of output channels.">FMOD_DSP_CHANNELMIX_OUTPUT</a> <a href="effects-reference.html#channel-mix">Channel mix DSP</a> output grouping types for the <a href="core-api-common-dsp-effects.html#fmod_dsp_channelmix_outputgrouping">FMOD_DSP_CHANNELMIX_OUTPUTGROUPING</a> parameter. Output grouping sets the output speaker format for the Channel Mix DSP. This determines the number of output channels.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_transceiver_speakermode" title="Speaker mode values for the transceiver DSP.">FMOD_DSP_TRANSCEIVER_SPEAKERMODE</a> Speaker mode values for the <a href="effects-reference.html#transceiver">transceiver DSP</a>.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_three_eq_crossoverslope_type" title="Crossover values for the three EQ DSP.">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_TYPE</a> Crossover values for the <a href="effects-reference.html#three-eq">three EQ DSP</a>.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_loudness_meter_state_type" title="Loudness meter state indicating update behavior.">FMOD_DSP_LOUDNESS_METER_STATE_TYPE</a> Loudness meter state indicating update behavior.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_mode_type" title="2D stereo mode values for pan DSP.">FMOD_DSP_PAN_2D_STEREO_MODE_TYPE</a> 2D stereo mode values for <a href="effects-reference.html#pan">pan DSP</a>.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_extent_mode_type" title="3D extent mode values for pan DSP.">FMOD_DSP_PAN_3D_EXTENT_MODE_TYPE</a> 3D extent mode values for <a href="effects-reference.html#pan">pan DSP</a>.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_rolloff_type" title="3D roll-off values for pan DSP.">FMOD_DSP_PAN_3D_ROLLOFF_TYPE</a> 3D roll-off values for <a href="effects-reference.html#pan">pan DSP</a>.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_mode_type" title="Pan mode values for the pan DSP.">FMOD_DSP_PAN_MODE_TYPE</a> Pan mode values for the <a href="effects-reference.html#pan">pan DSP</a>.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq_filter_type" title="Multiband equalizer filter types.">FMOD_DSP_MULTIBAND_EQ_FILTER_TYPE</a> <a href="effects-reference.html#multiband-equalizer">Multiband equalizer</a> filter types.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_window_type" title="List of windowing methods for the FFT DSP.">FMOD_DSP_FFT_WINDOW_TYPE</a> List of windowing methods for the <a href="effects-reference.html#fft">FFT DSP</a>.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_downmix_type" title="List of downmix modes for the FFT DSP.">FMOD_DSP_FFT_DOWNMIX_TYPE</a> List of downmix modes for the FFT DSP.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_loudness_meter_info_type" title="Loudness meter information data structure.">FMOD_DSP_LOUDNESS_METER_INFO_TYPE</a> Loudness meter information data structure.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_loudness_meter_weighting_type" title="Loudness meter channel weighting.">FMOD_DSP_LOUDNESS_METER_WEIGHTING_TYPE</a> Loudness meter channel weighting.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_echo_delaychangemode_type" title="Options for smoothing delay changes in the echo effect.">FMOD_DSP_ECHO_DELAYCHANGEMODE_TYPE</a> Options for smoothing delay changes in the echo effect.</span></li>
<li><span><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_dynamics_mode_type" title="Multiband Dynamics dynamic response types.">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_TYPE</a> Multiband Dynamics dynamic response types.</span></li>
</ul>
<h2 api="enum" id="fmod_dsp_channelmix"><a href="#fmod_dsp_channelmix">FMOD_DSP_CHANNELMIX</a></h2>
<p><a href="effects-reference.html#channel-mix">Channel Mix DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_CHANNELMIX</span> <span class="p">{</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUTGROUPING</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH0</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH1</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH2</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH3</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH4</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH5</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH6</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH7</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH8</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH9</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH10</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH11</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH12</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH13</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH14</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH15</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH16</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH17</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH18</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH19</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH20</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH21</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH22</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH23</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH24</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH25</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH26</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH27</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH28</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH29</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH30</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_GAIN_CH31</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH0</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH1</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH2</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH3</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH4</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH5</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH6</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH7</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH8</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH9</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH10</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH11</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH12</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH13</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH14</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH15</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH16</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH17</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH18</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH19</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH20</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH21</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH22</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH23</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH24</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH25</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH26</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH27</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH28</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH29</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH30</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_CH31</span>
<span class="p">}</span> <span class="n">FMOD_DSP_CHANNELMIX</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_CHANNELMIX</span>
<span class="p">{</span>
<span class="n">OUTPUTGROUPING</span><span class="p">,</span>
<span class="n">GAIN_CH0</span><span class="p">,</span>
<span class="n">GAIN_CH1</span><span class="p">,</span>
<span class="n">GAIN_CH2</span><span class="p">,</span>
<span class="n">GAIN_CH3</span><span class="p">,</span>
<span class="n">GAIN_CH4</span><span class="p">,</span>
<span class="n">GAIN_CH5</span><span class="p">,</span>
<span class="n">GAIN_CH6</span><span class="p">,</span>
<span class="n">GAIN_CH7</span><span class="p">,</span>
<span class="n">GAIN_CH8</span><span class="p">,</span>
<span class="n">GAIN_CH9</span><span class="p">,</span>
<span class="n">GAIN_CH10</span><span class="p">,</span>
<span class="n">GAIN_CH11</span><span class="p">,</span>
<span class="n">GAIN_CH12</span><span class="p">,</span>
<span class="n">GAIN_CH13</span><span class="p">,</span>
<span class="n">GAIN_CH14</span><span class="p">,</span>
<span class="n">GAIN_CH15</span><span class="p">,</span>
<span class="n">GAIN_CH16</span><span class="p">,</span>
<span class="n">GAIN_CH17</span><span class="p">,</span>
<span class="n">GAIN_CH18</span><span class="p">,</span>
<span class="n">GAIN_CH19</span><span class="p">,</span>
<span class="n">GAIN_CH20</span><span class="p">,</span>
<span class="n">GAIN_CH21</span><span class="p">,</span>
<span class="n">GAIN_CH22</span><span class="p">,</span>
<span class="n">GAIN_CH23</span><span class="p">,</span>
<span class="n">GAIN_CH24</span><span class="p">,</span>
<span class="n">GAIN_CH25</span><span class="p">,</span>
<span class="n">GAIN_CH26</span><span class="p">,</span>
<span class="n">GAIN_CH27</span><span class="p">,</span>
<span class="n">GAIN_CH28</span><span class="p">,</span>
<span class="n">GAIN_CH29</span><span class="p">,</span>
<span class="n">GAIN_CH30</span><span class="p">,</span>
<span class="n">GAIN_CH31</span><span class="p">,</span>
<span class="n">OUTPUT_CH0</span><span class="p">,</span>
<span class="n">OUTPUT_CH1</span><span class="p">,</span>
<span class="n">OUTPUT_CH2</span><span class="p">,</span>
<span class="n">OUTPUT_CH3</span><span class="p">,</span>
<span class="n">OUTPUT_CH4</span><span class="p">,</span>
<span class="n">OUTPUT_CH5</span><span class="p">,</span>
<span class="n">OUTPUT_CH6</span><span class="p">,</span>
<span class="n">OUTPUT_CH7</span><span class="p">,</span>
<span class="n">OUTPUT_CH8</span><span class="p">,</span>
<span class="n">OUTPUT_CH9</span><span class="p">,</span>
<span class="n">OUTPUT_CH10</span><span class="p">,</span>
<span class="n">OUTPUT_CH11</span><span class="p">,</span>
<span class="n">OUTPUT_CH12</span><span class="p">,</span>
<span class="n">OUTPUT_CH13</span><span class="p">,</span>
<span class="n">OUTPUT_CH14</span><span class="p">,</span>
<span class="n">OUTPUT_CH15</span><span class="p">,</span>
<span class="n">OUTPUT_CH16</span><span class="p">,</span>
<span class="n">OUTPUT_CH17</span><span class="p">,</span>
<span class="n">OUTPUT_CH18</span><span class="p">,</span>
<span class="n">OUTPUT_CH19</span><span class="p">,</span>
<span class="n">OUTPUT_CH20</span><span class="p">,</span>
<span class="n">OUTPUT_CH21</span><span class="p">,</span>
<span class="n">OUTPUT_CH22</span><span class="p">,</span>
<span class="n">OUTPUT_CH23</span><span class="p">,</span>
<span class="n">OUTPUT_CH24</span><span class="p">,</span>
<span class="n">OUTPUT_CH25</span><span class="p">,</span>
<span class="n">OUTPUT_CH26</span><span class="p">,</span>
<span class="n">OUTPUT_CH27</span><span class="p">,</span>
<span class="n">OUTPUT_CH28</span><span class="p">,</span>
<span class="n">OUTPUT_CH29</span><span class="p">,</span>
<span class="n">OUTPUT_CH30</span><span class="p">,</span>
<span class="n">OUTPUT_CH31</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUTGROUPING</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH0</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH1</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH2</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH3</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH4</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH5</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH6</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH7</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH8</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH9</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH10</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH11</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH12</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH13</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH14</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH15</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH16</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH17</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH18</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH19</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH20</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH21</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH22</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH23</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH24</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH25</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH26</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH27</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH28</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH29</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH30</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_GAIN_CH31</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH0</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH1</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH2</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH3</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH4</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH5</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH6</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH7</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH8</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH9</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH10</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH11</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH12</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH13</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH14</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH15</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH16</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH17</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH18</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH19</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH20</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH21</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH22</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH23</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH24</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH25</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH26</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH27</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH28</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH29</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH30</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_CH31</span>
</pre></div>
<dl>
<dt id="fmod_dsp_channelmix_outputgrouping">FMOD_DSP_CHANNELMIX_OUTPUTGROUPING</dt>
<dd>
<p>Channel mix output grouping. (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_channelmix_output">FMOD_DSP_CHANNELMIX_OUTPUT</a>)</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_channelmix_output_default">FMOD_DSP_CHANNELMIX_OUTPUT_DEFAULT</a></li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch0">FMOD_DSP_CHANNELMIX_GAIN_CH0</dt>
<dd>
<p>Channel #0 gain. </p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch1">FMOD_DSP_CHANNELMIX_GAIN_CH1</dt>
<dd>
<p>Channel #1 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch2">FMOD_DSP_CHANNELMIX_GAIN_CH2</dt>
<dd>
<p>Channel #2 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch3">FMOD_DSP_CHANNELMIX_GAIN_CH3</dt>
<dd>
<p>Channel #3 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch4">FMOD_DSP_CHANNELMIX_GAIN_CH4</dt>
<dd>
<p>Channel #4 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch5">FMOD_DSP_CHANNELMIX_GAIN_CH5</dt>
<dd>
<p>Channel #5 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch6">FMOD_DSP_CHANNELMIX_GAIN_CH6</dt>
<dd>
<p>Channel #6 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch7">FMOD_DSP_CHANNELMIX_GAIN_CH7</dt>
<dd>
<p>Channel #7 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch8">FMOD_DSP_CHANNELMIX_GAIN_CH8</dt>
<dd>
<p>Channel #8 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch9">FMOD_DSP_CHANNELMIX_GAIN_CH9</dt>
<dd>
<p>Channel #9 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch10">FMOD_DSP_CHANNELMIX_GAIN_CH10</dt>
<dd>
<p>Channel #10 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch11">FMOD_DSP_CHANNELMIX_GAIN_CH11</dt>
<dd>
<p>Channel #11 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch12">FMOD_DSP_CHANNELMIX_GAIN_CH12</dt>
<dd>
<p>Channel #12 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch13">FMOD_DSP_CHANNELMIX_GAIN_CH13</dt>
<dd>
<p>Channel #13 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch14">FMOD_DSP_CHANNELMIX_GAIN_CH14</dt>
<dd>
<p>Channel #14 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch15">FMOD_DSP_CHANNELMIX_GAIN_CH15</dt>
<dd>
<p>Channel #15 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch16">FMOD_DSP_CHANNELMIX_GAIN_CH16</dt>
<dd>
<p>Channel #16 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch17">FMOD_DSP_CHANNELMIX_GAIN_CH17</dt>
<dd>
<p>Channel #17 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch18">FMOD_DSP_CHANNELMIX_GAIN_CH18</dt>
<dd>
<p>Channel #18 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch19">FMOD_DSP_CHANNELMIX_GAIN_CH19</dt>
<dd>
<p>Channel #19 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch20">FMOD_DSP_CHANNELMIX_GAIN_CH20</dt>
<dd>
<p>Channel #20 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch21">FMOD_DSP_CHANNELMIX_GAIN_CH21</dt>
<dd>
<p>Channel #21 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch22">FMOD_DSP_CHANNELMIX_GAIN_CH22</dt>
<dd>
<p>Channel #22 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch23">FMOD_DSP_CHANNELMIX_GAIN_CH23</dt>
<dd>
<p>Channel #23 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch24">FMOD_DSP_CHANNELMIX_GAIN_CH24</dt>
<dd>
<p>Channel #24 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch25">FMOD_DSP_CHANNELMIX_GAIN_CH25</dt>
<dd>
<p>Channel #25 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch26">FMOD_DSP_CHANNELMIX_GAIN_CH26</dt>
<dd>
<p>Channel #26 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch27">FMOD_DSP_CHANNELMIX_GAIN_CH27</dt>
<dd>
<p>Channel #27 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch28">FMOD_DSP_CHANNELMIX_GAIN_CH28</dt>
<dd>
<p>Channel #28 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch29">FMOD_DSP_CHANNELMIX_GAIN_CH29</dt>
<dd>
<p>Channel #29 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch30">FMOD_DSP_CHANNELMIX_GAIN_CH30</dt>
<dd>
<p>Channel #30 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_gain_ch31">FMOD_DSP_CHANNELMIX_GAIN_CH31</dt>
<dd>
<p>Channel #31 gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch0">FMOD_DSP_CHANNELMIX_OUTPUT_CH0</dt>
<dd>
<p>Output channel for Input channel #0</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch1">FMOD_DSP_CHANNELMIX_OUTPUT_CH1</dt>
<dd>
<p>Output channel for Input channel #1</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch2">FMOD_DSP_CHANNELMIX_OUTPUT_CH2</dt>
<dd>
<p>Output channel for Input channel #2</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 2</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch3">FMOD_DSP_CHANNELMIX_OUTPUT_CH3</dt>
<dd>
<p>Output channel for Input channel #3</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 3</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch4">FMOD_DSP_CHANNELMIX_OUTPUT_CH4</dt>
<dd>
<p>Output channel for Input channel #4</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 4</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch5">FMOD_DSP_CHANNELMIX_OUTPUT_CH5</dt>
<dd>
<p>Output channel for Input channel #5</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 5</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch6">FMOD_DSP_CHANNELMIX_OUTPUT_CH6</dt>
<dd>
<p>Output channel for Input channel #6</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 6</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch7">FMOD_DSP_CHANNELMIX_OUTPUT_CH7</dt>
<dd>
<p>Output channel for Input channel #7</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 7</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch8">FMOD_DSP_CHANNELMIX_OUTPUT_CH8</dt>
<dd>
<p>Output channel for Input channel #8</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 8</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch9">FMOD_DSP_CHANNELMIX_OUTPUT_CH9</dt>
<dd>
<p>Output channel for Input channel #9</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 9</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch10">FMOD_DSP_CHANNELMIX_OUTPUT_CH10</dt>
<dd>
<p>Output channel for Input channel #10</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 10</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch11">FMOD_DSP_CHANNELMIX_OUTPUT_CH11</dt>
<dd>
<p>Output channel for Input channel #11</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 11</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch12">FMOD_DSP_CHANNELMIX_OUTPUT_CH12</dt>
<dd>
<p>Output channel for Input channel #12</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 12</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch13">FMOD_DSP_CHANNELMIX_OUTPUT_CH13</dt>
<dd>
<p>Output channel for Input channel #13</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 13</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch14">FMOD_DSP_CHANNELMIX_OUTPUT_CH14</dt>
<dd>
<p>Output channel for Input channel #14</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 14</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch15">FMOD_DSP_CHANNELMIX_OUTPUT_CH15</dt>
<dd>
<p>Output channel for Input channel #15</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 15</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch16">FMOD_DSP_CHANNELMIX_OUTPUT_CH16</dt>
<dd>
<p>Output channel for Input channel #16</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 16</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch17">FMOD_DSP_CHANNELMIX_OUTPUT_CH17</dt>
<dd>
<p>Output channel for Input channel #17</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 17</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch18">FMOD_DSP_CHANNELMIX_OUTPUT_CH18</dt>
<dd>
<p>Output channel for Input channel #18</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 18</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch19">FMOD_DSP_CHANNELMIX_OUTPUT_CH19</dt>
<dd>
<p>Output channel for Input channel #19</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 19</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch20">FMOD_DSP_CHANNELMIX_OUTPUT_CH20</dt>
<dd>
<p>Output channel for Input channel #20</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 20</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch21">FMOD_DSP_CHANNELMIX_OUTPUT_CH21</dt>
<dd>
<p>Output channel for Input channel #21</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 21</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch22">FMOD_DSP_CHANNELMIX_OUTPUT_CH22</dt>
<dd>
<p>Output channel for Input channel #22</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 22</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch23">FMOD_DSP_CHANNELMIX_OUTPUT_CH23</dt>
<dd>
<p>Output channel for Input channel #23</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 23</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch24">FMOD_DSP_CHANNELMIX_OUTPUT_CH24</dt>
<dd>
<p>Output channel for Input channel #24</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 24</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch25">FMOD_DSP_CHANNELMIX_OUTPUT_CH25</dt>
<dd>
<p>Output channel for Input channel #25</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 25</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch26">FMOD_DSP_CHANNELMIX_OUTPUT_CH26</dt>
<dd>
<p>Output channel for Input channel #26</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 26</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch27">FMOD_DSP_CHANNELMIX_OUTPUT_CH27</dt>
<dd>
<p>Output channel for Input channel #27</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 27</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch28">FMOD_DSP_CHANNELMIX_OUTPUT_CH28</dt>
<dd>
<p>Output channel for Input channel #28</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 28</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch29">FMOD_DSP_CHANNELMIX_OUTPUT_CH29</dt>
<dd>
<p>Output channel for Input channel #29</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 29</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch30">FMOD_DSP_CHANNELMIX_OUTPUT_CH30</dt>
<dd>
<p>Output channel for Input channel #30</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 30</li>
</ul>
</dd>
<dt id="fmod_dsp_channelmix_output_ch31">FMOD_DSP_CHANNELMIX_OUTPUT_CH31</dt>
<dd>
<p>Output channel for Input channel #31</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 31</li>
</ul>
</dd>
</dl>
<p>For <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_channelmix_outputgrouping">FMOD_DSP_CHANNELMIX_OUTPUTGROUPING</a>, this value will set the output speaker format for the <a href="glossary.html#dsp">DSP</a>. This determines the number of output channels.</p>
<p>If an input channel is mapped to an output channel in excess of the number of output channels, the input channel is instead mapped to the modulo of that channel's index. E.g.: If there are 4 output channels, an input channel mapped to output channel index 5 is mapped to index 1.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_channelmix">FMOD_DSP_TYPE_CHANNELMIX</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type">FMOD_DSP_TYPE</a></p>
<h2 api="enum" id="fmod_dsp_channelmix_output"><a href="#fmod_dsp_channelmix_output">FMOD_DSP_CHANNELMIX_OUTPUT</a></h2>
<p><a href="effects-reference.html#channel-mix">Channel mix DSP</a> output grouping types for the <a href="core-api-common-dsp-effects.html#fmod_dsp_channelmix_outputgrouping">FMOD_DSP_CHANNELMIX_OUTPUTGROUPING</a> parameter. Output grouping sets the output speaker format for the Channel Mix DSP. This determines the number of output channels.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_CHANNELMIX_OUTPUT</span> <span class="p">{</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_DEFAULT</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_ALLMONO</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_ALLSTEREO</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_ALLQUAD</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_ALL5POINT1</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_ALL7POINT1</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_ALLLFE</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHANNELMIX_OUTPUT_ALL7POINT1POINT4</span>
<span class="p">}</span> <span class="n">FMOD_DSP_CHANNELMIX_OUTPUT</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_CHANNELMIX_OUTPUT</span>
<span class="p">{</span>
<span class="n">DEFAULT</span><span class="p">,</span>
<span class="n">ALLMONO</span><span class="p">,</span>
<span class="n">ALLSTEREO</span><span class="p">,</span>
<span class="n">ALLQUAD</span><span class="p">,</span>
<span class="n">ALL5POINT1</span><span class="p">,</span>
<span class="n">ALL7POINT1</span><span class="p">,</span>
<span class="n">ALLLFE</span><span class="p">,</span>
<span class="n">ALL7POINT1POINT4</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_DEFAULT</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_ALLMONO</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_ALLSTEREO</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_ALLQUAD</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_ALL5POINT1</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_ALL7POINT1</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_ALLLFE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHANNELMIX_OUTPUT_ALL7POINT1POINT4</span>
</pre></div>
<dl>
<dt id="fmod_dsp_channelmix_output_default">FMOD_DSP_CHANNELMIX_OUTPUT_DEFAULT</dt>
<dd>Output channel count = input channel count. Mapping: See <a class="apilink" href="core-api-common.html#fmod_speaker">FMOD_SPEAKER</a> enumeration.</dd>
<dt id="fmod_dsp_channelmix_output_allmono">FMOD_DSP_CHANNELMIX_OUTPUT_ALLMONO</dt>
<dd>Output channel count = 1. Mapping: Mono, Mono, Mono, Mono, Mono, Mono, ... (each channel all the way up to <a class="apilink" href="core-api-common.html#fmod_max_channel_width">FMOD_MAX_CHANNEL_WIDTH</a> channels are treated as if they were mono)</dd>
<dt id="fmod_dsp_channelmix_output_allstereo">FMOD_DSP_CHANNELMIX_OUTPUT_ALLSTEREO</dt>
<dd>Output channel count = 2. Mapping: Left, Right, Left, Right, Left, Right, ... (each pair of channels is treated as stereo all the way up to <a class="apilink" href="core-api-common.html#fmod_max_channel_width">FMOD_MAX_CHANNEL_WIDTH</a> channels)</dd>
<dt id="fmod_dsp_channelmix_output_allquad">FMOD_DSP_CHANNELMIX_OUTPUT_ALLQUAD</dt>
<dd>Output channel count = 4. Mapping: Repeating pattern of Front Left, Front Right, Surround Left, Surround Right.</dd>
<dt id="fmod_dsp_channelmix_output_all5point1">FMOD_DSP_CHANNELMIX_OUTPUT_ALL5POINT1</dt>
<dd>Output channel count = 6. Mapping: Repeating pattern of Front Left, Front Right, Center, LFE, Surround Left, Surround Right.</dd>
<dt id="fmod_dsp_channelmix_output_all7point1">FMOD_DSP_CHANNELMIX_OUTPUT_ALL7POINT1</dt>
<dd>Output channel count = 8. Mapping: Repeating pattern of Front Left, Front Right, Center, LFE, Surround Left, Surround Right, Back Left, Back Right.</dd>
<dt id="fmod_dsp_channelmix_output_alllfe">FMOD_DSP_CHANNELMIX_OUTPUT_ALLLFE</dt>
<dd>Output channel count = 6. Mapping: Repeating pattern of LFE in a 5.1 output <a href="glossary.html#signal">signal</a>.</dd>
<dt id="fmod_dsp_channelmix_output_all7point1point4">FMOD_DSP_CHANNELMIX_OUTPUT_ALL7POINT1POINT4</dt>
<dd>Output channel count = 12. Mapping: Repeating pattern of Front Left, Front Right, Center, LFE, Surround Left, Surround Right, Back Left, Back Right, Top Front Left, Top Front Right, Top Back Left, Top Back Right.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_channelmix_outputgrouping">FMOD_DSP_CHANNELMIX_OUTPUTGROUPING</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_channelmix">FMOD_DSP_TYPE_CHANNELMIX</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a>, <a class="apilink" href="core-api-dsp.html#dsp_getparameterint">DSP::getParameterInt</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type">FMOD_DSP_TYPE</a></p>
<h2 api="enum" id="fmod_dsp_chorus"><a href="#fmod_dsp_chorus">FMOD_DSP_CHORUS</a></h2>
<p><a href="effects-reference.html#chorus">Chorus DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_CHORUS</span> <span class="p">{</span>
<span class="n">FMOD_DSP_CHORUS_MIX</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHORUS_RATE</span><span class="p">,</span>
<span class="n">FMOD_DSP_CHORUS_DEPTH</span>
<span class="p">}</span> <span class="n">FMOD_DSP_CHORUS</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_CHORUS</span>
<span class="p">{</span>
<span class="n">MIX</span><span class="p">,</span>
<span class="n">RATE</span><span class="p">,</span>
<span class="n">DEPTH</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHORUS_MIX</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHORUS_RATE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CHORUS_DEPTH</span>
</pre></div>
<dl>
<dt id="fmod_dsp_chorus_mix">FMOD_DSP_CHORUS_MIX</dt>
<dd>
<p>Percentage of wet <a href="glossary.html#signal">signal</a> in mix.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Percentage</li>
<li><span class="label">Range:</span> [0, 100]</li>
<li><span class="label">Default:</span> 50 </li>
</ul>
</dd>
<dt id="fmod_dsp_chorus_rate">FMOD_DSP_CHORUS_RATE</dt>
<dd>
<p>Chorus modulation rate.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [0, 20]</li>
<li><span class="label">Default:</span> 0.8 </li>
</ul>
</dd>
<dt id="fmod_dsp_chorus_depth">FMOD_DSP_CHORUS_DEPTH</dt>
<dd>
<p>Chorus modulation depth.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 100]</li>
<li><span class="label">Default:</span> 3</li>
</ul>
</dd>
</dl>
<p>Chorus is an <a href="glossary.html#effect">effect</a> where the sound is more 'spacious' due a copy of the signal being played along side the original, but with the delay of each copy modulating on a sine wave. As there are 2 versions of the same signal (dry vs wet), by default each signal is given 50% mix, so that the total is not louder than the original unaffected signal.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_chorus">FMOD_DSP_TYPE_CHORUS</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-dsp.html#dsp_getparameterfloat">DSP::getParameterFloat</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type">FMOD_DSP_TYPE</a></p>
<h2 api="enum" id="fmod_dsp_compressor"><a href="#fmod_dsp_compressor">FMOD_DSP_COMPRESSOR</a></h2>
<p><a href="effects-reference.html#compressor">Compressor DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_COMPRESSOR</span> <span class="p">{</span>
<span class="n">FMOD_DSP_COMPRESSOR_THRESHOLD</span><span class="p">,</span>
<span class="n">FMOD_DSP_COMPRESSOR_RATIO</span><span class="p">,</span>
<span class="n">FMOD_DSP_COMPRESSOR_ATTACK</span><span class="p">,</span>
<span class="n">FMOD_DSP_COMPRESSOR_RELEASE</span><span class="p">,</span>
<span class="n">FMOD_DSP_COMPRESSOR_GAINMAKEUP</span><span class="p">,</span>
<span class="n">FMOD_DSP_COMPRESSOR_USESIDECHAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_COMPRESSOR_LINKED</span>
<span class="p">}</span> <span class="n">FMOD_DSP_COMPRESSOR</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_COMPRESSOR</span>
<span class="p">{</span>
<span class="n">THRESHOLD</span><span class="p">,</span>
<span class="n">RATIO</span><span class="p">,</span>
<span class="n">ATTACK</span><span class="p">,</span>
<span class="n">RELEASE</span><span class="p">,</span>
<span class="n">GAINMAKEUP</span><span class="p">,</span>
<span class="n">USESIDECHAIN</span><span class="p">,</span>
<span class="n">LINKED</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_COMPRESSOR_THRESHOLD</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_COMPRESSOR_RATIO</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_COMPRESSOR_ATTACK</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_COMPRESSOR_RELEASE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_COMPRESSOR_GAINMAKEUP</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_COMPRESSOR_USESIDECHAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_COMPRESSOR_LINKED</span>
</pre></div>
<dl>
<dt id="fmod_dsp_compressor_threshold">FMOD_DSP_COMPRESSOR_THRESHOLD</dt>
<dd>
<p>Threshold level.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-60, 0]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_compressor_ratio">FMOD_DSP_COMPRESSOR_RATIO</dt>
<dd>
<p>Compression Ratio.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [1, 50]</li>
<li><span class="label">Default:</span> 2.5</li>
</ul>
</dd>
<dt id="fmod_dsp_compressor_attack">FMOD_DSP_COMPRESSOR_ATTACK</dt>
<dd>
<p>Attack time.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0.1, 500]</li>
<li><span class="label">Default:</span> 20</li>
</ul>
</dd>
<dt id="fmod_dsp_compressor_release">FMOD_DSP_COMPRESSOR_RELEASE</dt>
<dd>
<p>Release time.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [10, 5000]</li>
<li><span class="label">Default:</span> 100</li>
</ul>
</dd>
<dt id="fmod_dsp_compressor_gainmakeup">FMOD_DSP_COMPRESSOR_GAINMAKEUP</dt>
<dd>
<p>Make-up gain applied after limiting. </p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-30, 30]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_compressor_usesidechain">FMOD_DSP_COMPRESSOR_USESIDECHAIN</dt>
<dd>Data of type <a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_sidechain">FMOD_DSP_PARAMETER_SIDECHAIN</a>. Whether to analyse the sidechain <a href="glossary.html#signal">signal</a> instead of the input signal. The FMOD_DSP_PARAMETER_SIDECHAIN::sidechainenable default is false.</dd>
<dt id="fmod_dsp_compressor_linked">FMOD_DSP_COMPRESSOR_LINKED</dt>
<dd>
<p>false = Independent (compressor per channel), true = Linked.</p>
<ul>
<li>Type: bool</li>
<li><span class="label">Default:</span> true</li>
</ul>
</dd>
</dl>
<p>This is a multi-channel software limiter that is uniform across the whole spectrum.<br />
The limiter is not guaranteed to catch every peak above the threshold level, because it cannot apply gain reduction instantaneously - the time delay is determined by the attack time. However setting the attack time too short will distort the sound, so it is a compromise. High level peaks can be avoided by using a short attack time - but not too short, and setting the threshold a few decibels below the critical level.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_compressor">FMOD_DSP_TYPE_COMPRESSOR</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterbool">DSP::setParameterBool</a></p>
<h2 api="enum" id="fmod_dsp_convolution_reverb"><a href="#fmod_dsp_convolution_reverb">FMOD_DSP_CONVOLUTION_REVERB</a></h2>
<p><a href="effects-reference.html#convolution-reverb">Convolution reverb DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_CONVOLUTION_REVERB</span> <span class="p">{</span>
<span class="n">FMOD_DSP_CONVOLUTION_REVERB_PARAM_IR</span><span class="p">,</span>
<span class="n">FMOD_DSP_CONVOLUTION_REVERB_PARAM_WET</span><span class="p">,</span>
<span class="n">FMOD_DSP_CONVOLUTION_REVERB_PARAM_DRY</span><span class="p">,</span>
<span class="n">FMOD_DSP_CONVOLUTION_REVERB_PARAM_LINKED</span>
<span class="p">}</span> <span class="n">FMOD_DSP_CONVOLUTION_REVERB</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_CONVOLUTION_REVERB</span>
<span class="p">{</span>
<span class="n">IR</span><span class="p">,</span>
<span class="n">WET</span><span class="p">,</span>
<span class="n">DRY</span><span class="p">,</span>
<span class="n">LINKED</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CONVOLUTION_REVERB_PARAM_IR</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CONVOLUTION_REVERB_PARAM_WET</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CONVOLUTION_REVERB_PARAM_DRY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_CONVOLUTION_REVERB_PARAM_LINKED</span>
</pre></div>
<dl>
<dt id="fmod_dsp_convolution_reverb_param_ir">FMOD_DSP_CONVOLUTION_REVERB_PARAM_IR</dt>
<dd>Array of signed 16-bit (short) PCM data to be used as reverb impulse response. First member of the array should be a 16 bit value (short) which specifies the number of channels. Array looks like [index 0=numchannels][index 1+ = raw 16 bit PCM data]. Data is copied internally so source can be freed. </dd>
<dt id="fmod_dsp_convolution_reverb_param_wet">FMOD_DSP_CONVOLUTION_REVERB_PARAM_WET</dt>
<dd>
<p>Volume of echo <a href="glossary.html#signal">signal</a> to pass to output.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_convolution_reverb_param_dry">FMOD_DSP_CONVOLUTION_REVERB_PARAM_DRY</dt>
<dd>
<p>Original sound volume.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_convolution_reverb_param_linked">FMOD_DSP_CONVOLUTION_REVERB_PARAM_LINKED</dt>
<dd>
<p>Linked - channels are mixed together before processing through the reverb.</p>
<ul>
<li>Type: bool</li>
<li><span class="label">Default:</span> true</li>
</ul>
</dd>
</dl>
<p>Convolution reverb is a reverberation <a href="glossary.html#effect">effect</a> that uses a recording of a physical space known as an Impulse Response file (or IR file) to generate frequency specific reverberation.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_convolutionreverb">FMOD_DSP_TYPE_CONVOLUTIONREVERB</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterdata">DSP::setParameterData</a></p>
<h2 api="enum" id="fmod_dsp_delay"><a href="#fmod_dsp_delay">FMOD_DSP_DELAY</a></h2>
<p><a href="effects-reference.html#delay">Delay DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_DELAY</span> <span class="p">{</span>
<span class="n">FMOD_DSP_DELAY_CH0</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH1</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH2</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH3</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH4</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH5</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH6</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH7</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH8</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH9</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH10</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH11</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH12</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH13</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH14</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_CH15</span><span class="p">,</span>
<span class="n">FMOD_DSP_DELAY_MAXDELAY</span>
<span class="p">}</span> <span class="n">FMOD_DSP_DELAY</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_DELAY</span>
<span class="p">{</span>
<span class="n">CH0</span><span class="p">,</span>
<span class="n">CH1</span><span class="p">,</span>
<span class="n">CH2</span><span class="p">,</span>
<span class="n">CH3</span><span class="p">,</span>
<span class="n">CH4</span><span class="p">,</span>
<span class="n">CH5</span><span class="p">,</span>
<span class="n">CH6</span><span class="p">,</span>
<span class="n">CH7</span><span class="p">,</span>
<span class="n">CH8</span><span class="p">,</span>
<span class="n">CH9</span><span class="p">,</span>
<span class="n">CH10</span><span class="p">,</span>
<span class="n">CH11</span><span class="p">,</span>
<span class="n">CH12</span><span class="p">,</span>
<span class="n">CH13</span><span class="p">,</span>
<span class="n">CH14</span><span class="p">,</span>
<span class="n">CH15</span><span class="p">,</span>
<span class="n">MAXDELAY</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH0</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH1</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH2</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH3</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH4</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH5</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH6</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH7</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH8</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH9</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH10</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH11</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH12</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH13</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH14</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_CH15</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DELAY_MAXDELAY</span>
</pre></div>
<dl>
<dt id="fmod_dsp_delay_ch0">FMOD_DSP_DELAY_CH0</dt>
<dd>
<p>Channel #0 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch1">FMOD_DSP_DELAY_CH1</dt>
<dd>
<p>Channel #1 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch2">FMOD_DSP_DELAY_CH2</dt>
<dd>
<p>Channel #2 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch3">FMOD_DSP_DELAY_CH3</dt>
<dd>
<p>Channel #3 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch4">FMOD_DSP_DELAY_CH4</dt>
<dd>
<p>Channel #4 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch5">FMOD_DSP_DELAY_CH5</dt>
<dd>
<p>Channel #5 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch6">FMOD_DSP_DELAY_CH6</dt>
<dd>
<p>Channel #6 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch7">FMOD_DSP_DELAY_CH7</dt>
<dd>
<p>Channel #7 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch8">FMOD_DSP_DELAY_CH8</dt>
<dd>
<p>Channel #8 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch9">FMOD_DSP_DELAY_CH9</dt>
<dd>
<p>Channel #9 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch10">FMOD_DSP_DELAY_CH10</dt>
<dd>
<p>Channel #10 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch11">FMOD_DSP_DELAY_CH11</dt>
<dd>
<p>Channel #11 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch12">FMOD_DSP_DELAY_CH12</dt>
<dd>
<p>Channel #12 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch13">FMOD_DSP_DELAY_CH13</dt>
<dd>
<p>Channel #13 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch14">FMOD_DSP_DELAY_CH14</dt>
<dd>
<p>Channel #14 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_ch15">FMOD_DSP_DELAY_CH15</dt>
<dd>
<p>Channel #15 Delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_delay_maxdelay">FMOD_DSP_DELAY_MAXDELAY</dt>
<dd>
<p>Maximum delay, for memory allocation purposes.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 10000]</li>
<li><span class="label">Default:</span> 10</li>
</ul>
</dd>
</dl>
<p>Every time MaxDelay is changed, the plug-in re-allocates the delay buffer. This means the delay disappears at that time while it refills its new buffer. A larger MaxDelay results in larger amounts of memory allocated.</p>
<p>Channel delays above MaxDelay will be clipped to MaxDelay and the delay buffer will not be resized.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_delay">FMOD_DSP_TYPE_DELAY</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_distortion"><a href="#fmod_dsp_distortion">FMOD_DSP_DISTORTION</a></h2>
<p><a href="effects-reference.html#distortion">Distortion DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_DISTORTION</span> <span class="p">{</span>
<span class="n">FMOD_DSP_DISTORTION_LEVEL</span>
<span class="p">}</span> <span class="n">FMOD_DSP_DISTORTION</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_DISTORTION</span>
<span class="p">{</span>
<span class="n">LEVEL</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_DISTORTION_LEVEL</span>
</pre></div>
<dl>
<dt id="fmod_dsp_distortion_level">FMOD_DSP_DISTORTION_LEVEL</dt>
<dd>
<p>Distortion value.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0, 1]</li>
<li><span class="label">Default:</span> 0.5</li>
</ul>
</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_distortion">FMOD_DSP_TYPE_DISTORTION</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_echo"><a href="#fmod_dsp_echo">FMOD_DSP_ECHO</a></h2>
<p><a href="effects-reference.html#echo">Echo DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_ECHO</span> <span class="p">{</span>
<span class="n">FMOD_DSP_ECHO_DELAY</span><span class="p">,</span>
<span class="n">FMOD_DSP_ECHO_FEEDBACK</span><span class="p">,</span>
<span class="n">FMOD_DSP_ECHO_DRYLEVEL</span><span class="p">,</span>
<span class="n">FMOD_DSP_ECHO_WETLEVEL</span><span class="p">,</span>
<span class="n">FMOD_DSP_ECHO_DELAYCHANGEMODE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_ECHO</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_ECHO</span>
<span class="p">{</span>
<span class="n">DELAY</span><span class="p">,</span>
<span class="n">FEEDBACK</span><span class="p">,</span>
<span class="n">DRYLEVEL</span><span class="p">,</span>
<span class="n">WETLEVEL</span><span class="p">,</span>
<span class="n">DELAYCHANGEMODE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ECHO_DELAY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ECHO_FEEDBACK</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ECHO_DRYLEVEL</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ECHO_WETLEVEL</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ECHO_DELAYCHANGEMODE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_echo_delay">FMOD_DSP_ECHO_DELAY</dt>
<dd>
<p>Echo delay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [1, 5000]</li>
<li><span class="label">Default:</span> 500</li>
</ul>
</dd>
<dt id="fmod_dsp_echo_feedback">FMOD_DSP_ECHO_FEEDBACK</dt>
<dd>
<p>Echo decay per delay. 100.0 = No decay, 0.0 = total decay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Percentage</li>
<li><span class="label">Range:</span> [0, 100]</li>
<li><span class="label">Default:</span> 50</li>
</ul>
</dd>
<dt id="fmod_dsp_echo_drylevel">FMOD_DSP_ECHO_DRYLEVEL</dt>
<dd>
<p>Original sound volume.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_echo_wetlevel">FMOD_DSP_ECHO_WETLEVEL</dt>
<dd>
<p>Volume of echo <a href="glossary.html#signal">signal</a> to pass to output.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_echo_delaychangemode">FMOD_DSP_ECHO_DELAYCHANGEMODE</dt>
<dd>
<p>The method used to smooth delay changes.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_echo_delaychangemode_type">FMOD_DSP_ECHO_DELAYCHANGEMODE_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_echo_delaychangemode_fade">FMOD_DSP_ECHO_DELAYCHANGEMODE_FADE</a></li>
</ul>
</dd>
</dl>
<p>Every time the delay is changed, the plug-in reallocates the echo buffer. This means the echo disappears at that time while it refills its new buffer. Larger echo delays result in larger amounts of memory allocated.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_echo">FMOD_DSP_TYPE_ECHO</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_echo_delaychangemode_type"><a href="#fmod_dsp_echo_delaychangemode_type">FMOD_DSP_ECHO_DELAYCHANGEMODE_TYPE</a></h2>
<p>Options for smoothing delay changes in the echo effect.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_ECHO_DELAYCHANGEMODE_TYPE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_ECHO_DELAYCHANGEMODE_FADE</span><span class="p">,</span>
<span class="n">FMOD_DSP_ECHO_DELAYCHANGEMODE_LERP</span><span class="p">,</span>
<span class="n">FMOD_DSP_ECHO_DELAYCHANGEMODE_NONE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_ECHO_DELAYCHANGEMODE_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_ECHO_DELAYCHANGEMODE_TYPE</span>
<span class="p">{</span>
<span class="n">FADE</span><span class="p">,</span>
<span class="n">LERP</span><span class="p">,</span>
<span class="n">NONE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span> <span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ECHO_DELAYCHANGEMODE_FADE</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ECHO_DELAYCHANGEMODE_LERP</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ECHO_DELAYCHANGEMODE_NONE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_echo_delaychangemode_fade">FMOD_DSP_ECHO_DELAYCHANGEMODE_FADE</dt>
<dd>The ramp delay change mode will fade-in the new delay value and fade-out the old delay value. This is best suited for large, fast parameter changes.</dd>
<dt id="fmod_dsp_echo_delaychangemode_lerp">FMOD_DSP_ECHO_DELAYCHANGEMODE_LERP</dt>
<dd>The lerp delay change mode will use linear interpolation to approach the new delay target. This is best suited for small, slow parameter changes, and for emulating the doppler effect.</dd>
<dt id="fmod_dsp_echo_delaychangemode_none">FMOD_DSP_ECHO_DELAYCHANGEMODE_NONE</dt>
<dd>The none delay change mode will disable value smoothing between delay changes.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_echo_delaychangemode">FMOD_DSP_ECHO_DELAYCHANGEMODE</a></p>
<h2 api="enum" id="fmod_dsp_fader"><a href="#fmod_dsp_fader">FMOD_DSP_FADER</a></h2>
<p><a href="effects-reference.html#fader">Fader DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_FADER</span> <span class="p">{</span>
<span class="n">FMOD_DSP_FADER_GAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_FADER_OVERALL_GAIN</span>
<span class="p">}</span> <span class="n">FMOD_DSP_FADER</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_FADER</span>
<span class="p">{</span>
<span class="n">GAIN</span><span class="p">,</span>
<span class="n">OVERALL_GAIN</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
<div class="admonition language-javascript">
<p>Not supported for JavaScript.</p>
</div>
<dl>
<dt id="fmod_dsp_fader_gain">FMOD_DSP_FADER_GAIN</dt>
<dd>
<p><a href="glossary.html#signal">Signal</a> gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_fader_overall_gain">FMOD_DSP_FADER_OVERALL_GAIN</dt>
<dd>
<p>Overall gain to allow FMOD to know the DSP is scaling the signal for visualization purposes.</p>
<ul>
<li>Type: data (<a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_overallgain">FMOD_DSP_PARAMETER_OVERALLGAIN</a>)</li>
</ul>
</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_fader">FMOD_DSP_TYPE_FADER</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_fft"><a href="#fmod_dsp_fft">FMOD_DSP_FFT</a></h2>
<p><a href="effects-reference.html#fft">FFT DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_FFT</span> <span class="p">{</span>
<span class="n">FMOD_DSP_FFT_WINDOWSIZE</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_WINDOW</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_BAND_START_FREQ</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_BAND_STOP_FREQ</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_SPECTRUMDATA</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_RMS</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_SPECTRAL_CENTROID</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_IMMEDIATE_MODE</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_DOWNMIX</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_CHANNEL</span>
<span class="p">}</span> <span class="n">FMOD_DSP_FFT</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_FFT</span>
<span class="p">{</span>
<span class="n">WINDOWSIZE</span><span class="p">,</span>
<span class="n">WINDOW</span><span class="p">,</span>
<span class="n">BAND_START_FREQ</span><span class="p">,</span>
<span class="n">BAND_STOP_FREQ</span><span class="p">,</span>
<span class="n">SPECTRUMDATA</span><span class="p">,</span>
<span class="n">RMS</span><span class="p">,</span>
<span class="n">SPECTRAL_CENTROID</span><span class="p">,</span>
<span class="n">IMMEDIATE_MODE</span><span class="p">,</span>
<span class="n">DOWNMIX</span><span class="p">,</span>
<span class="n">CHANNEL</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_WINDOWSIZE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_WINDOW</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_BAND_START_FREQ</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_BAND_STOP_FREQ</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_SPECTRUMDATA</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_RMS</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_SPECTRAL_CENTROID</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_IMMEDIATE_MODE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_DOWNMIX</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_CHANNEL</span>
</pre></div>
<dl>
<dt id="fmod_dsp_fft_windowsize">FMOD_DSP_FFT_WINDOWSIZE</dt>
<dd>
<p>Window size. Must be a power of 2 between 128 and 16384.</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 2048</li>
</ul>
</dd>
<dt id="fmod_dsp_fft_window">FMOD_DSP_FFT_WINDOW</dt>
<dd>
<p>FFT Window Type.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_window_type">FMOD_DSP_FFT_WINDOW_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_window_hamming">FMOD_DSP_FFT_WINDOW_HAMMING</a></li>
</ul>
</dd>
<dt id="fmod_dsp_fft_band_start_freq">FMOD_DSP_FFT_BAND_START_FREQ</dt>
<dd>
<p>The start frequency of the analysis band.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_fft_band_stop_freq">FMOD_DSP_FFT_BAND_STOP_FREQ</dt>
<dd>
<p>The stop frequency of the analysis band.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Default:</span> 22000</li>
</ul>
</dd>
<dt id="fmod_dsp_fft_spectrumdata">FMOD_DSP_FFT_SPECTRUMDATA <span><a class="token" href="glossary.html#documentation-conventions" title="Read-only">R/O</a></span></dt>
<dd>
<p>Returns the current spectrum values between 0 and 1 for each 'fft bin'. Divide the Nyquist frequency by the window size to get the hz value per entry. </p>
<ul>
<li>Type: data (<a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_fft">FMOD_DSP_PARAMETER_FFT</a>)</li>
</ul>
</dd>
<dt id="fmod_dsp_fft_rms">FMOD_DSP_FFT_RMS <span><a class="token" href="glossary.html#documentation-conventions" title="Read-only">R/O</a></span></dt>
<dd>
<p>The total RMS value of the spectral components within the analysis band.</p>
<ul>
<li>Type: float</li>
</ul>
</dd>
<dt id="fmod_dsp_fft_spectral_centroid">FMOD_DSP_FFT_SPECTRAL_CENTROID <span><a class="token" href="glossary.html#documentation-conventions" title="Read-only">R/O</a></span></dt>
<dd>
<p>Returns the centroid of the spectral components within the analysis band for the first channel.</p>
<ul>
<li>Type: float</li>
</ul>
</dd>
<dt id="fmod_dsp_fft_immediate_mode">FMOD_DSP_FFT_IMMEDIATE_MODE</dt>
<dd>
<p>Immediate Mode. False = data requests will have a delay on first time use and hardware acceleration, if available, will be used. True = data requests will have no delay on first time use, and no hardware acceleration will be used.</p>
<ul>
<li>Type: bool</li>
<li><span class="label">Default:</span> false</li>
</ul>
</dd>
<dt id="fmod_dsp_fft_downmix">FMOD_DSP_FFT_DOWNMIX</dt>
<dd>
<p>Downmix mode. If set to <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_downmix_mono">FMOD_DSP_FFT_DOWNMIX_MONO</a>, the DSP will downmix the input signal to mono before analysis, producing a single spectrum. Note that this only affects the analysis - the DSP will pass the unmodified signal through to its output regardless of the downmix setting.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_downmix_type">FMOD_DSP_FFT_DOWNMIX_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_downmix_none">FMOD_DSP_FFT_DOWNMIX_NONE</a></li>
</ul>
</dd>
<dt id="fmod_dsp_fft_channel">FMOD_DSP_FFT_CHANNEL</dt>
<dd>
<p>The channel to analyze. If set to -1, all channels will be analyzed, producing multiple spectra. Otherwise only the specified channel will be analyzed, producing a single spectrum.</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> -1</li>
</ul>
</dd>
</dl>
<p>Set the attributes for the spectrum analysis with <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_windowsize">FMOD_DSP_FFT_WINDOWSIZE</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_window">FMOD_DSP_FFT_WINDOW</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_band_start_freq">FMOD_DSP_FFT_BAND_START_FREQ</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_band_stop_freq">FMOD_DSP_FFT_BAND_STOP_FREQ</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_downmix">FMOD_DSP_FFT_DOWNMIX</a>, and <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_channel">FMOD_DSP_FFT_CHANNEL</a>.<br />
Retrieve the results with <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_spectrumdata">FMOD_DSP_FFT_SPECTRUMDATA</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_rms">FMOD_DSP_FFT_RMS</a> and <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_spectral_centroid">FMOD_DSP_FFT_SPECTRAL_CENTROID</a>.<br />
<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_spectrumdata">FMOD_DSP_FFT_SPECTRUMDATA</a> stores its data in the <a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_data_type_fft">FMOD_DSP_PARAMETER_DATA_TYPE_FFT</a>. You will need to cast to this structure to get the right data.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_fft">FMOD_DSP_TYPE_FFT</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterdata">DSP::setParameterData</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_window_type">FMOD_DSP_FFT_WINDOW_TYPE</a></p>
<h2 api="enum" id="fmod_dsp_fft_downmix_type"><a href="#fmod_dsp_fft_downmix_type">FMOD_DSP_FFT_DOWNMIX_TYPE</a></h2>
<p>List of downmix modes for the FFT DSP.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_FFT_DOWNMIX_TYPE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_FFT_DOWNMIX_NONE</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_DOWNMIX_MONO</span>
<span class="p">}</span> <span class="n">FMOD_DSP_FFT_DOWNMIX_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_FFT_DOWNMIX_TYPE</span>
<span class="p">{</span>
<span class="n">NONE</span><span class="p">,</span>
<span class="n">MONO</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_DOWNMIX_NONE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_DOWNMIX_MONO</span>
</pre></div>
<dl>
<dt id="fmod_dsp_fft_downmix_none">FMOD_DSP_FFT_DOWNMIX_NONE</dt>
<dd>No downmix.</dd>
<dt id="fmod_dsp_fft_downmix_mono">FMOD_DSP_FFT_DOWNMIX_MONO</dt>
<dd>Downmix to mono.</dd>
</dl>
<p>Used to specify the downmix applied by the FFT DSP before spectrum analysis.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft">FMOD_DSP_FFT</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_fft">FMOD_DSP_TYPE_FFT</a></p>
<h2 api="enum" id="fmod_dsp_fft_window_type"><a href="#fmod_dsp_fft_window_type">FMOD_DSP_FFT_WINDOW_TYPE</a></h2>
<p>List of windowing methods for the <a href="effects-reference.html#fft">FFT DSP</a>.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_FFT_WINDOW_TYPE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_FFT_WINDOW_RECT</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_WINDOW_TRIANGLE</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_WINDOW_HAMMING</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_WINDOW_HANNING</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_WINDOW_BLACKMAN</span><span class="p">,</span>
<span class="n">FMOD_DSP_FFT_WINDOW_BLACKMANHARRIS</span>
<span class="p">}</span> <span class="n">FMOD_DSP_FFT_WINDOW_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_FFT_WINDOW_TYPE</span>
<span class="p">{</span>
<span class="n">RECT</span><span class="p">,</span>
<span class="n">TRIANGLE</span><span class="p">,</span>
<span class="n">HAMMING</span><span class="p">,</span>
<span class="n">HANNING</span><span class="p">,</span>
<span class="n">BLACKMAN</span><span class="p">,</span>
<span class="n">BLACKMANHARRIS</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_WINDOW_RECT</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_WINDOW_TRIANGLE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_WINDOW_HAMMING</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_WINDOW_HANNING</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_WINDOW_BLACKMAN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FFT_WINDOW_BLACKMANHARRIS</span>
</pre></div>
<dl>
<dt id="fmod_dsp_fft_window_rect">FMOD_DSP_FFT_WINDOW_RECT</dt>
<dd>w[n] = 1.0 </dd>
<dt id="fmod_dsp_fft_window_triangle">FMOD_DSP_FFT_WINDOW_TRIANGLE</dt>
<dd>w[n] = TRI(2n/N) </dd>
<dt id="fmod_dsp_fft_window_hamming">FMOD_DSP_FFT_WINDOW_HAMMING</dt>
<dd>w[n] = 0.54 - (0.46 * COS(n/N) ) </dd>
<dt id="fmod_dsp_fft_window_hanning">FMOD_DSP_FFT_WINDOW_HANNING</dt>
<dd>w[n] = 0.5 * (1.0 - COS(n/N) ) </dd>
<dt id="fmod_dsp_fft_window_blackman">FMOD_DSP_FFT_WINDOW_BLACKMAN</dt>
<dd>w[n] = 0.42 - (0.5 * COS(n/N) ) + (0.08 * COS(2.0 * n/N) ) </dd>
<dt id="fmod_dsp_fft_window_blackmanharris">FMOD_DSP_FFT_WINDOW_BLACKMANHARRIS</dt>
<dd>w[n] = 0.35875 - (0.48829 * COS(1.0 * n/N)) + (0.14128 * COS(2.0 * n/N)) - (0.01168 * COS(3.0 * n/N)) </dd>
</dl>
<p>Used in spectrum analysis to reduce leakage / transient <a href="glossary.html#signal">signals</a> interfering with the analysis. This is a problem with analysis of continuous signals that only have a small portion of the signal sample (the fft window size). Windowing the signal with a curve or triangle tapers the sides of the fft window to help alleviate this problem.</p>
<p>Cyclic signals such as a sine wave that repeat their cycle in a multiple of the window size do not need windowing. I.e. If the sine wave repeats every 1024, 512, 256 etc samples and the FMOD fft window is 1024, then the signal would not need windowing.</p>
<p>Not windowing is represented by <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_window_rect">FMOD_DSP_FFT_WINDOW_RECT</a>. If the cycle of the signal (ie the sine wave) is not a multiple of the window size, it will cause frequency abnormalities, so a different windowing method is needed.</p>
<p><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_window_rect">FMOD_DSP_FFT_WINDOW_RECT</a></p>
<p><img alt="FFT Window Rectangle" src="images/dsp-fft-rectangle.png" /></p>
<p><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_window_triangle">FMOD_DSP_FFT_WINDOW_TRIANGLE</a></p>
<p><img alt="FFT Window Triangle" src="images/dsp-fft-triangle.png" /></p>
<p><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_window_hamming">FMOD_DSP_FFT_WINDOW_HAMMING</a></p>
<p><img alt="FFT Window Hamming" src="images/dsp-fft-hamming.png" /></p>
<p><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_window_hanning">FMOD_DSP_FFT_WINDOW_HANNING</a></p>
<p><img alt="FFT Window Hanning" src="images/dsp-fft-hanning.png" /></p>
<p><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_window_blackman">FMOD_DSP_FFT_WINDOW_BLACKMAN</a></p>
<p><img alt="FFT Window Blackman" src="images/dsp-fft-blackman.png" /></p>
<p><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft_window_blackmanharris">FMOD_DSP_FFT_WINDOW_BLACKMANHARRIS</a></p>
<p><img alt="FFT Window Blackman Harris" src="images/dsp-fft-blackmanharris.png" /></p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft">FMOD_DSP_FFT</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_fft">FMOD_DSP_TYPE_FFT</a></p>
<h2 api="enum" id="fmod_dsp_flange"><a href="#fmod_dsp_flange">FMOD_DSP_FLANGE</a></h2>
<p><a href="effects-reference.html#flange">Flange DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_FLANGE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_FLANGE_MIX</span><span class="p">,</span>
<span class="n">FMOD_DSP_FLANGE_DEPTH</span><span class="p">,</span>
<span class="n">FMOD_DSP_FLANGE_RATE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_FLANGE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_FLANGE</span>
<span class="p">{</span>
<span class="n">MIX</span><span class="p">,</span>
<span class="n">DEPTH</span><span class="p">,</span>
<span class="n">RATE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FLANGE_MIX</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FLANGE_DEPTH</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_FLANGE_RATE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_flange_mix">FMOD_DSP_FLANGE_MIX</dt>
<dd>
<p>Percentage of wet <a href="glossary.html#signal">signal</a> in the mix.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Percentage</li>
<li><span class="label">Range:</span> [0, 100]</li>
<li><span class="label">Default:</span> 50</li>
</ul>
</dd>
<dt id="fmod_dsp_flange_depth">FMOD_DSP_FLANGE_DEPTH</dt>
<dd>
<p>Flange depth.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0.01, 1]</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
<dt id="fmod_dsp_flange_rate">FMOD_DSP_FLANGE_RATE</dt>
<dd>
<p>Flange speed.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [0, 20]</li>
<li><span class="label">Default:</span> .1</li>
</ul>
</dd>
</dl>
<p>Flange is an <a href="glossary.html#effect">effect</a> where the signal is played twice at the same time, and one copy slides back and forth creating a whooshing or flanging effect. As there are 2 versions of the same signal (dry vs wet), by default each signal is given 50% mix, so that the total is not louder than the original unaffected signal.</p>
<p>Flange depth is a percentage of a 10ms shift from the original signal. Anything above 10ms is not considered flange because to the ear it begins to 'echo' so 10ms is the highest value possible.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_flange">FMOD_DSP_TYPE_FLANGE</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_highpass"><a href="#fmod_dsp_highpass">FMOD_DSP_HIGHPASS</a></h2>
<p><a href="effects-reference.html#high-pass">Highpass DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_HIGHPASS</span> <span class="p">{</span>
<span class="n">FMOD_DSP_HIGHPASS_CUTOFF</span><span class="p">,</span>
<span class="n">FMOD_DSP_HIGHPASS_RESONANCE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_HIGHPASS</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_HIGHPASS</span>
<span class="p">{</span>
<span class="n">CUTOFF</span><span class="p">,</span>
<span class="n">RESONANCE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_HIGHPASS_CUTOFF</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_HIGHPASS_RESONANCE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_highpass_cutoff">FMOD_DSP_HIGHPASS_CUTOFF</dt>
<dd>
<p>Highpass cutoff frequency.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [1, 22000]</li>
<li><span class="label">Default:</span> 5000</li>
</ul>
</dd>
<dt id="fmod_dsp_highpass_resonance">FMOD_DSP_HIGHPASS_RESONANCE</dt>
<dd>
<p>Highpass resonance Q value.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Range:</span> [1, 10]</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
</dl>
<p>Deprecated and will be removed in a future release, to emulate with <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_multiband_eq">FMOD_DSP_TYPE_MULTIBAND_EQ</a>:</p>
<div class="highlight language-c"><pre><span></span><span class="c1">// Configure a single band (band A) as a highpass (all other bands default to off).</span>
<span class="c1">// 12dB roll-off to approximate the old effect curve.</span>
<span class="c1">// Cutoff frequency can be used the same as with the old effect.</span>
<span class="c1">// Resonance can be applied by setting the &#39;Q&#39; value of the new effect.</span>
<span class="n">FMOD_DSP_SetParameterInt</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_FILTER</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_12DB</span><span class="p">);</span>
<span class="n">FMOD_DSP_SetParameterFloat</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_FREQUENCY</span><span class="p">,</span> <span class="n">frequency</span><span class="p">);</span>
<span class="n">FMOD_DSP_SetParameterFloat</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_Q</span><span class="p">,</span> <span class="n">resonance</span><span class="p">);</span>
</pre></div>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_highpass">FMOD_DSP_TYPE_HIGHPASS</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_highpass_simple"><a href="#fmod_dsp_highpass_simple">FMOD_DSP_HIGHPASS_SIMPLE</a></h2>
<p><a href="effects-reference.html#high-pass-simple">High pass simple DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_HIGHPASS_SIMPLE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_HIGHPASS_SIMPLE_CUTOFF</span>
<span class="p">}</span> <span class="n">FMOD_DSP_HIGHPASS_SIMPLE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_HIGHPASS_SIMPLE</span>
<span class="p">{</span>
<span class="n">CUTOFF</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_HIGHPASS_SIMPLE_CUTOFF</span>
</pre></div>
<dl>
<dt id="fmod_dsp_highpass_simple_cutoff">FMOD_DSP_HIGHPASS_SIMPLE_CUTOFF</dt>
<dd>
<p>Highpass cutoff frequency.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [1, 22000]</li>
<li><span class="label">Default:</span> 5000</li>
</ul>
</dd>
</dl>
<p>Deprecated and will be removed in a future release, to emulate with <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_multiband_eq">FMOD_DSP_TYPE_MULTIBAND_EQ</a>:</p>
<div class="highlight language-c"><pre><span></span><span class="c1">// Configure a single band (band A) as a highpass (all other bands default to off).</span>
<span class="c1">// 12dB roll-off to approximate the old effect curve.</span>
<span class="c1">// Cutoff frequency can be used the same as with the old effect.</span>
<span class="c1">// Resonance / &#39;Q&#39; should remain at default 0.707.</span>
<span class="n">FMOD_DSP_SetParameterInt</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_FILTER</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_12DB</span><span class="p">);</span>
<span class="n">FMOD_DSP_SetParameterFloat</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_FREQUENCY</span><span class="p">,</span> <span class="n">frequency</span><span class="p">);</span>
</pre></div>
<p>This is a very simple single-order high pass filter. The emphasis is on speed rather than accuracy, so this should not be used for task requiring critical filtering.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_highpass_simple">FMOD_DSP_TYPE_HIGHPASS_SIMPLE</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_itecho"><a href="#fmod_dsp_itecho">FMOD_DSP_ITECHO</a></h2>
<p><a href="effects-reference.html#it-echo">IT echo DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_ITECHO</span> <span class="p">{</span>
<span class="n">FMOD_DSP_ITECHO_WETDRYMIX</span><span class="p">,</span>
<span class="n">FMOD_DSP_ITECHO_FEEDBACK</span><span class="p">,</span>
<span class="n">FMOD_DSP_ITECHO_LEFTDELAY</span><span class="p">,</span>
<span class="n">FMOD_DSP_ITECHO_RIGHTDELAY</span><span class="p">,</span>
<span class="n">FMOD_DSP_ITECHO_PANDELAY</span>
<span class="p">}</span> <span class="n">FMOD_DSP_ITECHO</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_ITECHO</span>
<span class="p">{</span>
<span class="n">WETDRYMIX</span><span class="p">,</span>
<span class="n">FEEDBACK</span><span class="p">,</span>
<span class="n">LEFTDELAY</span><span class="p">,</span>
<span class="n">RIGHTDELAY</span><span class="p">,</span>
<span class="n">PANDELAY</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ITECHO_WETDRYMIX</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ITECHO_FEEDBACK</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ITECHO_LEFTDELAY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ITECHO_RIGHTDELAY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ITECHO_PANDELAY</span>
</pre></div>
<dl>
<dt id="fmod_dsp_itecho_wetdrymix">FMOD_DSP_ITECHO_WETDRYMIX</dt>
<dd>
<p>Ratio of wet (processed) <a href="glossary.html#signal">signal</a> to dry (unprocessed) signal. Higher is wetter.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Percentage</li>
<li><span class="label">Range:</span> [0, 100]</li>
<li><span class="label">Default:</span> 50</li>
</ul>
</dd>
<dt id="fmod_dsp_itecho_feedback">FMOD_DSP_ITECHO_FEEDBACK</dt>
<dd>
<p>Percentage of output fed back into input.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Percentage</li>
<li><span class="label">Range:</span> [0, 100]</li>
<li><span class="label">Default:</span> 50</li>
</ul>
</dd>
<dt id="fmod_dsp_itecho_leftdelay">FMOD_DSP_ITECHO_LEFTDELAY</dt>
<dd>
<p>Delay for left channel.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [1, 2000]</li>
<li><span class="label">Default:</span> 500</li>
</ul>
</dd>
<dt id="fmod_dsp_itecho_rightdelay">FMOD_DSP_ITECHO_RIGHTDELAY</dt>
<dd>
<p>Delay for right channel.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [1, 2000]</li>
<li><span class="label">Default:</span> 500</li>
</ul>
</dd>
<dt id="fmod_dsp_itecho_pandelay">FMOD_DSP_ITECHO_PANDELAY</dt>
<dd>
<p>Value that specifies whether to swap left and right delays with each successive echo. CURRENTLY NOT SUPPORTED.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Range:</span> 0, 1</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
</dl>
<p>This is effectively a software based echo filter that emulates the DirectX DMO echo effect. Impulse tracker files can support this, and FMOD will produce the <a href="glossary.html#effect">effect</a> on ANY platform, not just those that support DirectX effects!</p>
<p>Every time the delay is changed, the plug-in reallocates the echo buffer. This means the echo disappears at that time while it refills its new buffer. Larger echo delays result in larger amounts of memory allocated.</p>
<p>As this is a stereo filter made mainly for IT playback, it is targeted for stereo signals. With mono signals only the <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_itecho_leftdelay">FMOD_DSP_ITECHO_LEFTDELAY</a> is used. For multi-channel signals (&gt;2) there will be no echo on those channels.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_itecho">FMOD_DSP_TYPE_ITECHO</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_itlowpass"><a href="#fmod_dsp_itlowpass">FMOD_DSP_ITLOWPASS</a></h2>
<p>Lowpass <a href="glossary.html#dsp">DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_ITLOWPASS</span> <span class="p">{</span>
<span class="n">FMOD_DSP_ITLOWPASS_CUTOFF</span><span class="p">,</span>
<span class="n">FMOD_DSP_ITLOWPASS_RESONANCE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_ITLOWPASS</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_ITLOWPASS</span>
<span class="p">{</span>
<span class="n">CUTOFF</span><span class="p">,</span>
<span class="n">RESONANCE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ITLOWPASS_CUTOFF</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_ITLOWPASS_RESONANCE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_itlowpass_cutoff">FMOD_DSP_ITLOWPASS_CUTOFF</dt>
<dd>
<p>Lowpass cutoff frequency.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [1, 22000]</li>
<li><span class="label">Default:</span> 5000</li>
</ul>
</dd>
<dt id="fmod_dsp_itlowpass_resonance">FMOD_DSP_ITLOWPASS_RESONANCE</dt>
<dd>
<p>Lowpass resonance Q value.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Range:</span> [0, 127]</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
</dl>
<p>The <a href="glossary.html#fmod-engine">FMOD Engine</a>'s .IT playback (<a href="core-api-sound.html#fmod_sound_type">FMOD_SOUND_TYPE_IT</a>) uses this filter.</p>
<p>This is different to the default <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_itlowpass">FMOD_DSP_TYPE_ITLOWPASS</a> filter in that it uses a different quality algorithm and is the filter used to produce the correct sounding playback in .IT files.</p>
<p>Note! This filter actually has a limited cutoff frequency below the specified maximum, due to its limited design. For a more open range filter, use <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_lowpass">FMOD_DSP_LOWPASS</a>, or if you don't mind not having resonance, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_lowpass_simple">FMOD_DSP_LOWPASS_SIMPLE</a>.</p>
<p>The effective maximum cutoff is about 8060hz.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_itlowpass">FMOD_DSP_TYPE_ITLOWPASS</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_limiter"><a href="#fmod_dsp_limiter">FMOD_DSP_LIMITER</a></h2>
<p><a href="effects-reference.html#limiter">Limiter DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_LIMITER</span> <span class="p">{</span>
<span class="n">FMOD_DSP_LIMITER_RELEASETIME</span><span class="p">,</span>
<span class="n">FMOD_DSP_LIMITER_CEILING</span><span class="p">,</span>
<span class="n">FMOD_DSP_LIMITER_MAXIMIZERGAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_LIMITER_MODE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_LIMITER</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_LIMITER</span>
<span class="p">{</span>
<span class="n">RELEASETIME</span><span class="p">,</span>
<span class="n">CEILING</span><span class="p">,</span>
<span class="n">MAXIMIZERGAIN</span><span class="p">,</span>
<span class="n">MODE</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LIMITER_RELEASETIME</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LIMITER_CEILING</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LIMITER_MAXIMIZERGAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LIMITER_MODE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_limiter_releasetime">FMOD_DSP_LIMITER_RELEASETIME</dt>
<dd>
<p>Time to return the gain reduction to full in ms.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [1, 1000]</li>
<li><span class="label">Default:</span> 10</li>
</ul>
</dd>
<dt id="fmod_dsp_limiter_ceiling">FMOD_DSP_LIMITER_CEILING</dt>
<dd>
<p>Maximum level of the output <a href="glossary.html#signal">signal</a>.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-12, 0]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_limiter_maximizergain">FMOD_DSP_LIMITER_MAXIMIZERGAIN</dt>
<dd>
<p>Maximum amplification allowed.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [0, 12]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_limiter_mode">FMOD_DSP_LIMITER_MODE</dt>
<dd>
<p>Channel processing mode where false is independent (limiter per channel) and true is linked (all channels are summed together before processing).</p>
<ul>
<li>Type: bool</li>
<li><span class="label">Default:</span> false</li>
</ul>
</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_limiter">FMOD_DSP_TYPE_LIMITER</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_loudness_meter"><a href="#fmod_dsp_loudness_meter">FMOD_DSP_LOUDNESS_METER</a></h2>
<p><span class="dead-link" href="effects-reference.html#loudness-meter">Loudness meter DSP</span class="dead-link"> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_LOUDNESS_METER</span> <span class="p">{</span>
<span class="n">FMOD_DSP_LOUDNESS_METER_STATE</span><span class="p">,</span>
<span class="n">FMOD_DSP_LOUDNESS_METER_WEIGHTING</span><span class="p">,</span>
<span class="n">FMOD_DSP_LOUDNESS_METER_INFO</span>
<span class="p">}</span> <span class="n">FMOD_DSP_LOUDNESS_METER</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_LOUDNESS_METER</span>
<span class="p">{</span>
<span class="n">STATE</span><span class="p">,</span>
<span class="n">WEIGHTING</span><span class="p">,</span>
<span class="n">INFO</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LOUDNESS_METER_STATE</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LOUDNESS_METER_WEIGHTING</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LOUDNESS_METER_INFO</span>
</pre></div>
<dl>
<dt id="fmod_dsp_loudness_meter_state">FMOD_DSP_LOUDNESS_METER_STATE</dt>
<dd>
<p>Update state.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_loudness_meter_state_type">FMOD_DSP_LOUDNESS_METER_STATE_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_loudness_meter_state_analyzing">FMOD_DSP_LOUDNESS_METER_STATE_ANALYZING</a></li>
</ul>
</dd>
<dt id="fmod_dsp_loudness_meter_weighting">FMOD_DSP_LOUDNESS_METER_WEIGHTING</dt>
<dd>
<p>Channel weighting.</p>
<ul>
<li>Type: data (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_loudness_meter_weighting_type">FMOD_DSP_LOUDNESS_METER_WEIGHTING_TYPE</a>)</li>
</ul>
</dd>
<dt id="fmod_dsp_loudness_meter_info">FMOD_DSP_LOUDNESS_METER_INFO <span><a class="token" href="glossary.html#documentation-conventions" title="Read-only">R/O</a></span></dt>
<dd>
<p>Metering information.</p>
<ul>
<li>Type: data (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_loudness_meter_info_type">FMOD_DSP_LOUDNESS_METER_INFO_TYPE</a>)</li>
</ul>
</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_loudness_meter">FMOD_DSP_TYPE_LOUDNESS_METER</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterdata">DSP::setParameterData</a></p>
<h2 api="struct" id="fmod_dsp_loudness_meter_info_type"><a href="#fmod_dsp_loudness_meter_info_type">FMOD_DSP_LOUDNESS_METER_INFO_TYPE</a></h2>
<p>Loudness meter information data structure.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">struct</span> <span class="n">FMOD_DSP_LOUDNESS_METER_INFO_TYPE</span>
<span class="p">{</span>
<span class="kt">float</span> <span class="n">momentaryloudness</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">shorttermloudness</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">integratedloudness</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">loudness10thpercentile</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">loudness95thpercentile</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">loudnesshistogram</span><span class="p">[</span><span class="mi">66</span><span class="p">];</span>
<span class="kt">float</span> <span class="n">maxtruepeak</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">maxmomentaryloudness</span><span class="p">;</span>
<span class="p">}</span> <span class="n">FMOD_DSP_LOUDNESS_METER_INFO_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">struct</span> <span class="nc">DSP_LOUDNESS_METER_INFO_TYPE</span>
<span class="p">{</span>
<span class="kt">float</span> <span class="n">momentaryloudness</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">shorttermloudness</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">integratedloudness</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">loudness10thpercentile</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">loudness95thpercentile</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">loudnesshistogram</span><span class="p">[</span><span class="m">66</span><span class="p">];</span>
<span class="kt">float</span> <span class="n">maxtruepeak</span><span class="p">;</span>
<span class="kt">float</span> <span class="n">maxmomentaryloudness</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD_DSP_LOUDNESS_METER_INFO_TYPE</span>
<span class="p">{</span>
<span class="nx">momentaryloudness</span><span class="p">;</span>
<span class="nx">shorttermloudness</span><span class="p">;</span>
<span class="nx">integratedloudness</span><span class="p">;</span>
<span class="nx">loudness10thpercentile</span><span class="p">;</span>
<span class="nx">loudness95thpercentile</span><span class="p">;</span>
<span class="nx">loudnesshistogram</span><span class="p">;</span>
<span class="nx">maxtruepeak</span><span class="p">;</span>
<span class="nx">maxmomentaryloudness</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
<dl>
<dt id="fmod_dsp_loudness_meter_info_type_momentaryloudness">momentaryloudness</dt>
<dd>Loudness value indicating current loudness. Calculated using a 400ms window.</dd>
</dl>
<ul>
<li>Units: Decibels</li>
<li>Range: [-80, inf)</li>
</ul>
<dl>
<dt id="fmod_dsp_loudness_meter_info_type_shorttermloudness">shorttermloudness</dt>
<dd>Loudness value indicating loudness averaged over a short time duration. Calculated using a 3 second window.</dd>
</dl>
<ul>
<li>Units: Decibels</li>
<li>Range: [-80, inf)</li>
</ul>
<dl>
<dt id="fmod_dsp_loudness_meter_info_type_integratedloudness">integratedloudness</dt>
<dd>Loudness value indicating loudness over the entire duration of the recording period.</dd>
</dl>
<ul>
<li>Units: Decibels</li>
<li>Range: [-80, inf)</li>
</ul>
<dl>
<dt id="fmod_dsp_loudness_meter_info_type_loudness10thpercentile">loudness10thpercentile</dt>
<dd>10th percentile loudness (towards lowest loudness). Uses short term loudness values (3 second averages).</dd>
</dl>
<ul>
<li>Units: Decibels</li>
<li>Range: [-80, inf)</li>
</ul>
<dl>
<dt id="fmod_dsp_loudness_meter_info_type_loudness95thpercentile">loudness95thpercentile</dt>
<dd>95th percentile loudness (towards highest loudness). Uses short term loudness values (3 second averages).</dd>
</dl>
<ul>
<li>Units: Decibels</li>
<li>Range: [-80, inf)</li>
</ul>
<dl>
<dt id="fmod_dsp_loudness_meter_info_type_loudnesshistogram">loudnesshistogram</dt>
<dd>Array containing distribution of loudness values. Each array entry is a count of the momentary loudness values (400ms averages) evenly distributed along the range [-60, 6] excluding loudness values outside that range.</dd>
<dt id="fmod_dsp_loudness_meter_info_type_maxtruepeak">maxtruepeak</dt>
<dd>Highest peak.</dd>
</dl>
<ul>
<li>Units: Decibels</li>
<li>Range: [-80, inf)</li>
</ul>
<dl>
<dt id="fmod_dsp_loudness_meter_info_type_maxmomentaryloudness">maxmomentaryloudness</dt>
<dd>Highest momentary loudness value (400ms averages).</dd>
</dl>
<ul>
<li>Units: Decibels</li>
<li>Range: [-80, inf)</li>
</ul>
<p><strong>See Also:</strong> <a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_data_type">FMOD_DSP_PARAMETER_DATA_TYPE</a>, <a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_desc">FMOD_DSP_PARAMETER_DESC</a></p>
<h2 api="enum" id="fmod_dsp_loudness_meter_state_type"><a href="#fmod_dsp_loudness_meter_state_type">FMOD_DSP_LOUDNESS_METER_STATE_TYPE</a></h2>
<p>Loudness meter state indicating update behavior.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_LOUDNESS_METER_STATE_TYPE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_LOUDNESS_METER_STATE_RESET_INTEGRATED</span> <span class="o">=</span> <span class="o">-</span><span class="mi">3</span><span class="p">,</span>
<span class="n">FMOD_DSP_LOUDNESS_METER_STATE_RESET_MAXPEAK</span> <span class="o">=</span> <span class="o">-</span><span class="mi">2</span><span class="p">,</span>
<span class="n">FMOD_DSP_LOUDNESS_METER_STATE_RESET_ALL</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span>
<span class="n">FMOD_DSP_LOUDNESS_METER_STATE_PAUSED</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">FMOD_DSP_LOUDNESS_METER_STATE_ANALYZING</span> <span class="o">=</span> <span class="mi">1</span>
<span class="p">}</span> <span class="n">FMOD_DSP_LOUDNESS_METER_STATE_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_LOUDNESS_METER_STATE_TYPE</span>
<span class="p">{</span>
<span class="n">RESET_INTEGRATED</span> <span class="p">=</span> <span class="p">-</span><span class="m">3</span><span class="p">,</span>
<span class="n">RESET_MAXPEAK</span> <span class="p">=</span> <span class="p">-</span><span class="m">2</span><span class="p">,</span>
<span class="n">ESET_ALL</span> <span class="p">=</span> <span class="p">-</span><span class="m">1</span><span class="p">,</span>
<span class="n">PAUSED</span><span class="p">,</span>
<span class="n">ANALYZING</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LOUDNESS_METER_STATE_RESET_INTEGRATED</span> <span class="o">=</span> <span class="o">-</span><span class="mi">3</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LOUDNESS_METER_STATE_RESET_MAXPEAK</span> <span class="o">=</span> <span class="o">-</span><span class="mi">2</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LOUDNESS_METER_STATE_RESET_ALL</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LOUDNESS_METER_STATE_PAUSED</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LOUDNESS_METER_STATE_ANALYZING</span> <span class="o">=</span> <span class="mi">1</span>
</pre></div>
<dl>
<dt id="fmod_dsp_loudness_meter_state_reset_integrated">FMOD_DSP_LOUDNESS_METER_STATE_RESET_INTEGRATED</dt>
<dd>Reset loudness meter information except max peak.</dd>
<dt id="fmod_dsp_loudness_meter_state_reset_maxpeak">FMOD_DSP_LOUDNESS_METER_STATE_RESET_MAXPEAK</dt>
<dd>Reset loudness meter max peak.</dd>
<dt id="fmod_dsp_loudness_meter_state_reset_all">FMOD_DSP_LOUDNESS_METER_STATE_RESET_ALL</dt>
<dd>Reset all loudness meter information.</dd>
<dt id="fmod_dsp_loudness_meter_state_paused">FMOD_DSP_LOUDNESS_METER_STATE_PAUSED</dt>
<dd>Pause loudness meter.</dd>
<dt id="fmod_dsp_loudness_meter_state_analyzing">FMOD_DSP_LOUDNESS_METER_STATE_ANALYZING</dt>
<dd>Enable loudness meter recording and analyzing.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_loudness_meter">FMOD_DSP_TYPE_LOUDNESS_METER</a></p>
<h2 api="struct" id="fmod_dsp_loudness_meter_weighting_type"><a href="#fmod_dsp_loudness_meter_weighting_type">FMOD_DSP_LOUDNESS_METER_WEIGHTING_TYPE</a></h2>
<p>Loudness meter channel weighting.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">struct</span> <span class="n">FMOD_DSP_LOUDNESS_METER_WEIGHTING_TYPE</span>
<span class="p">{</span>
<span class="kt">float</span> <span class="n">channelweight</span><span class="p">[</span><span class="mi">32</span><span class="p">];</span>
<span class="p">}</span> <span class="n">FMOD_DSP_LOUDNESS_METER_WEIGHTING_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">struct</span> <span class="nc">DSP_LOUDNESS_METER_WEIGHTING_TYPE</span>
<span class="p">{</span>
<span class="kt">float</span> <span class="n">channelweight</span><span class="p">[</span><span class="m">32</span><span class="p">];</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD_DSP_LOUDNESS_METER_WEIGHTING_TYPE</span>
<span class="p">{</span>
<span class="nx">channelweight</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
<dl>
<dt id="fmod_dsp_loudness_meter_weighting_type_channelweight">channelweight</dt>
<dd>
<p>The weighting of each channel used in calculating loudness.</p>
<ul>
<li><span class="label">Default:</span> { 1, 1, 1, 0, 1.4, 1.4, 1.4, 1.4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }</li>
</ul>
</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_data_type">FMOD_DSP_PARAMETER_DATA_TYPE</a>, <a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_desc">FMOD_DSP_PARAMETER_DESC</a></p>
<h2 api="enum" id="fmod_dsp_lowpass"><a href="#fmod_dsp_lowpass">FMOD_DSP_LOWPASS</a></h2>
<p><a href="effects-reference.html#low-pass">Low pass DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_LOWPASS</span> <span class="p">{</span>
<span class="n">FMOD_DSP_LOWPASS_CUTOFF</span><span class="p">,</span>
<span class="n">FMOD_DSP_LOWPASS_RESONANCE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_LOWPASS</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_LOWPASS</span>
<span class="p">{</span>
<span class="n">CUTOFF</span><span class="p">,</span>
<span class="n">RESONANCE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LOWPASS_CUTOFF</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LOWPASS_RESONANCE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_lowpass_cutoff">FMOD_DSP_LOWPASS_CUTOFF</dt>
<dd>
<p>Lowpass cutoff frequency.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [1, 22000]</li>
<li><span class="label">Default:</span> 5000</li>
</ul>
</dd>
<dt id="fmod_dsp_lowpass_resonance">FMOD_DSP_LOWPASS_RESONANCE</dt>
<dd>
<p>Lowpass resonance Q value.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Range:</span> [0, 10]</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
</dl>
<p>Deprecated and will be removed in a future release, to emulate with <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_multiband_eq">FMOD_DSP_TYPE_MULTIBAND_EQ</a>:</p>
<div class="highlight language-c"><pre><span></span><span class="c1">// Configure a single band (band A) as a lowpass (all other bands default to off).</span>
<span class="c1">// 24dB roll-off to approximate the old effect curve.</span>
<span class="c1">// Cutoff frequency can be used the same as with the old effect.</span>
<span class="c1">// Resonance can be applied by setting the &#39;Q&#39; value of the new effect.</span>
<span class="n">FMOD_DSP_SetParameterInt</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_FILTER</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_24DB</span><span class="p">);</span>
<span class="n">FMOD_DSP_SetParameterFloat</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_FREQUENCY</span><span class="p">,</span> <span class="n">frequency</span><span class="p">);</span>
<span class="n">FMOD_DSP_SetParameterFloat</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_Q</span><span class="p">,</span> <span class="n">resonance</span><span class="p">);</span>
</pre></div>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_lowpass">FMOD_DSP_TYPE_LOWPASS</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_lowpass_simple"><a href="#fmod_dsp_lowpass_simple">FMOD_DSP_LOWPASS_SIMPLE</a></h2>
<p><a href="effects-reference.html#low-pass-simple">Low pass simple DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_LOWPASS_SIMPLE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_LOWPASS_SIMPLE_CUTOFF</span>
<span class="p">}</span> <span class="n">FMOD_DSP_LOWPASS_SIMPLE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_LOWPASS_SIMPLE</span>
<span class="p">{</span>
<span class="n">CUTOFF</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_LOWPASS_SIMPLE_CUTOFF</span>
</pre></div>
<dl>
<dt id="fmod_dsp_lowpass_simple_cutoff">FMOD_DSP_LOWPASS_SIMPLE_CUTOFF</dt>
<dd>
<p>Lowpass cutoff frequency.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [1, 22000]</li>
<li><span class="label">Default:</span> 5000</li>
</ul>
</dd>
</dl>
<p>Deprecated and will be removed in a future release, to emulate with <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_multiband_eq">FMOD_DSP_TYPE_MULTIBAND_EQ</a>:</p>
<div class="highlight language-c"><pre><span></span><span class="c1">// Configure a single band (band A) as a lowpass (all other bands default to off).</span>
<span class="c1">// 12dB roll-off to approximate the old effect curve.</span>
<span class="c1">// Cutoff frequency can be used the same as with the old effect.</span>
<span class="c1">// Resonance / &#39;Q&#39; should remain at default 0.707.</span>
<span class="n">FMOD_DSP_SetParameterInt</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_FILTER</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_12DB</span><span class="p">);</span>
<span class="n">FMOD_DSP_SetParameterFloat</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_FREQUENCY</span><span class="p">,</span> <span class="n">frequency</span><span class="p">);</span>
</pre></div>
<p>This is a very simple low pass filter, based on two single-pole RC time-constant modules.</p>
<p>The emphasis is on speed rather than accuracy, so this should not be used for task requiring critical filtering.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_lowpass_simple">FMOD_DSP_TYPE_LOWPASS_SIMPLE</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-dsp.html#dsp_getparameterfloat">DSP::getParameterFloat</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type">FMOD_DSP_TYPE</a></p>
<h2 api="enum" id="fmod_dsp_multiband_dynamics"><a href="#fmod_dsp_multiband_dynamics">FMOD_DSP_MULTIBAND_DYNAMICS</a></h2>
<p>Three-band compressor/expander effect.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_MULTIBAND_DYNAMICS</span>
<span class="p">{</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_LOWER_FREQUENCY</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_UPPER_FREQUENCY</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_LINKED</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_USE_SIDECHAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_A_MODE</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_A_GAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_A_THRESHOLD</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_A_RATIO</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_A_ATTACK</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_A_RELEASE</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_A_GAIN_MAKEUP</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_A_RESPONSE_DATA</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_B_MODE</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_B_GAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_B_THRESHOLD</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_B_RATIO</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_B_ATTACK</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_B_RELEASE</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_B_GAIN_MAKEUP</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_B_RESPONSE_DATA</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_C_MODE</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_C_GAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_C_THRESHOLD</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_C_RATIO</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_C_ATTACK</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_C_RELEASE</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_C_GAIN_MAKEUP</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_C_RESPONSE_DATA</span>
<span class="p">};</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_MULTIBAND_DYNAMICS</span>
<span class="p">{</span>
<span class="n">LOWER_FREQUENCY</span><span class="p">,</span>
<span class="n">UPPER_FREQUENCY</span><span class="p">,</span>
<span class="n">LINKED</span><span class="p">,</span>
<span class="n">USE_SIDECHAIN</span><span class="p">,</span>
<span class="n">A_MODE</span><span class="p">,</span>
<span class="n">A_GAIN</span><span class="p">,</span>
<span class="n">A_THRESHOLD</span><span class="p">,</span>
<span class="n">A_RATIO</span><span class="p">,</span>
<span class="n">A_ATTACK</span><span class="p">,</span>
<span class="n">A_RELEASE</span><span class="p">,</span>
<span class="n">A_GAIN_MAKEUP</span><span class="p">,</span>
<span class="n">A_RESPONSE_DATA</span><span class="p">,</span>
<span class="n">B_MODE</span><span class="p">,</span>
<span class="n">B_GAIN</span><span class="p">,</span>
<span class="n">B_THRESHOLD</span><span class="p">,</span>
<span class="n">B_RATIO</span><span class="p">,</span>
<span class="n">B_ATTACK</span><span class="p">,</span>
<span class="n">B_RELEASE</span><span class="p">,</span>
<span class="n">B_GAIN_MAKEUP</span><span class="p">,</span>
<span class="n">B_RESPONSE_DATA</span><span class="p">,</span>
<span class="n">C_MODE</span><span class="p">,</span>
<span class="n">C_GAIN</span><span class="p">,</span>
<span class="n">C_THRESHOLD</span><span class="p">,</span>
<span class="n">C_RATIO</span><span class="p">,</span>
<span class="n">C_ATTACK</span><span class="p">,</span>
<span class="n">C_RELEASE</span><span class="p">,</span>
<span class="n">C_GAIN_MAKEUP</span><span class="p">,</span>
<span class="n">C_RESPONSE_DATA</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_LOWER_FREQUENCY</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_UPPER_FREQUENCY</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_LINKED</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_USE_SIDECHAIN</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_A_MODE</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_A_GAIN</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_A_THRESHOLD</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_A_RATIO</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_A_ATTACK</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_A_RELEASE</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_A_GAIN_MAKEUP</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_A_RESPONSE_DATA</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_B_MODE</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_B_GAIN</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_B_THRESHOLD</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_B_RATIO</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_B_ATTACK</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_B_RELEASE</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_B_GAIN_MAKEUP</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_B_RESPONSE_DATA</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_C_MODE</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_C_GAIN</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_C_THRESHOLD</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_C_RATIO</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_C_ATTACK</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_C_RELEASE</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_C_GAIN_MAKEUP</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_C_RESPONSE_DATA</span>
</pre></div>
<dl>
<dt id="fmod_dsp_multiband_dynamics_lower_frequency">FMOD_DSP_MULTIBAND_DYNAMICS_LOWER_FREQUENCY</dt>
<dd>
<p>Lower crossover frequency. Band A will process the dynamic content ranging from 20Hz to this value, and Band B will process the dynamic content ranging from this value to the value of <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_dynamics_upper_frequency">FMOD_DSP_MULTIBAND_DYNAMICS_UPPER_FREQUENCY</a>.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [20, 22000]</li>
<li><span class="label">Default:</span> 400</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_dynamics_upper_frequency">FMOD_DSP_MULTIBAND_DYNAMICS_UPPER_FREQUENCY</dt>
<dd>
<p>Upper crossover frequency. Band B will process the dynamic content ranging from the value of <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_dynamics_lower_frequency">FMOD_DSP_MULTIBAND_DYNAMICS_LOWER_FREQUENCY</a> to this value, and Band C will process the dynamic content ranging from this value to 20kHz.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [20, 22000]</li>
<li><span class="label">Default:</span> 4000</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_dynamics_linked">FMOD_DSP_MULTIBAND_DYNAMICS_LINKED</dt>
<dd>
<p>Enables optimized processing mode. When set to true, the input signal is mixed down to mono before passing through the dynamic processor bands.</p>
<ul>
<li>Type: Boolean</li>
<li><span class="label">Default:</span> True</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_dynamics_use_sidechain">FMOD_DSP_MULTIBAND_DYNAMICS_USE_SIDECHAIN</dt>
<dd>
<p>Whether to analyse the sidechain signal instead of the input signal. When sidechaining is enabled the sidechain channel will be split into separate bands and analyzed for their dynamic content, but the resulting dynamic response will still be applied to the host channel.</p>
<ul>
<li>Type: (<a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_sidechain">FMOD_DSP_PARAMETER_SIDECHAIN</a>)</li>
<li><span class="label">Default:</span> False</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_dynamics_a_mode">FMOD_DSP_MULTIBAND_DYNAMICS_A_MODE</dt>
<dd>
<p>Band A: Dynamic response mode. Use this to configure how the band will respond to the envelope of the signal. The "Upward" modes will amplify the signal, and the "Downward" modes will attenuate the signal.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_dynamics_mode_type">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_dynamics_mode_compress_down">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_COMPRESS_DOWN</a></li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_dynamics_a_gain">FMOD_DSP_MULTIBAND_DYNAMICS_A_GAIN</dt>
<dd>
<p>Band A: Gain applied before dynamic processing. This amplifies or attenuates the signal before it is split into separate bands and dynamic processors.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> dB</li>
<li><span class="label">Range:</span> [-30, 30]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_dynamics_a_threshold">FMOD_DSP_MULTIBAND_DYNAMICS_A_THRESHOLD</dt>
<dd>
<p>Band A: Dynamic response threshold. This changes the threshold at which this band will start attenuating or amplifying the signal.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> dB</li>
<li><span class="label">Range:</span> [-80, 0]</li>
<li><span class="label">Default:</span> -5</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_dynamics_a_ratio">FMOD_DSP_MULTIBAND_DYNAMICS_A_RATIO</dt>
<dd>
<p>Band A: Dynamic response ratio. This changes the amount of amplification or attenuation that will be applied to the signal. The result of dynamic processing will be more subtle at lower ratio values, and will intensify as the ratio increases.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [1, 50]</li>
<li><span class="label">Default:</span> 2.5</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_dynamics_a_attack">FMOD_DSP_MULTIBAND_DYNAMICS_A_ATTACK</dt>
<dd>
<p>Band A: Dynamic attack time. This is the duration it will take the dynamic processor to apply the full ratio of amplification or attenuation. Lower values will mean the full ratio is applied quickly, and will approach the ratio value more smoothly as the attack value increases.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> ms</li>
<li><span class="label">Range:</span> [0.1, 1000]</li>
<li><span class="label">Default:</span> 20</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_dynamics_a_release">FMOD_DSP_MULTIBAND_DYNAMICS_A_RELEASE</dt>
<dd>
<p>Band A: Dynamic release time. This is the duration it will take the dynamic processor to return to stop applying amplification or attenuation. Lower values will mean the ratio stops being applied quickly, and will back off the ratio value more smoothly as the release value increases.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> ms</li>
<li><span class="label">Range:</span> [10, 5000]</li>
<li><span class="label">Default:</span> 100</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_dynamics_a_gain_makeup">FMOD_DSP_MULTIBAND_DYNAMICS_A_GAIN_MAKEUP</dt>
<dd>
<p>Band A: Gain applied after dynamic processing. This amplifies or attenuates the signal after it passes through the dynamic processors and before the split signal is mixed back together.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> dB</li>
<li><span class="label">Range:</span> [-30, 30]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_dynamics_a_response_data">FMOD_DSP_MULTIBAND_DYNAMICS_A_RESPONSE_DATA</dt>
<dd>
<p>Band A: Dynamic response metering information. This structure contains data on the average attenuation or amplification applied per channel in the last mix block.</p>
<ul>
<li>Type: data (<a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_dynamic_response">FMOD_DSP_PARAMETER_DYNAMIC_RESPONSE</a>)</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_dynamics_b_mode">FMOD_DSP_MULTIBAND_DYNAMICS_B_MODE</dt>
<dd>Band B: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_b_gain">FMOD_DSP_MULTIBAND_DYNAMICS_B_GAIN</dt>
<dd>Band B: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_b_threshold">FMOD_DSP_MULTIBAND_DYNAMICS_B_THRESHOLD</dt>
<dd>Band B: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_b_ratio">FMOD_DSP_MULTIBAND_DYNAMICS_B_RATIO</dt>
<dd>Band B: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_b_attack">FMOD_DSP_MULTIBAND_DYNAMICS_B_ATTACK</dt>
<dd>Band B: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_b_release">FMOD_DSP_MULTIBAND_DYNAMICS_B_RELEASE</dt>
<dd>Band B: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_b_gain_makeup">FMOD_DSP_MULTIBAND_DYNAMICS_B_GAIN_MAKEUP</dt>
<dd>Band B: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_b_response_data">FMOD_DSP_MULTIBAND_DYNAMICS_B_RESPONSE_DATA</dt>
<dd>Band B: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_c_mode">FMOD_DSP_MULTIBAND_DYNAMICS_C_MODE</dt>
<dd>Band C: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_c_gain">FMOD_DSP_MULTIBAND_DYNAMICS_C_GAIN</dt>
<dd>Band C: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_c_threshold">FMOD_DSP_MULTIBAND_DYNAMICS_C_THRESHOLD</dt>
<dd>Band C: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_c_ratio">FMOD_DSP_MULTIBAND_DYNAMICS_C_RATIO</dt>
<dd>Band C: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_c_attack">FMOD_DSP_MULTIBAND_DYNAMICS_C_ATTACK</dt>
<dd>Band C: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_c_release">FMOD_DSP_MULTIBAND_DYNAMICS_C_RELEASE</dt>
<dd>Band C: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_c_gain_makeup">FMOD_DSP_MULTIBAND_DYNAMICS_C_GAIN_MAKEUP</dt>
<dd>Band C: See Band A.</dd>
<dt id="fmod_dsp_multiband_dynamics_c_response_data">FMOD_DSP_MULTIBAND_DYNAMICS_C_RESPONSE_DATA</dt>
<dd>Band C: See Band A.</dd>
</dl>
<h2 api="enum" id="fmod_dsp_multiband_dynamics_mode_type"><a href="#fmod_dsp_multiband_dynamics_mode_type">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_TYPE</a></h2>
<p>Multiband Dynamics dynamic response types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_TYPE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_DISABLED</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_COMPRESS_UP</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_COMPRESS_DOWN</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_EXPAND_UP</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_EXPAND_DOWN</span>
<span class="p">};</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_MULTIBAND_DYNAMICS_MODE_TYPE</span>
<span class="p">{</span>
<span class="n">DISABLED</span><span class="p">,</span>
<span class="n">COMPRESS_UP</span><span class="p">,</span>
<span class="n">COMPRESS_DOWN</span><span class="p">,</span>
<span class="n">EXPAND_UP</span><span class="p">,</span>
<span class="n">EXPAND_DOWN</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_MODE_DISABLED</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_MODE_COMPRESS_UP</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_MODE_COMPRESS_DOWN</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_MODE_EXPAND_UP</span><span class="p">,</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_DYNAMICS_MODE_EXPAND_DOWN</span>
</pre></div>
<dl>
<dt id="fmod_dsp_multiband_dynamics_mode_disabled">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_DISABLED</dt>
<dd>Response disabled, no processing.</dd>
<dt id="fmod_dsp_multiband_dynamics_mode_compress_up">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_COMPRESS_UP</dt>
<dd>Dynamic upward compression. Amplifies the signal below a defined threshold.</dd>
<dt id="fmod_dsp_multiband_dynamics_mode_compress_down">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_COMPRESS_DOWN</dt>
<dd>Dynamic downward compression. Attenuates the signal above a defined threshold.</dd>
<dt id="fmod_dsp_multiband_dynamics_mode_expand_up">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_EXPAND_UP</dt>
<dd>Dynamic upward expansion. Amplifies the signal above a defined threshold.</dd>
<dt id="fmod_dsp_multiband_dynamics_mode_expand_down">FMOD_DSP_MULTIBAND_DYNAMICS_MODE_EXPAND_DOWN</dt>
<dd>Dynamic downward expansion. Attenuates the signal below a defined threshold.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_dynamics">FMOD_DSP_MULTIBAND_DYNAMICS</a></p>
<h2 api="enum" id="fmod_dsp_multiband_eq"><a href="#fmod_dsp_multiband_eq">FMOD_DSP_MULTIBAND_EQ</a></h2>
<p><a href="effects-reference.html#multiband-equalizer">Multiband equalizer DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_MULTIBAND_EQ</span> <span class="p">{</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_A_FILTER</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_A_FREQUENCY</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_A_Q</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_A_GAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_B_FILTER</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_B_FREQUENCY</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_B_Q</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_B_GAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_C_FILTER</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_C_FREQUENCY</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_C_Q</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_C_GAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_D_FILTER</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_D_FREQUENCY</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_D_Q</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_D_GAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_E_FILTER</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_E_FREQUENCY</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_E_Q</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_E_GAIN</span>
<span class="p">}</span> <span class="n">FMOD_DSP_MULTIBAND_EQ</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_MULTIBAND_EQ</span>
<span class="p">{</span>
<span class="n">A_FILTER</span><span class="p">,</span>
<span class="n">A_FREQUENCY</span><span class="p">,</span>
<span class="n">A_Q</span><span class="p">,</span>
<span class="n">A_GAIN</span><span class="p">,</span>
<span class="n">B_FILTER</span><span class="p">,</span>
<span class="n">B_FREQUENCY</span><span class="p">,</span>
<span class="n">B_Q</span><span class="p">,</span>
<span class="n">B_GAIN</span><span class="p">,</span>
<span class="n">C_FILTER</span><span class="p">,</span>
<span class="n">C_FREQUENCY</span><span class="p">,</span>
<span class="n">C_Q</span><span class="p">,</span>
<span class="n">C_GAIN</span><span class="p">,</span>
<span class="n">D_FILTER</span><span class="p">,</span>
<span class="n">D_FREQUENCY</span><span class="p">,</span>
<span class="n">D_Q</span><span class="p">,</span>
<span class="n">D_GAIN</span><span class="p">,</span>
<span class="n">E_FILTER</span><span class="p">,</span>
<span class="n">E_FREQUENCY</span><span class="p">,</span>
<span class="n">E_Q</span><span class="p">,</span>
<span class="n">E_GAIN</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_A_FILTER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_A_FREQUENCY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_A_Q</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_A_GAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_B_FILTER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_B_FREQUENCY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_B_Q</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_B_GAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_C_FILTER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_C_FREQUENCY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_C_Q</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_C_GAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_D_FILTER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_D_FREQUENCY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_D_Q</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_D_GAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_E_FILTER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_E_FREQUENCY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_E_Q</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_E_GAIN</span>
</pre></div>
<dl>
<dt id="fmod_dsp_multiband_eq_a_filter">FMOD_DSP_MULTIBAND_EQ_A_FILTER</dt>
<dd>
<p>Band A: used to interpret the behavior of the remaining parameters.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq_filter_type">FMOD_DSP_MULTIBAND_EQ_FILTER_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq_filter_lowpass_12db">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_12DB</a></li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_eq_a_frequency">FMOD_DSP_MULTIBAND_EQ_A_FREQUENCY</dt>
<dd>
<p>Band A: Significant frequency, cutoff [low/high pass, low/high shelf], center [notch, peaking, band-pass], phase transition point [all-pass].</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [20, 22000]</li>
<li><span class="label">Default:</span> 8000</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_eq_a_q">FMOD_DSP_MULTIBAND_EQ_A_Q</dt>
<dd>
<p>Band A: Quality factor, resonance [low/high pass], bandwidth [notch, peaking, band-pass], phase transition sharpness [all-pass], unused [low/high shelf].</p>
<ul>
<li>Type: float</li>
<li><span class="label">Range:</span> [0.1, 10]</li>
<li><span class="label">Default:</span> 0.707</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_eq_a_gain">FMOD_DSP_MULTIBAND_EQ_A_GAIN</dt>
<dd>
<p>Band A: Boost or attenuation in dB [peaking, high/low shelf only]. -30 to 30. Default = 0. </p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-30, 30]</li>
<li><span class="label">Default:</span> 8000</li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_eq_b_filter">FMOD_DSP_MULTIBAND_EQ_B_FILTER</dt>
<dd>
<p>Band B: See Band A.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq_filter_type">FMOD_DSP_MULTIBAND_EQ_FILTER_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq_filter_disabled">FMOD_DSP_MULTIBAND_EQ_FILTER_DISABLED</a></li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_eq_b_frequency">FMOD_DSP_MULTIBAND_EQ_B_FREQUENCY</dt>
<dd>Band B: See Band A </dd>
<dt id="fmod_dsp_multiband_eq_b_q">FMOD_DSP_MULTIBAND_EQ_B_Q</dt>
<dd>Band B: See Band A </dd>
<dt id="fmod_dsp_multiband_eq_b_gain">FMOD_DSP_MULTIBAND_EQ_B_GAIN</dt>
<dd>Band B: See Band A </dd>
<dt id="fmod_dsp_multiband_eq_c_filter">FMOD_DSP_MULTIBAND_EQ_C_FILTER</dt>
<dd>
<p>Band C: See Band A.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq_filter_type">FMOD_DSP_MULTIBAND_EQ_FILTER_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq_filter_disabled">FMOD_DSP_MULTIBAND_EQ_FILTER_DISABLED</a></li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_eq_c_frequency">FMOD_DSP_MULTIBAND_EQ_C_FREQUENCY</dt>
<dd>Band C: See Band A. </dd>
<dt id="fmod_dsp_multiband_eq_c_q">FMOD_DSP_MULTIBAND_EQ_C_Q</dt>
<dd>Band C: See Band A. </dd>
<dt id="fmod_dsp_multiband_eq_c_gain">FMOD_DSP_MULTIBAND_EQ_C_GAIN</dt>
<dd>Band C: See Band A. </dd>
<dt id="fmod_dsp_multiband_eq_d_filter">FMOD_DSP_MULTIBAND_EQ_D_FILTER</dt>
<dd>
<p>Band D: See Band A.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq_filter_type">FMOD_DSP_MULTIBAND_EQ_FILTER_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq_filter_disabled">FMOD_DSP_MULTIBAND_EQ_FILTER_DISABLED</a></li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_eq_d_frequency">FMOD_DSP_MULTIBAND_EQ_D_FREQUENCY</dt>
<dd>Band D: See Band A. </dd>
<dt id="fmod_dsp_multiband_eq_d_q">FMOD_DSP_MULTIBAND_EQ_D_Q</dt>
<dd>Band D: See Band A. </dd>
<dt id="fmod_dsp_multiband_eq_d_gain">FMOD_DSP_MULTIBAND_EQ_D_GAIN</dt>
<dd>Band D: See Band A. </dd>
<dt id="fmod_dsp_multiband_eq_e_filter">FMOD_DSP_MULTIBAND_EQ_E_FILTER</dt>
<dd>
<p>Band E: See Band A.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq_filter_type">FMOD_DSP_MULTIBAND_EQ_FILTER_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq_filter_disabled">FMOD_DSP_MULTIBAND_EQ_FILTER_DISABLED</a></li>
</ul>
</dd>
<dt id="fmod_dsp_multiband_eq_e_frequency">FMOD_DSP_MULTIBAND_EQ_E_FREQUENCY</dt>
<dd>Band E: See Band A. </dd>
<dt id="fmod_dsp_multiband_eq_e_q">FMOD_DSP_MULTIBAND_EQ_E_Q</dt>
<dd>Band E: See Band A. </dd>
<dt id="fmod_dsp_multiband_eq_e_gain">FMOD_DSP_MULTIBAND_EQ_E_GAIN</dt>
<dd>Band E: See Band A. </dd>
</dl>
<p>Flexible five band parametric equalizer.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_multiband_eq">FMOD_DSP_TYPE_MULTIBAND_EQ</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_multiband_eq_filter_type"><a href="#fmod_dsp_multiband_eq_filter_type">FMOD_DSP_MULTIBAND_EQ_FILTER_TYPE</a></h2>
<p><a href="effects-reference.html#multiband-equalizer">Multiband equalizer</a> filter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_TYPE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_DISABLED</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_12DB</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_24DB</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_48DB</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_12DB</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_24DB</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_48DB</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWSHELF</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHSHELF</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_PEAKING</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_BANDPASS</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_NOTCH</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_ALLPASS</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_6DB</span><span class="p">,</span>
<span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_6DB</span>
<span class="p">}</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_MULTIBAND_EQ_FILTER_TYPE</span>
<span class="p">{</span>
<span class="n">DISABLED</span><span class="p">,</span>
<span class="n">LOWPASS_12DB</span><span class="p">,</span>
<span class="n">LOWPASS_24DB</span><span class="p">,</span>
<span class="n">LOWPASS_48DB</span><span class="p">,</span>
<span class="n">HIGHPASS_12DB</span><span class="p">,</span>
<span class="n">HIGHPASS_24DB</span><span class="p">,</span>
<span class="n">HIGHPASS_48DB</span><span class="p">,</span>
<span class="n">LOWSHELF</span><span class="p">,</span>
<span class="n">HIGHSHELF</span><span class="p">,</span>
<span class="n">PEAKING</span><span class="p">,</span>
<span class="n">BANDPASS</span><span class="p">,</span>
<span class="n">NOTCH</span><span class="p">,</span>
<span class="n">ALLPASS</span><span class="p">,</span>
<span class="n">LOWPASS_6DB</span><span class="p">,</span>
<span class="n">HIGHPASS_6DB</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_DISABLED</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_LOWPASS_12DB</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_LOWPASS_24DB</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_LOWPASS_48DB</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_HIGHPASS_12DB</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_HIGHPASS_24DB</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_HIGHPASS_48DB</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_LOWSHELF</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_HIGHSHELF</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_PEAKING</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_BANDPASS</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_NOTCH</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_ALLPASS</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_LOWPASS_6DB</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_MULTIBAND_EQ_FILTER_HIGHPASS_6DB</span>
</pre></div>
<dl>
<dt id="fmod_dsp_multiband_eq_filter_disabled">FMOD_DSP_MULTIBAND_EQ_FILTER_DISABLED</dt>
<dd>Disabled filter, no processing.</dd>
<dt id="fmod_dsp_multiband_eq_filter_lowpass_12db">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_12DB</dt>
<dd>Resonant low-pass filter, attenuates frequencies (12dB per octave) above a given point (with specificed resonance) while allowing the rest to pass.</dd>
<dt id="fmod_dsp_multiband_eq_filter_lowpass_24db">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_24DB</dt>
<dd>Resonant low-pass filter, attenuates frequencies (24dB per octave) above a given point (with specificed resonance) while allowing the rest to pass.</dd>
<dt id="fmod_dsp_multiband_eq_filter_lowpass_48db">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_48DB</dt>
<dd>Resonant low-pass filter, attenuates frequencies (48dB per octave) above a given point (with specificed resonance) while allowing the rest to pass.</dd>
<dt id="fmod_dsp_multiband_eq_filter_highpass_12db">FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_12DB</dt>
<dd>Resonant high-pass filter, attenuates frequencies (12dB per octave) below a given point (with specificed resonance) while allowing the rest to pass.</dd>
<dt id="fmod_dsp_multiband_eq_filter_highpass_24db">FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_24DB</dt>
<dd>Resonant high-pass filter, attenuates frequencies (24dB per octave) below a given point (with specificed resonance) while allowing the rest to pass.</dd>
<dt id="fmod_dsp_multiband_eq_filter_highpass_48db">FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_48DB</dt>
<dd>Resonant high-pass filter, attenuates frequencies (48dB per octave) below a given point (with specificed resonance) while allowing the rest to pass.</dd>
<dt id="fmod_dsp_multiband_eq_filter_lowshelf">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWSHELF</dt>
<dd>Low-shelf filter, boosts or attenuates frequencies (with specified gain) below a given point while allowing the rest to pass.</dd>
<dt id="fmod_dsp_multiband_eq_filter_highshelf">FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHSHELF</dt>
<dd>High-shelf filter, boosts or attenuates frequencies (with specified gain) above a given point while allowing the rest to pass.</dd>
<dt id="fmod_dsp_multiband_eq_filter_peaking">FMOD_DSP_MULTIBAND_EQ_FILTER_PEAKING</dt>
<dd>Peaking filter, boosts or attenuates frequencies (with specified gain) at a given point (with specificed bandwidth) while allowing the rest to pass.</dd>
<dt id="fmod_dsp_multiband_eq_filter_bandpass">FMOD_DSP_MULTIBAND_EQ_FILTER_BANDPASS</dt>
<dd>Band-pass filter, allows frequencies at a given point (with specificed bandwidth) to pass while attenuating frequencies outside this range.</dd>
<dt id="fmod_dsp_multiband_eq_filter_notch">FMOD_DSP_MULTIBAND_EQ_FILTER_NOTCH</dt>
<dd>Notch or band-reject filter, attenuates frequencies at a given point (with specificed bandwidth) while allowing frequencies outside this range to pass.</dd>
<dt id="fmod_dsp_multiband_eq_filter_allpass">FMOD_DSP_MULTIBAND_EQ_FILTER_ALLPASS</dt>
<dd>All-pass filter, allows all frequencies to pass, but changes the phase response at a given point (with specified sharpness).</dd>
<dt id="fmod_dsp_multiband_eq_filter_lowpass_6db">FMOD_DSP_MULTIBAND_EQ_FILTER_LOWPASS_6DB</dt>
<dd>Non-resonant low-pass filter, attenuates frequencies (6dB per octave) above a given point while allowing the rest to pass.</dd>
<dt id="fmod_dsp_multiband_eq_filter_highpass_6db">FMOD_DSP_MULTIBAND_EQ_FILTER_HIGHPASS_6DB</dt>
<dd>Non-resonant high-pass filter, attenuates frequencies (6dB per octave) below a given point while allowing the rest to pass.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq">FMOD_DSP_MULTIBAND_EQ</a></p>
<h2 api="enum" id="fmod_dsp_normalize"><a href="#fmod_dsp_normalize">FMOD_DSP_NORMALIZE</a></h2>
<p><a href="effects-reference.html#normalize">Normalize DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_NORMALIZE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_NORMALIZE_FADETIME</span><span class="p">,</span>
<span class="n">FMOD_DSP_NORMALIZE_THRESHOLD</span><span class="p">,</span>
<span class="n">FMOD_DSP_NORMALIZE_MAXAMP</span>
<span class="p">}</span> <span class="n">FMOD_DSP_NORMALIZE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_NORMALIZE</span>
<span class="p">{</span>
<span class="n">FADETIME</span><span class="p">,</span>
<span class="n">THRESHOLD</span><span class="p">,</span>
<span class="n">MAXAMP</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_NORMALIZE_FADETIME</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_NORMALIZE_THRESHOLD</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_NORMALIZE_MAXAMP</span>
</pre></div>
<dl>
<dt id="fmod_dsp_normalize_fadetime">FMOD_DSP_NORMALIZE_FADETIME</dt>
<dd>
<p>Time to ramp the silence to full.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 20000]</li>
<li><span class="label">Default:</span> 5000</li>
</ul>
</dd>
<dt id="fmod_dsp_normalize_threshold">FMOD_DSP_NORMALIZE_THRESHOLD</dt>
<dd>
<p>Lower volume range threshold to ignore.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0, 1]</li>
<li><span class="label">Default:</span> 0.1</li>
</ul>
</dd>
<dt id="fmod_dsp_normalize_maxamp">FMOD_DSP_NORMALIZE_MAXAMP</dt>
<dd>
<p>Maximum amplification allowed.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [1, 100000]</li>
<li><span class="label">Default:</span> 20</li>
</ul>
</dd>
</dl>
<p>Normalize amplifies the sound based on the maximum peaks within the <a href="glossary.html#signal">signal</a>. For example if the maximum peaks in the signal were 50% of the bandwidth, it would scale the whole sound by 2.</p>
<p>The lower threshold value makes the normalizer ignore peaks below a certain point, to avoid over-amplification if a loud signal suddenly came in, and also to avoid amplifying to maximum things like background hiss.</p>
<p>Because FMOD is a realtime audio processor, it doesn't have the luxury of knowing the peak for the whole sound (ie it can't see into the future), so it has to process data as it comes in.</p>
<p>To avoid very sudden changes in volume level based on small samples of new data, FMOD fades towards the desired amplification which makes for smooth gain control. The fadetime parameter can control this.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_normalize">FMOD_DSP_TYPE_NORMALIZE</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_objectpan"><a href="#fmod_dsp_objectpan">FMOD_DSP_OBJECTPAN</a></h2>
<p><a href="effects-reference.html#object-panner">Object based spatializer</a> parameters.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_OBJECTPAN</span> <span class="p">{</span>
<span class="n">FMOD_DSP_OBJECTPAN_3D_POSITION</span><span class="p">,</span>
<span class="n">FMOD_DSP_OBJECTPAN_3D_ROLLOFF</span><span class="p">,</span>
<span class="n">FMOD_DSP_OBJECTPAN_3D_MIN_DISTANCE</span><span class="p">,</span>
<span class="n">FMOD_DSP_OBJECTPAN_3D_MAX_DISTANCE</span><span class="p">,</span>
<span class="n">FMOD_DSP_OBJECTPAN_3D_EXTENT_MODE</span><span class="p">,</span>
<span class="n">FMOD_DSP_OBJECTPAN_3D_SOUND_SIZE</span><span class="p">,</span>
<span class="n">FMOD_DSP_OBJECTPAN_3D_MIN_EXTENT</span><span class="p">,</span>
<span class="n">FMOD_DSP_OBJECTPAN_OVERALL_GAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_OBJECTPAN_OUTPUTGAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_OBJECTPAN_ATTENUATION_RANGE</span><span class="p">,</span>
<span class="n">FMOD_DSP_OBJECTPAN_OVERRIDE_RANGE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_OBJECTPAN</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_OBJECTPAN</span>
<span class="p">{</span>
<span class="n">_3D_POSITION</span><span class="p">,</span>
<span class="n">_3D_ROLLOFF</span><span class="p">,</span>
<span class="n">_3D_MIN_DISTANCE</span><span class="p">,</span>
<span class="n">_3D_MAX_DISTANCE</span><span class="p">,</span>
<span class="n">_3D_EXTENT_MODE</span><span class="p">,</span>
<span class="n">_3D_SOUND_SIZE</span><span class="p">,</span>
<span class="n">_3D_MIN_EXTENT</span><span class="p">,</span>
<span class="n">OVERALL_GAIN</span><span class="p">,</span>
<span class="n">OUTPUTGAIN</span><span class="p">,</span>
<span class="n">ATTENUATION_RANGE</span><span class="p">,</span>
<span class="n">OVERRIDE_RANGE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OBJECTPAN_3D_POSITION</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OBJECTPAN_3D_ROLLOFF</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OBJECTPAN_3D_MIN_DISTANCE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OBJECTPAN_3D_MAX_DISTANCE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OBJECTPAN_3D_EXTENT_MODE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OBJECTPAN_3D_SOUND_SIZE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OBJECTPAN_3D_MIN_EXTENT</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OBJECTPAN_OVERALL_GAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OBJECTPAN_OUTPUTGAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OBJECTPAN_ATTENUATION_RANGE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OBJECTPAN_OVERRIDE_RANGE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_objectpan_3d_position">FMOD_DSP_OBJECTPAN_3D_POSITION</dt>
<dd>
<p>3D Position.</p>
<ul>
<li>Type: data (<a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_3dattributes_multi">FMOD_DSP_PARAMETER_3DATTRIBUTES_MULTI</a>)</li>
</ul>
</dd>
<dt id="fmod_dsp_objectpan_3d_rolloff">FMOD_DSP_OBJECTPAN_3D_ROLLOFF</dt>
<dd>
<p>3D Roll-off Type.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_rolloff_type">FMOD_DSP_PAN_3D_ROLLOFF_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_rolloff_linearsquared">FMOD_DSP_PAN_3D_ROLLOFF_LINEARSQUARED</a></li>
</ul>
</dd>
<dt id="fmod_dsp_objectpan_3d_min_distance">FMOD_DSP_OBJECTPAN_3D_MIN_DISTANCE</dt>
<dd>
<p>3D Min Distance when <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_objectpan_override_range">FMOD_DSP_OBJECTPAN_OVERRIDE_RANGE</a> is true.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> <a href="glossary.html#distance-units">Distance units</a></li>
<li><span class="label">Range:</span> [0, inf)</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
<dt id="fmod_dsp_objectpan_3d_max_distance">FMOD_DSP_OBJECTPAN_3D_MAX_DISTANCE</dt>
<dd>
<p>3D Max Distance when <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_objectpan_override_range">FMOD_DSP_OBJECTPAN_OVERRIDE_RANGE</a> is true.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> <a href="glossary.html#distance-units">Distance units</a></li>
<li><span class="label">Range:</span> [0, inf)</li>
<li><span class="label">Default:</span> 20</li>
</ul>
</dd>
<dt id="fmod_dsp_objectpan_3d_extent_mode">FMOD_DSP_OBJECTPAN_3D_EXTENT_MODE</dt>
<dd>
<p>3D Extent Mode.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_extent_mode_type">FMOD_DSP_PAN_3D_EXTENT_MODE_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_extent_mode_auto">FMOD_DSP_PAN_3D_EXTENT_MODE_AUTO</a></li>
</ul>
</dd>
<dt id="fmod_dsp_objectpan_3d_sound_size">FMOD_DSP_OBJECTPAN_3D_SOUND_SIZE</dt>
<dd>
<p>3D Sound Size.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> <a href="glossary.html#distance-units">Distance units</a></li>
<li><span class="label">Range:</span> [0, inf)</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_objectpan_3d_min_extent">FMOD_DSP_OBJECTPAN_3D_MIN_EXTENT</dt>
<dd>
<p>3D Min Extent.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Degrees</li>
<li><span class="label">Range:</span> [0, 360]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_objectpan_overall_gain">FMOD_DSP_OBJECTPAN_OVERALL_GAIN <span><a class="token" href="glossary.html#documentation-conventions" title="Read-only">R/O</a></span></dt>
<dd>
<p>Overall gain to allow FMOD to know the <a href="glossary.html#dsp">DSP</a> is scaling the <a href="glossary.html#signal">signal</a> for virtualization purposes. </p>
<ul>
<li>Type: data (<a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_overallgain">FMOD_DSP_PARAMETER_OVERALLGAIN</a>)</li>
</ul>
</dd>
<dt id="fmod_dsp_objectpan_outputgain">FMOD_DSP_OBJECTPAN_OUTPUTGAIN</dt>
<dd>
<p>Output gain level.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0, 1]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_objectpan_attenuation_range">FMOD_DSP_OBJECTPAN_ATTENUATION_RANGE</dt>
<dd>
<p>Attenuation Range when <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_objectpan_override_range">FMOD_DSP_OBJECTPAN_OVERRIDE_RANGE</a> is false.</p>
<ul>
<li>Type: data (<a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_attenuation_range">FMOD_DSP_PARAMETER_ATTENUATION_RANGE</a>)</li>
</ul>
</dd>
<dt id="fmod_dsp_objectpan_override_range">FMOD_DSP_OBJECTPAN_OVERRIDE_RANGE</dt>
<dd>
<p>Override Attenuation Range with <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_objectpan_3d_min_distance">FMOD_DSP_OBJECTPAN_3D_MIN_DISTANCE</a> and <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_objectpan_3d_max_distance">FMOD_DSP_OBJECTPAN_3D_MAX_DISTANCE</a>.</p>
<ul>
<li>Type: bool</li>
<li><span class="label">Default:</span> true</li>
</ul>
</dd>
</dl>
<p>Signal processed by this DSP will be sent to the global object mixer (effectively a send), any DSP connected after this will receive silence.</p>
<p>For best results this DSP should be used with <a class="apilink" href="core-api-system.html#fmod_outputtype_winsonic">FMOD_OUTPUTTYPE_WINSONIC</a> or <a class="apilink" href="core-api-system.html#fmod_outputtype_audio3d">FMOD_OUTPUTTYPE_AUDIO3D</a> to get height spatialization. Playback with any other output will result in fallback spatialization provided by <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_pan">FMOD_DSP_TYPE_PAN</a>.</p>
<p><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_objectpan_override_range">FMOD_DSP_OBJECTPAN_OVERRIDE_RANGE</a> defaults to true for backwards compatability.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_objectpan">FMOD_DSP_TYPE_OBJECTPAN</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterdata">DSP::setParameterData</a>, <a href="core-guide.html#controlling-a-spatializer-dsp">Controlling a Spatializer DSP</a></p>
<h2 api="enum" id="fmod_dsp_oscillator"><a href="#fmod_dsp_oscillator">FMOD_DSP_OSCILLATOR</a></h2>
<p><a href="effects-reference.html#oscillator">Oscillator DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_OSCILLATOR</span> <span class="p">{</span>
<span class="n">FMOD_DSP_OSCILLATOR_TYPE</span><span class="p">,</span>
<span class="n">FMOD_DSP_OSCILLATOR_RATE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_OSCILLATOR</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_OSCILLATOR</span>
<span class="p">{</span>
<span class="n">TYPE</span><span class="p">,</span>
<span class="n">RATE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OSCILLATOR_TYPE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_OSCILLATOR_RATE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_oscillator_type">FMOD_DSP_OSCILLATOR_TYPE</dt>
<dd>
<p>Waveform type. 0 = sine. 1 = square. 2 = sawup. 3 = sawdown. 4 = triangle. 5 = noise.</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_oscillator_rate">FMOD_DSP_OSCILLATOR_RATE</dt>
<dd>
<p>Frequency of the tone. Does not affect the noise generator.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [0, 22000]</li>
<li><span class="label">Default:</span> 220</li>
</ul>
</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_oscillator">FMOD_DSP_TYPE_OSCILLATOR</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a></p>
<h2 api="enum" id="fmod_dsp_pan"><a href="#fmod_dsp_pan">FMOD_DSP_PAN</a></h2>
<p><a href="effects-reference.html#pan">Pan DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_PAN</span> <span class="p">{</span>
<span class="n">FMOD_DSP_PAN_MODE</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_2D_STEREO_POSITION</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_2D_DIRECTION</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_2D_EXTENT</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_2D_ROTATION</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_2D_LFE_LEVEL</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_2D_STEREO_MODE</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_2D_STEREO_SEPARATION</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_2D_STEREO_AXIS</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_ENABLED_SPEAKERS</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_POSITION</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_ROLLOFF</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_MIN_DISTANCE</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_MAX_DISTANCE</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_EXTENT_MODE</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_SOUND_SIZE</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_MIN_EXTENT</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_PAN_BLEND</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_LFE_UPMIX_ENABLED</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_OVERALL_GAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_SURROUND_SPEAKER_MODE</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_2D_HEIGHT_BLEND</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_ATTENUATION_RANGE</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_OVERRIDE_RANGE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_PAN</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_PAN</span>
<span class="p">{</span>
<span class="n">MODE</span><span class="p">,</span>
<span class="n">_2D_STEREO_POSITION</span><span class="p">,</span>
<span class="n">_2D_DIRECTION</span><span class="p">,</span>
<span class="n">_2D_EXTENT</span><span class="p">,</span>
<span class="n">_2D_ROTATION</span><span class="p">,</span>
<span class="n">_2D_LFE_LEVEL</span><span class="p">,</span>
<span class="n">_2D_STEREO_MODE</span><span class="p">,</span>
<span class="n">_2D_STEREO_SEPARATION</span><span class="p">,</span>
<span class="n">_2D_STEREO_AXIS</span><span class="p">,</span>
<span class="n">ENABLED_SPEAKERS</span><span class="p">,</span>
<span class="n">_3D_POSITION</span><span class="p">,</span>
<span class="n">_3D_ROLLOFF</span><span class="p">,</span>
<span class="n">_3D_MIN_DISTANCE</span><span class="p">,</span>
<span class="n">_3D_MAX_DISTANCE</span><span class="p">,</span>
<span class="n">_3D_EXTENT_MODE</span><span class="p">,</span>
<span class="n">_3D_SOUND_SIZE</span><span class="p">,</span>
<span class="n">_3D_MIN_EXTENT</span><span class="p">,</span>
<span class="n">_3D_PAN_BLEND</span><span class="p">,</span>
<span class="n">LFE_UPMIX_ENABLED</span><span class="p">,</span>
<span class="n">OVERALL_GAIN</span><span class="p">,</span>
<span class="n">SURROUND_SPEAKER_MODE</span><span class="p">,</span>
<span class="n">_2D_HEIGHT_BLEND</span><span class="p">,</span>
<span class="n">ATTENUATION_RANGE</span><span class="p">,</span>
<span class="n">OVERRIDE_RANGE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_MODE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_2D_STEREO_POSITION</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_2D_DIRECTION</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_2D_EXTENT</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_2D_ROTATION</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_2D_LFE_LEVEL</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_2D_STEREO_MODE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_2D_STEREO_SEPARATION</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_2D_STEREO_AXIS</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_ENABLED_SPEAKERS</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_POSITION</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_ROLLOFF</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_MIN_DISTANCE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_MAX_DISTANCE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_EXTENT_MODE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_SOUND_SIZE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_MIN_EXTENT</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_PAN_BLEND</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_LFE_UPMIX_ENABLED</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_OVERALL_GAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_SURROUND_SPEAKER_MODE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_2D_HEIGHT_BLEND</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_ATTENUATION_RANGE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_OVERRIDE_RANGE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_pan_mode">FMOD_DSP_PAN_MODE</dt>
<dd>
<p>Panner mode.</p>
<ul>
<li>Type: int <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_mode_type">FMOD_DSP_PAN_MODE_TYPE</a></li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_mode_surround">FMOD_DSP_PAN_MODE_SURROUND</a></li>
</ul>
</dd>
<dt id="fmod_dsp_pan_2d_stereo_position">FMOD_DSP_PAN_2D_STEREO_POSITION</dt>
<dd>
<p>2D Stereo pan position.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [-100, 100]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_2d_direction">FMOD_DSP_PAN_2D_DIRECTION</dt>
<dd>
<p>2D Surround pan direction. Direction from center point of panning circle where 0 is front center and -180 or +180 is rear speakers center point.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Degrees</li>
<li><span class="label">Range:</span> [-180, 180]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_2d_extent">FMOD_DSP_PAN_2D_EXTENT</dt>
<dd>
<p>2D Surround pan extent.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Degrees</li>
<li><span class="label">Range:</span> [0, 360]</li>
<li><span class="label">Default:</span> 360</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_2d_rotation">FMOD_DSP_PAN_2D_ROTATION</dt>
<dd>
<p>2D Surround pan rotation.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Degrees</li>
<li><span class="label">Range:</span> [-180, 180]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_2d_lfe_level">FMOD_DSP_PAN_2D_LFE_LEVEL</dt>
<dd>
<p>2D Surround pan LFE level.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 20]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_2d_stereo_mode">FMOD_DSP_PAN_2D_STEREO_MODE</dt>
<dd>
<p>Stereo-To-Surround Mode.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_mode_type">FMOD_DSP_PAN_2D_STEREO_MODE_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_mode_discrete">FMOD_DSP_PAN_2D_STEREO_MODE_DISCRETE</a></li>
</ul>
</dd>
<dt id="fmod_dsp_pan_2d_stereo_separation">FMOD_DSP_PAN_2D_STEREO_SEPARATION</dt>
<dd>
<p>Stereo-To-Surround Stereo For <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_mode_discrete">FMOD_DSP_PAN_2D_STEREO_MODE_DISCRETE</a> mode. Separation/width of L/R parts of stereo sound.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Degrees</li>
<li><span class="label">Range:</span> [-180, 180]</li>
<li><span class="label">Default:</span> 60</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_2d_stereo_axis">FMOD_DSP_PAN_2D_STEREO_AXIS</dt>
<dd>
<p>Stereo-To-Surround Stereo For <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_mode_discrete">FMOD_DSP_PAN_2D_STEREO_MODE_DISCRETE</a> mode. Axis/rotation of L/R parts of stereo sound.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Degrees</li>
<li><span class="label">Range:</span> [-180, 180]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_enabled_speakers">FMOD_DSP_PAN_ENABLED_SPEAKERS</dt>
<dd>
<p>Speakers Enabled Bitmask for each speaker from 0 to 32 to be considered by panner. Use to disable speakers from being panned to. 0 to 0xFFF. Default = 0xFFF (All on).</p>
<ul>
<li>Type: int</li>
<li><span class="label">Range:</span> [0, 0xFFF]</li>
<li><span class="label">Default:</span> 0xFFF</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_3d_position">FMOD_DSP_PAN_3D_POSITION</dt>
<dd>
<p>3D Position of panner and listener(s).</p>
<ul>
<li>Type: data (<a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_3dattributes_multi">FMOD_DSP_PARAMETER_3DATTRIBUTES_MULTI</a>)</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_3d_rolloff">FMOD_DSP_PAN_3D_ROLLOFF</dt>
<dd>
<p>3D volume attenuation curve shape.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_rolloff_type">FMOD_DSP_PAN_3D_ROLLOFF_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_rolloff_linearsquared">FMOD_DSP_PAN_3D_ROLLOFF_LINEARSQUARED</a></li>
</ul>
</dd>
<dt id="fmod_dsp_pan_3d_min_distance">FMOD_DSP_PAN_3D_MIN_DISTANCE</dt>
<dd>
<p>3D volume attenuation minimum distance when <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_objectpan_override_range">FMOD_DSP_OBJECTPAN_OVERRIDE_RANGE</a> is true.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> <a href="glossary.html#distance-units">Distance units</a></li>
<li><span class="label">Range:</span> [0, inf)</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_3d_max_distance">FMOD_DSP_PAN_3D_MAX_DISTANCE</dt>
<dd>
<p>3D volume attenuation maximum distance when <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_objectpan_override_range">FMOD_DSP_OBJECTPAN_OVERRIDE_RANGE</a> is true.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> <a href="glossary.html#distance-units">Distance units</a></li>
<li><span class="label">Range:</span> [0, inf)</li>
<li><span class="label">Default:</span> 20</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_3d_extent_mode">FMOD_DSP_PAN_3D_EXTENT_MODE</dt>
<dd>
<p>3D Extent Mode.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_extent_mode_type">FMOD_DSP_PAN_3D_EXTENT_MODE_TYPE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_extent_mode_auto">FMOD_DSP_PAN_3D_EXTENT_MODE_AUTO</a></li>
</ul>
</dd>
<dt id="fmod_dsp_pan_3d_sound_size">FMOD_DSP_PAN_3D_SOUND_SIZE</dt>
<dd>
<p>3D Sound Size.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> <a href="glossary.html#distance-units">Distance units</a></li>
<li><span class="label">Range:</span> [0, inf)</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_3d_min_extent">FMOD_DSP_PAN_3D_MIN_EXTENT</dt>
<dd>
<p>3D Min Extent.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Degrees</li>
<li><span class="label">Range:</span> [0, 360]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_3d_pan_blend">FMOD_DSP_PAN_3D_PAN_BLEND</dt>
<dd>
<p>3D Pan Blend.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0, 1]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_lfe_upmix_enabled">FMOD_DSP_PAN_LFE_UPMIX_ENABLED</dt>
<dd>
<p>LFE Upmix Enabled. Determines whether non-LFE source channels should mix to the LFE or leave it alone. 0 (off) to 1 (on). Default = 0 (off).</p>
<ul>
<li>Type: int</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0, 1]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_overall_gain">FMOD_DSP_PAN_OVERALL_GAIN</dt>
<dd>
<p>Overall gain to allow FMOD to know the DSP is scaling the <a href="glossary.html#signal">signal</a> for visualization purposes. </p>
<ul>
<li>Type: data (<a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_overallgain">FMOD_DSP_PARAMETER_OVERALLGAIN</a>)</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_surround_speaker_mode">FMOD_DSP_PAN_SURROUND_SPEAKER_MODE</dt>
<dd>
<p>Surround speaker mode. (<a class="apilink" href="core-api-common.html#fmod_speakermode">FMOD_SPEAKERMODE</a>)</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common.html#fmod_speakermode">FMOD_SPEAKERMODE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common.html#fmod_speakermode_default">FMOD_SPEAKERMODE_DEFAULT</a></li>
</ul>
</dd>
<dt id="fmod_dsp_pan_2d_height_blend">FMOD_DSP_PAN_2D_HEIGHT_BLEND</dt>
<dd>
<p>2D Height blend. When the input or <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_surround_speaker_mode">FMOD_DSP_PAN_SURROUND_SPEAKER_MODE</a> has height speakers, control the blend between ground and height. -1.0 (push top speakers to ground), 0.0 (preserve top / ground separation), 1.0 (push ground speakers to top).</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [-1, 1]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_attenuation_range">FMOD_DSP_PAN_ATTENUATION_RANGE</dt>
<dd>
<p>Attenuation Range when <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_objectpan_override_range">FMOD_DSP_OBJECTPAN_OVERRIDE_RANGE</a> is false.</p>
<ul>
<li>Type: data (<a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_attenuation_range">FMOD_DSP_PARAMETER_ATTENUATION_RANGE</a>)</li>
</ul>
</dd>
<dt id="fmod_dsp_pan_override_range">FMOD_DSP_PAN_OVERRIDE_RANGE</dt>
<dd>
<p>Override Attenuation Range with <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_min_distance">FMOD_DSP_PAN_3D_MIN_DISTANCE</a> and <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_max_distance">FMOD_DSP_PAN_3D_MAX_DISTANCE</a>.</p>
<ul>
<li>Type: bool</li>
<li><span class="label">Default:</span> true</li>
</ul>
</dd>
</dl>
<p><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_pan_blend">FMOD_DSP_PAN_3D_PAN_BLEND</a> controls the percentage of the <a href="glossary.html#effect">effect</a> supplied by <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_direction">FMOD_DSP_PAN_2D_DIRECTION</a> and <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_extent">FMOD_DSP_PAN_2D_EXTENT</a>.</p>
<p>For <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_position">FMOD_DSP_PAN_3D_POSITION</a>, the following members in the <a class="apilink" href="plugin-api-dsp.html#fmod_dsp_parameter_3dattributes_multi">FMOD_DSP_PARAMETER_3DATTRIBUTES_MULTI</a> struct should be non zero.<br />
- numlisteners - This is typically 1, can be up to 8. Typically more than 1 is only used for split screen purposes. The FMOD Panner will average angles and produce the best compromise for panning and attenuation.<br />
- relative[listenernum].position - This is the delta between the listener position and the sound position. Typically the listener position is subtracted from the sound position.<br />
- relative[listenernum].forward - This is the sound's forward vector. Optional, set to 0,0,1 if not needed. This is only relevant for more than mono sounds in 3D, that are spread amongst the destination speakers at the time of panning.</p>
<div class="highlight language-c"><pre><span></span> <span class="n">If</span> <span class="n">the</span> <span class="n">sound</span> <span class="n">rotates</span> <span class="n">then</span> <span class="n">the</span> <span class="n">L</span><span class="o">/</span><span class="n">R</span> <span class="n">part</span> <span class="n">of</span> <span class="n">a</span> <span class="n">stereo</span> <span class="n">sound</span> <span class="n">will</span> <span class="n">rotate</span> <span class="n">amongst</span> <span class="n">its</span> <span class="n">destination</span> <span class="n">speakers</span><span class="p">.</span>
<span class="n">If</span> <span class="n">the</span> <span class="n">sound</span> <span class="n">has</span> <span class="n">moved</span> <span class="n">and</span> <span class="n">pinpointed</span> <span class="n">into</span> <span class="n">a</span> <span class="n">single</span> <span class="n">speaker</span><span class="p">,</span> <span class="n">rotation</span> <span class="n">of</span> <span class="n">the</span> <span class="n">sound</span> <span class="n">will</span> <span class="n">have</span> <span class="n">no</span> <span class="n">effect</span> <span class="n">as</span> <span class="n">at</span> <span class="n">that</span> <span class="n">point</span> <span class="n">the</span> <span class="n">channels</span> <span class="n">are</span> <span class="n">collapsed</span> <span class="n">into</span> <span class="n">a</span> <span class="n">single</span> <span class="n">point</span><span class="p">.</span>
</pre></div>
<p>For <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_mode">FMOD_DSP_PAN_2D_STEREO_MODE</a>, when it is set to <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_mode_discrete">FMOD_DSP_PAN_2D_STEREO_MODE_DISCRETE</a>, only <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_separation">FMOD_DSP_PAN_2D_STEREO_SEPARATION</a> and <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_axis">FMOD_DSP_PAN_2D_STEREO_AXIS</a> are used.<br />
When it is set to <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_mode_distributed">FMOD_DSP_PAN_2D_STEREO_MODE_DISTRIBUTED</a>, then standard <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_direction">FMOD_DSP_PAN_2D_DIRECTION</a>/<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_extent">FMOD_DSP_PAN_2D_EXTENT</a> parameters are used.</p>
<p><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_objectpan_override_range">FMOD_DSP_OBJECTPAN_OVERRIDE_RANGE</a> defaults to true for backwards compatability.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_pan">FMOD_DSP_TYPE_PAN</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterdata">DSP::setParameterData</a>, <a href="core-guide.html#controlling-a-spatializer-dsp">Controlling a Spatializer DSP</a></p>
<h2 api="enum" id="fmod_dsp_pan_2d_stereo_mode_type"><a href="#fmod_dsp_pan_2d_stereo_mode_type">FMOD_DSP_PAN_2D_STEREO_MODE_TYPE</a></h2>
<p>2D stereo mode values for <a href="effects-reference.html#pan">pan DSP</a>.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_PAN_2D_STEREO_MODE_TYPE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_PAN_2D_STEREO_MODE_DISTRIBUTED</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_2D_STEREO_MODE_DISCRETE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_PAN_2D_STEREO_MODE_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_PAN_2D_STEREO_MODE_TYPE</span>
<span class="p">{</span>
<span class="n">DISTRIBUTED</span><span class="p">,</span>
<span class="n">DISCRETE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_2D_STEREO_MODE_DISTRIBUTED</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_2D_STEREO_MODE_DISCRETE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_pan_2d_stereo_mode_distributed">FMOD_DSP_PAN_2D_STEREO_MODE_DISTRIBUTED</dt>
<dd>The parts of a stereo sound are spread around destination speakers based on <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_extent">FMOD_DSP_PAN_2D_EXTENT</a> / <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_direction">FMOD_DSP_PAN_2D_DIRECTION</a> </dd>
<dt id="fmod_dsp_pan_2d_stereo_mode_discrete">FMOD_DSP_PAN_2D_STEREO_MODE_DISCRETE</dt>
<dd>The L/R parts of a stereo sound are rotated around a circle based on <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_axis">FMOD_DSP_PAN_2D_STEREO_AXIS</a> / <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_separation">FMOD_DSP_PAN_2D_STEREO_SEPARATION</a>. </dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_2d_stereo_mode">FMOD_DSP_PAN_2D_STEREO_MODE</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_pan">FMOD_DSP_TYPE_PAN</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan">FMOD_DSP_PAN</a></p>
<h2 api="enum" id="fmod_dsp_pan_3d_extent_mode_type"><a href="#fmod_dsp_pan_3d_extent_mode_type">FMOD_DSP_PAN_3D_EXTENT_MODE_TYPE</a></h2>
<p>3D extent mode values for <a href="effects-reference.html#pan">pan DSP</a>.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_PAN_3D_EXTENT_MODE_TYPE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_PAN_3D_EXTENT_MODE_AUTO</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_EXTENT_MODE_USER</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_EXTENT_MODE_OFF</span>
<span class="p">}</span> <span class="n">FMOD_DSP_PAN_3D_EXTENT_MODE_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_PAN_3D_EXTENT_MODE_TYPE</span>
<span class="p">{</span>
<span class="n">AUTO</span><span class="p">,</span>
<span class="n">USER</span><span class="p">,</span>
<span class="n">OFF</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_EXTENT_MODE_AUTO</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_EXTENT_MODE_USER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_EXTENT_MODE_OFF</span>
</pre></div>
<dl>
<dt id="fmod_dsp_pan_3d_extent_mode_auto">FMOD_DSP_PAN_3D_EXTENT_MODE_AUTO</dt>
<dd></dd>
<dt id="fmod_dsp_pan_3d_extent_mode_user">FMOD_DSP_PAN_3D_EXTENT_MODE_USER</dt>
<dd></dd>
<dt id="fmod_dsp_pan_3d_extent_mode_off">FMOD_DSP_PAN_3D_EXTENT_MODE_OFF</dt>
<dd></dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_extent_mode">FMOD_DSP_PAN_3D_EXTENT_MODE</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_pan">FMOD_DSP_TYPE_PAN</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan">FMOD_DSP_PAN</a></p>
<h2 api="enum" id="fmod_dsp_pan_3d_rolloff_type"><a href="#fmod_dsp_pan_3d_rolloff_type">FMOD_DSP_PAN_3D_ROLLOFF_TYPE</a></h2>
<p>3D roll-off values for <a href="effects-reference.html#pan">pan DSP</a>.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_PAN_3D_ROLLOFF_TYPE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_PAN_3D_ROLLOFF_LINEARSQUARED</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_ROLLOFF_LINEAR</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_ROLLOFF_INVERSE</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_ROLLOFF_INVERSETAPERED</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_3D_ROLLOFF_CUSTOM</span>
<span class="p">}</span> <span class="n">FMOD_DSP_PAN_3D_ROLLOFF_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_PAN_3D_ROLLOFF_TYPE</span>
<span class="p">{</span>
<span class="n">LINEARSQUARED</span><span class="p">,</span>
<span class="n">LINEAR</span><span class="p">,</span>
<span class="n">INVERSE</span><span class="p">,</span>
<span class="n">INVERSETAPERED</span><span class="p">,</span>
<span class="n">CUSTOM</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_ROLLOFF_LINEARSQUARED</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_ROLLOFF_LINEAR</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_ROLLOFF_INVERSE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_ROLLOFF_INVERSETAPERED</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_3D_ROLLOFF_CUSTOM</span>
</pre></div>
<dl>
<dt id="fmod_dsp_pan_3d_rolloff_linearsquared">FMOD_DSP_PAN_3D_ROLLOFF_LINEARSQUARED</dt>
<dd>This is a linear-square roll-off model. Below <code>mindistance</code>, the volume is unattenuated; as <code>distance</code> increases from <code>mindistance</code> to <code>maxdistance</code>, the volume attenuates to silence according to a linear squared gradient. For this roll-off mode, <code>distance</code> values greater than <code>mindistance</code> are scaled according to the <a href="core-api-system.html#system_set3dsettings">rolloffscale</a>. This roll-off mode provides steeper volume ramping close to the <code>mindistance</code>, and more gradual ramping close to the <code>maxdistance</code>, than linear roll-off mode.</dd>
<dd><img alt="Linear Square Roll-off Graph" src="images/dsp-pan-3d-rolloff-linsquared.svg" title="Linear square roll-off" /></dd>
<dt id="fmod_dsp_pan_3d_rolloff_linear">FMOD_DSP_PAN_3D_ROLLOFF_LINEAR</dt>
<dd>This is a linear roll-off model. Below <code>mindistance</code>, the volume is unattenuated; as <code>distance</code> increases from <code>mindistance</code> to <code>maxdistance</code>, the volume attenuates to silence using a linear gradient. For this roll-off mode, distance values greater than <code>mindistance</code> are scaled according to the <a href="core-api-system.html#system_set3dsettings">rolloffscale</a>. While this roll-off mode is not as realistic as inverse roll-off mode, it is easier to comprehend.</dd>
<dd><img alt="Linear Roll-off Graph" src="images/dsp-pan-3d-rolloff-linear.svg" title="Linear roll-off" /></dd>
<dt id="fmod_dsp_pan_3d_rolloff_inverse">FMOD_DSP_PAN_3D_ROLLOFF_INVERSE</dt>
<dd>This is an inverse roll-off model. Below <code>mindistance</code>, the volume is unattenuated; as <code>distance</code> increases above <code>mindistance</code>, the volume attenuates using <code>mindistance/distance</code> as the gradient until it reaches <code>maxdistance</code>, where it stops attenuating. For this roll-off mode, distance values greater than <code>mindistance</code> are scaled according to the <a href="core-api-system.html#system_set3dsettings">rolloffscale</a>. This roll-off mode accurately models the way sounds attenuate over distance in the real world. (DEFAULT)</dd>
<dd><img alt="Inverse Roll-off Graph" src="images/dsp-pan-3d-rolloff-inverse.svg" title="Inverse roll-off" /></dd>
<dt id="fmod_dsp_pan_3d_rolloff_inversetapered">FMOD_DSP_PAN_3D_ROLLOFF_INVERSETAPERED</dt>
<dd>This is a combination of the inverse and linear-square roll-off models. At short distances where inverse roll-off would provide greater attenuation, it functions as inverse roll-off mode; then at greater distances where linear-square roll-off mode would provide greater attenuation, it uses that roll-off mode instead. For this roll-off mode, distance values greater than <code>mindistance</code> are scaled according to the <a href="core-api-system.html#system_set3dsettings">rolloffscale</a>. Inverse tapered roll-off mode approximates realistic behavior while still guaranteeing the sound attenuates to silence at <code>maxdistance</code>.</dd>
<dd><img alt="Inverse Tapered Roll-off Graph" src="images/dsp-pan-3d-rolloff-invtaper.svg" title="Inverse tapered roll-off" /></dd>
<dt id="fmod_dsp_pan_3d_rolloff_custom">FMOD_DSP_PAN_3D_ROLLOFF_CUSTOM</dt>
<dd>Custom roll-off can be defined by the programmer setting volume manually. Attenuation in the Pan DSP is turned off in this mode.</dd>
</dl>
<p>Minimum and Maximum distance settings are controlled with <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_min_distance">FMOD_DSP_PAN_3D_MIN_DISTANCE</a> and <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_max_distance">FMOD_DSP_PAN_3D_MAX_DISTANCE</a>.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_3d_rolloff">FMOD_DSP_PAN_3D_ROLLOFF</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_pan">FMOD_DSP_TYPE_PAN</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan">FMOD_DSP_PAN</a></p>
<h2 api="enum" id="fmod_dsp_pan_mode_type"><a href="#fmod_dsp_pan_mode_type">FMOD_DSP_PAN_MODE_TYPE</a></h2>
<p>Pan mode values for the <a href="effects-reference.html#pan">pan DSP</a>.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_PAN_MODE_TYPE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_PAN_MODE_MONO</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_MODE_STEREO</span><span class="p">,</span>
<span class="n">FMOD_DSP_PAN_MODE_SURROUND</span>
<span class="p">}</span> <span class="n">FMOD_DSP_PAN_MODE_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_PAN_MODE_TYPE</span>
<span class="p">{</span>
<span class="n">MONO</span><span class="p">,</span>
<span class="n">STEREO</span><span class="p">,</span>
<span class="n">SURROUND</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_MODE_MONO</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_MODE_STEREO</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PAN_MODE_SURROUND</span>
</pre></div>
<dl>
<dt id="fmod_dsp_pan_mode_mono">FMOD_DSP_PAN_MODE_MONO</dt>
<dd>Single channel output.</dd>
<dt id="fmod_dsp_pan_mode_stereo">FMOD_DSP_PAN_MODE_STEREO</dt>
<dd>Two channel output</dd>
<dt id="fmod_dsp_pan_mode_surround">FMOD_DSP_PAN_MODE_SURROUND</dt>
<dd>Three or more channel output. Includes common modes like quad, 5.1 or 7.1.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan_mode">FMOD_DSP_PAN_MODE</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_pan">FMOD_DSP_TYPE_PAN</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan">FMOD_DSP_PAN</a></p>
<h2 api="enum" id="fmod_dsp_parameq"><a href="#fmod_dsp_parameq">FMOD_DSP_PARAMEQ</a></h2>
<p><a href="effects-reference.html#parametric-eq">Parametric EQ DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_PARAMEQ</span> <span class="p">{</span>
<span class="n">FMOD_DSP_PARAMEQ_CENTER</span><span class="p">,</span>
<span class="n">FMOD_DSP_PARAMEQ_BANDWIDTH</span><span class="p">,</span>
<span class="n">FMOD_DSP_PARAMEQ_GAIN</span>
<span class="p">}</span> <span class="n">FMOD_DSP_PARAMEQ</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_PARAMEQ</span>
<span class="p">{</span>
<span class="n">CENTER</span><span class="p">,</span>
<span class="n">BANDWIDTH</span><span class="p">,</span>
<span class="n">GAIN</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PARAMEQ_CENTER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PARAMEQ_BANDWIDTH</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PARAMEQ_GAIN</span>
</pre></div>
<dl>
<dt id="fmod_dsp_parameq_center">FMOD_DSP_PARAMEQ_CENTER</dt>
<dd>
<p>Frequency center.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [20, 22000]</li>
<li><span class="label">Default:</span> 8000</li>
</ul>
</dd>
<dt id="fmod_dsp_parameq_bandwidth">FMOD_DSP_PARAMEQ_BANDWIDTH</dt>
<dd>
<p>Octave range around the center frequency to filter.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Range:</span> [0.2, 5]</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
<dt id="fmod_dsp_parameq_gain">FMOD_DSP_PARAMEQ_GAIN</dt>
<dd>
<p>Frequency Gain in dB.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-30, 30]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
</dl>
<p>Deprecated and will be removed in a future release, to emulate with <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_multiband_eq">FMOD_DSP_TYPE_MULTIBAND_EQ</a>:</p>
<div class="highlight language-c"><pre><span></span><span class="c1">// Configure a single band (band A) as a peaking EQ (all other bands default to off).</span>
<span class="c1">// Center frequency can be used as with the old effect.</span>
<span class="c1">// Bandwidth can be applied by setting the &#39;Q&#39; value of the new effect.</span>
<span class="c1">// Gain at the center frequency can be used the same as with the old effect.</span>
<span class="n">FMOD_DSP_SetParameterInt</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_FILTER</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_FILTER_PEAKING</span><span class="p">);</span>
<span class="n">FMOD_DSP_SetParameterFloat</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_FREQUENCY</span><span class="p">,</span> <span class="n">center</span><span class="p">);</span>
<span class="n">FMOD_DSP_SetParameterFloat</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_Q</span><span class="p">,</span> <span class="n">bandwidth</span><span class="p">);</span>
<span class="n">FMOD_DSP_SetParameterFloat</span><span class="p">(</span><span class="n">multiband</span><span class="p">,</span> <span class="n">FMOD_DSP_MULTIBAND_EQ_A_GAIN</span><span class="p">,</span> <span class="n">gain</span><span class="p">);</span>
</pre></div>
<p>Parametric EQ is a single band peaking EQ filter that attenuates or amplifies a selected frequency and its neighboring frequencies.</p>
<p>When the gain is set to zero decibels the sound will be unaffected and represents the original <a href="glossary.html#signal">signal</a> exactly.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_parameq">FMOD_DSP_TYPE_PARAMEQ</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-dsp.html#dsp_getparameterfloat">DSP::getParameterFloat</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type">FMOD_DSP_TYPE</a></p>
<h2 api="enum" id="fmod_dsp_pitchshift"><a href="#fmod_dsp_pitchshift">FMOD_DSP_PITCHSHIFT</a></h2>
<p><a href="effects-reference.html#pitch-shifter">Pitch shifter DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_PITCHSHIFT</span> <span class="p">{</span>
<span class="n">FMOD_DSP_PITCHSHIFT_PITCH</span><span class="p">,</span>
<span class="n">FMOD_DSP_PITCHSHIFT_FFTSIZE</span><span class="p">,</span>
<span class="n">FMOD_DSP_PITCHSHIFT_OVERLAP</span><span class="p">,</span>
<span class="n">FMOD_DSP_PITCHSHIFT_MAXCHANNELS</span>
<span class="p">}</span> <span class="n">FMOD_DSP_PITCHSHIFT</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_PITCHSHIFT</span>
<span class="p">{</span>
<span class="n">PITCH</span><span class="p">,</span>
<span class="n">FFTSIZE</span><span class="p">,</span>
<span class="n">OVERLAP</span><span class="p">,</span>
<span class="n">MAXCHANNELS</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PITCHSHIFT_PITCH</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PITCHSHIFT_FFTSIZE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PITCHSHIFT_OVERLAP</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_PITCHSHIFT_MAXCHANNELS</span>
</pre></div>
<dl>
<dt id="fmod_dsp_pitchshift_pitch">FMOD_DSP_PITCHSHIFT_PITCH</dt>
<dd>
<p>Pitch value. 0.5 = one octave down, 2.0 = one octave up. 1.0 does not change the pitch.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Range:</span> [0.5, 2]</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
<dt id="fmod_dsp_pitchshift_fftsize">FMOD_DSP_PITCHSHIFT_FFTSIZE</dt>
<dd>
<p>FFT window size - 256, 512, 1024, 2048, 4096. Increase this to reduce 'smearing'. This <a href="glossary.html#effect">effect</a> creates a warbling sound similar to when an mp3 is encoded at very low bitrates. </p>
<ul>
<li>Type: float</li>
<li><span class="label">Default:</span> 1024</li>
</ul>
</dd>
<dt id="fmod_dsp_pitchshift_overlap">FMOD_DSP_PITCHSHIFT_OVERLAP</dt>
<dd>Removed. Do not use. FMOD now uses 4 overlaps and cannot be changed. </dd>
<dt id="fmod_dsp_pitchshift_maxchannels">FMOD_DSP_PITCHSHIFT_MAXCHANNELS</dt>
<dd>
<p>Maximum channels supported. 0 = same as FMOD's default output polyphony, 1 = mono, 2 = stereo etc. See remarks for more. It is recommended to leave it at 0.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Range:</span> [0, 16]</li>
</ul>
</dd>
</dl>
<p><code>FMOD_DSP_PITCHSHIFT_MAXCHANNELS</code> dictates the amount of memory allocated. By default, the maxchannels value is 0. If FMOD is set to stereo, the pitch shift unit will allocate enough memory for 2 channels. If it is 5.1, it will allocate enough memory for a 6 channel pitch shift, etc.</p>
<p>If the pitch shift effect is only ever applied to the global mix (i.e. with <a class="apilink" href="core-api-channelcontrol.html#channelcontrol_adddsp">ChannelControl::addDSP</a> on a <a class="apilink" href="core-api-channelgroup.html">ChannelGroup</a> object), then 0 is the value to set as it will be enough to handle all speaker modes.</p>
<p>When the pitch shift is added to a <a class="apilink" href="core-api-channel.html">Channel</a> (i.e. with <a class="apilink" href="core-api-channelcontrol.html#channelcontrol_adddsp">ChannelControl::addDSP</a> on a <a class="apilink" href="core-api-channel.html">Channel</a> object) then the channel count of the <a href="glossary.html#signal">signal</a> that comes in could potentially be anything from 1 to 8. It is only in this case that you might want to increase the channel count above the output's channel count.</p>
<p>If a <a class="apilink" href="core-api-channel.html">Channel</a> pitch shift is set to a lower number than the signal's channel count that is coming in, it will not pitch shift the sound.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_pitchshift">FMOD_DSP_TYPE_PITCHSHIFT</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_return"><a href="#fmod_dsp_return">FMOD_DSP_RETURN</a></h2>
<p><a href="effects-reference.html#return">Return DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_RETURN</span> <span class="p">{</span>
<span class="n">FMOD_DSP_RETURN_ID</span><span class="p">,</span>
<span class="n">FMOD_DSP_RETURN_INPUT_SPEAKER_MODE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_RETURN</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_RETURN</span>
<span class="p">{</span>
<span class="n">ID</span><span class="p">,</span>
<span class="n">INPUT_SPEAKER_MODE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_RETURN_ID</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_RETURN_INPUT_SPEAKER_MODE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_return_id">FMOD_DSP_RETURN_ID <span><a class="token" href="glossary.html#documentation-conventions" title="Read-only">R/O</a></span></dt>
<dd>
<p>ID of this Return DSP.</p>
<ul>
<li>Type: int</li>
<li><span class="label">Default:</span> -1</li>
</ul>
</dd>
<dt id="fmod_dsp_return_input_speaker_mode">FMOD_DSP_RETURN_INPUT_SPEAKER_MODE</dt>
<dd>
<p>Input speaker mode of this return.</p>
<ul>
<li>Type: int (<a class="apilink" href="core-api-common.html#fmod_speakermode">FMOD_SPEAKERMODE</a>)</li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common.html#fmod_speakermode_default">FMOD_SPEAKERMODE_DEFAULT</a></li>
</ul>
</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_return">FMOD_DSP_TYPE_RETURN</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a></p>
<h2 api="enum" id="fmod_dsp_send"><a href="#fmod_dsp_send">FMOD_DSP_SEND</a></h2>
<p><a href="effects-reference.html#send">Send DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_SEND</span> <span class="p">{</span>
<span class="n">FMOD_DSP_SEND_RETURNID</span><span class="p">,</span>
<span class="n">FMOD_DSP_SEND_LEVEL</span>
<span class="p">}</span> <span class="n">FMOD_DSP_SEND</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_SEND</span>
<span class="p">{</span>
<span class="n">RETURNID</span><span class="p">,</span>
<span class="n">LEVEL</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SEND_RETURNID</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SEND_LEVEL</span>
</pre></div>
<dl>
<dt id="fmod_dsp_send_returnid">FMOD_DSP_SEND_RETURNID</dt>
<dd>
<p>ID of the Return DSP this send is connected to where -1 indicates no connected return DSP.</p>
<ul>
<li>Type: int</li>
<li>Default = -1</li>
</ul>
</dd>
<dt id="fmod_dsp_send_level">FMOD_DSP_SEND_LEVEL</dt>
<dd>
<p>Send level.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0, 1]</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_send">FMOD_DSP_TYPE_SEND</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_sfxreverb"><a href="#fmod_dsp_sfxreverb">FMOD_DSP_SFXREVERB</a></h2>
<p><a href="effects-reference.html#sfx-reverb">SFX reverb DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_SFXREVERB</span> <span class="p">{</span>
<span class="n">FMOD_DSP_SFXREVERB_DECAYTIME</span><span class="p">,</span>
<span class="n">FMOD_DSP_SFXREVERB_EARLYDELAY</span><span class="p">,</span>
<span class="n">FMOD_DSP_SFXREVERB_LATEDELAY</span><span class="p">,</span>
<span class="n">FMOD_DSP_SFXREVERB_HFREFERENCE</span><span class="p">,</span>
<span class="n">FMOD_DSP_SFXREVERB_HFDECAYRATIO</span><span class="p">,</span>
<span class="n">FMOD_DSP_SFXREVERB_DIFFUSION</span><span class="p">,</span>
<span class="n">FMOD_DSP_SFXREVERB_DENSITY</span><span class="p">,</span>
<span class="n">FMOD_DSP_SFXREVERB_LOWSHELFFREQUENCY</span><span class="p">,</span>
<span class="n">FMOD_DSP_SFXREVERB_LOWSHELFGAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_SFXREVERB_HIGHCUT</span><span class="p">,</span>
<span class="n">FMOD_DSP_SFXREVERB_EARLYLATEMIX</span><span class="p">,</span>
<span class="n">FMOD_DSP_SFXREVERB_WETLEVEL</span><span class="p">,</span>
<span class="n">FMOD_DSP_SFXREVERB_DRYLEVEL</span>
<span class="p">}</span> <span class="n">FMOD_DSP_SFXREVERB</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_SFXREVERB</span>
<span class="p">{</span>
<span class="n">DECAYTIME</span><span class="p">,</span>
<span class="n">EARLYDELAY</span><span class="p">,</span>
<span class="n">LATEDELAY</span><span class="p">,</span>
<span class="n">HFREFERENCE</span><span class="p">,</span>
<span class="n">HFDECAYRATIO</span><span class="p">,</span>
<span class="n">DIFFUSION</span><span class="p">,</span>
<span class="n">DENSITY</span><span class="p">,</span>
<span class="n">LOWSHELFFREQUENCY</span><span class="p">,</span>
<span class="n">LOWSHELFGAIN</span><span class="p">,</span>
<span class="n">HIGHCUT</span><span class="p">,</span>
<span class="n">EARLYLATEMIX</span><span class="p">,</span>
<span class="n">WETLEVEL</span><span class="p">,</span>
<span class="n">DRYLEVEL</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_DECAYTIME</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_EARLYDELAY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_LATEDELAY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_HFREFERENCE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_HFDECAYRATIO</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_DIFFUSION</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_DENSITY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_LOWSHELFFREQUENCY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_LOWSHELFGAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_HIGHCUT</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_EARLYLATEMIX</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_WETLEVEL</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_SFXREVERB_DRYLEVEL</span>
</pre></div>
<dl>
<dt id="fmod_dsp_sfxreverb_decaytime">FMOD_DSP_SFXREVERB_DECAYTIME</dt>
<dd>
<p>Reverberation decay time at low-frequencies. </p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [100, 20000]</li>
<li><span class="label">Default:</span> 1500</li>
</ul>
</dd>
<dt id="fmod_dsp_sfxreverb_earlydelay">FMOD_DSP_SFXREVERB_EARLYDELAY</dt>
<dd>
<p>Delay time of first reflection.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 300]</li>
<li><span class="label">Default:</span> 20</li>
</ul>
</dd>
<dt id="fmod_dsp_sfxreverb_latedelay">FMOD_DSP_SFXREVERB_LATEDELAY</dt>
<dd>
<p>Late reverberation delay time relative to first reflection in milliseconds.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Milliseconds</li>
<li><span class="label">Range:</span> [0, 100]</li>
<li><span class="label">Default:</span> 40</li>
</ul>
</dd>
<dt id="fmod_dsp_sfxreverb_hfreference">FMOD_DSP_SFXREVERB_HFREFERENCE</dt>
<dd>
<p>Reference frequency for high-frequency decay.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [20, 20000]</li>
<li><span class="label">Default:</span> 5000</li>
</ul>
</dd>
<dt id="fmod_dsp_sfxreverb_hfdecayratio">FMOD_DSP_SFXREVERB_HFDECAYRATIO</dt>
<dd>
<p>High-frequency decay time relative to decay time.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Percent</li>
<li><span class="label">Range:</span> [10, 100]</li>
<li><span class="label">Default:</span> 50</li>
</ul>
</dd>
<dt id="fmod_dsp_sfxreverb_diffusion">FMOD_DSP_SFXREVERB_DIFFUSION</dt>
<dd>
<p>Reverberation diffusion (echo density).</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Percent</li>
<li><span class="label">Range:</span> [10, 100]</li>
<li><span class="label">Default:</span> 50</li>
</ul>
</dd>
<dt id="fmod_dsp_sfxreverb_density">FMOD_DSP_SFXREVERB_DENSITY</dt>
<dd>
<p>Reverberation density (modal density).</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Percent</li>
<li><span class="label">Range:</span> [10, 100]</li>
<li><span class="label">Default:</span> 50</li>
</ul>
</dd>
<dt id="fmod_dsp_sfxreverb_lowshelffrequency">FMOD_DSP_SFXREVERB_LOWSHELFFREQUENCY</dt>
<dd>
<p>Transition frequency of low-shelf filter.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [20, 1000]</li>
<li><span class="label">Default:</span> 250</li>
</ul>
</dd>
<dt id="fmod_dsp_sfxreverb_lowshelfgain">FMOD_DSP_SFXREVERB_LOWSHELFGAIN</dt>
<dd>
<p>Gain of low-shelf filter.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-36, 12]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_sfxreverb_highcut">FMOD_DSP_SFXREVERB_HIGHCUT</dt>
<dd>
<p>Cutoff frequency of low-pass filter.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [20, 20000]</li>
<li><span class="label">Default:</span> 20000</li>
</ul>
</dd>
<dt id="fmod_dsp_sfxreverb_earlylatemix">FMOD_DSP_SFXREVERB_EARLYLATEMIX</dt>
<dd>
<p>Blend ratio of late reverb to early reflections.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Percent</li>
<li><span class="label">Range:</span> [0, 100]</li>
<li><span class="label">Default:</span> 50</li>
</ul>
</dd>
<dt id="fmod_dsp_sfxreverb_wetlevel">FMOD_DSP_SFXREVERB_WETLEVEL</dt>
<dd>
<p>Reverb <a href="glossary.html#signal">signal</a> level.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 20]</li>
<li><span class="label">Default:</span> -6</li>
</ul>
</dd>
<dt id="fmod_dsp_sfxreverb_drylevel">FMOD_DSP_SFXREVERB_DRYLEVEL</dt>
<dd>
<p>Dry signal level.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 20]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
</dl>
<p>This is a high quality I3DL2 based reverb. On top of the I3DL2 property set, "Dry Level" is also included to allow the dry mix to be changed. These properties can be set with presets in <a class="apilink" href="core-api-system.html#fmod_reverb_presets">FMOD_REVERB_PRESETS</a>.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_sfxreverb">FMOD_DSP_TYPE_SFXREVERB</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-system.html#fmod_reverb_presets">FMOD_REVERB_PRESETS</a></p>
<h2 api="enum" id="fmod_dsp_three_eq"><a href="#fmod_dsp_three_eq">FMOD_DSP_THREE_EQ</a></h2>
<p><a href="effects-reference.html#three-eq">Three EQ DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_THREE_EQ</span> <span class="p">{</span>
<span class="n">FMOD_DSP_THREE_EQ_LOWGAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_THREE_EQ_MIDGAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_THREE_EQ_HIGHGAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_THREE_EQ_LOWCROSSOVER</span><span class="p">,</span>
<span class="n">FMOD_DSP_THREE_EQ_HIGHCROSSOVER</span><span class="p">,</span>
<span class="n">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_THREE_EQ</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_THREE_EQ</span>
<span class="p">{</span>
<span class="n">LOWGAIN</span><span class="p">,</span>
<span class="n">MIDGAIN</span><span class="p">,</span>
<span class="n">HIGHGAIN</span><span class="p">,</span>
<span class="n">LOWCROSSOVER</span><span class="p">,</span>
<span class="n">HIGHCROSSOVER</span><span class="p">,</span>
<span class="n">CROSSOVERSLOPE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_THREE_EQ_LOWGAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_THREE_EQ_MIDGAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_THREE_EQ_HIGHGAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_THREE_EQ_LOWCROSSOVER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_THREE_EQ_HIGHCROSSOVER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_THREE_EQ_CROSSOVERSLOPE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_three_eq_lowgain">FMOD_DSP_THREE_EQ_LOWGAIN</dt>
<dd>
<p>Low frequency gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_three_eq_midgain">FMOD_DSP_THREE_EQ_MIDGAIN</dt>
<dd>
<p>Mid frequency gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_three_eq_highgain">FMOD_DSP_THREE_EQ_HIGHGAIN</dt>
<dd>
<p>High frequency gain.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_three_eq_lowcrossover">FMOD_DSP_THREE_EQ_LOWCROSSOVER</dt>
<dd>
<p>Low-to-mid crossover frequency.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [10, 22000]</li>
<li><span class="label">Default:</span> 400</li>
</ul>
</dd>
<dt id="fmod_dsp_three_eq_highcrossover">FMOD_DSP_THREE_EQ_HIGHCROSSOVER</dt>
<dd>
<p>Mid-to-high crossover frequency.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [10, 22000]</li>
<li><span class="label">Default:</span> 4000</li>
</ul>
</dd>
<dt id="fmod_dsp_three_eq_crossoverslope">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE</dt>
<dd>
<p>Crossover Slope type.</p>
<ul>
<li>Type: int <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_three_eq_crossoverslope_type">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_TYPE</a></li>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_three_eq_crossoverslope_24db">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_24DB</a></li>
</ul>
</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_three_eq">FMOD_DSP_TYPE_THREE_EQ</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a></p>
<h2 api="enum" id="fmod_dsp_three_eq_crossoverslope_type"><a href="#fmod_dsp_three_eq_crossoverslope_type">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_TYPE</a></h2>
<p>Crossover values for the <a href="effects-reference.html#three-eq">three EQ DSP</a>.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_TYPE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_12DB</span><span class="p">,</span>
<span class="n">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_24DB</span><span class="p">,</span>
<span class="n">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_48DB</span>
<span class="p">}</span> <span class="n">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_THREE_EQ_CROSSOVERSLOPE_TYPE</span>
<span class="p">{</span>
<span class="n">_12DB</span><span class="p">,</span>
<span class="n">_24DB</span><span class="p">,</span>
<span class="n">_48DB</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_THREE_EQ_CROSSOVERSLOPE_12DB</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_THREE_EQ_CROSSOVERSLOPE_24DB</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_THREE_EQ_CROSSOVERSLOPE_48DB</span>
</pre></div>
<dl>
<dt id="fmod_dsp_three_eq_crossoverslope_12db">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_12DB</dt>
<dd>12dB/Octave crossover slope.</dd>
<dt id="fmod_dsp_three_eq_crossoverslope_24db">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_24DB</dt>
<dd>24dB/Octave crossover slope.</dd>
<dt id="fmod_dsp_three_eq_crossoverslope_48db">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_48DB</dt>
<dd>48dB/Octave crossover slope.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_three_eq_crossoverslope">FMOD_DSP_THREE_EQ_CROSSOVERSLOPE</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_three_eq">FMOD_DSP_TYPE_THREE_EQ</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_three_eq">FMOD_DSP_THREE_EQ</a></p>
<h2 api="enum" id="fmod_dsp_transceiver"><a href="#fmod_dsp_transceiver">FMOD_DSP_TRANSCEIVER</a></h2>
<p><a href="effects-reference.html#transceiver">Transceiver DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_TRANSCEIVER</span> <span class="p">{</span>
<span class="n">FMOD_DSP_TRANSCEIVER_TRANSMIT</span><span class="p">,</span>
<span class="n">FMOD_DSP_TRANSCEIVER_GAIN</span><span class="p">,</span>
<span class="n">FMOD_DSP_TRANSCEIVER_CHANNEL</span><span class="p">,</span>
<span class="n">FMOD_DSP_TRANSCEIVER_TRANSMITSPEAKERMODE</span>
<span class="p">}</span> <span class="n">FMOD_DSP_TRANSCEIVER</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_TRANSCEIVER</span>
<span class="p">{</span>
<span class="n">TRANSMIT</span><span class="p">,</span>
<span class="n">GAIN</span><span class="p">,</span>
<span class="n">CHANNEL</span><span class="p">,</span>
<span class="n">TRANSMITSPEAKERMODE</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TRANSCEIVER_TRANSMIT</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TRANSCEIVER_GAIN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TRANSCEIVER_CHANNEL</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TRANSCEIVER_TRANSMITSPEAKERMODE</span>
</pre></div>
<dl>
<dt id="fmod_dsp_transceiver_transmit">FMOD_DSP_TRANSCEIVER_TRANSMIT</dt>
<dd>
<p>FALSE = Transceiver is a 'receiver' (like a return) and accepts data from a channel. TRUE = Transceiver is a 'transmitter' (like a send).</p>
<ul>
<li>Type: bool</li>
<li><span class="label">Default:</span> false</li>
</ul>
</dd>
<dt id="fmod_dsp_transceiver_gain">FMOD_DSP_TRANSCEIVER_GAIN</dt>
<dd>
<p>Gain to receive or transmit.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Decibels</li>
<li><span class="label">Range:</span> [-80, 10]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_transceiver_channel">FMOD_DSP_TRANSCEIVER_CHANNEL</dt>
<dd>
<p>Global slot that can be transmitted to or received from.</p>
<ul>
<li>Type: int</li>
<li><span class="label">Range:</span> [0, 31]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_transceiver_transmitspeakermode">FMOD_DSP_TRANSCEIVER_TRANSMITSPEAKERMODE</dt>
<dd>
<p>Speaker mode (transmitter mode only). (<a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_transceiver_speakermode">FMOD_DSP_TRANSCEIVER_SPEAKERMODE</a>)</p>
<ul>
<li><span class="label">Default:</span> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_transceiver_speakermode_auto">FMOD_DSP_TRANSCEIVER_SPEAKERMODE_AUTO</a></li>
</ul>
</dd>
</dl>
<p>The transceiver only transmits and receives to a global array of 32 channels. The transceiver can be set to receiver mode (like a return) and can receive the <a href="glossary.html#signal">signal</a> at a variable gain. The transceiver can also be set to transmit to a channel (like a send) and can transmit the signal with a variable gain.</p>
<p>The <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_transceiver_transmitspeakermode">FMOD_DSP_TRANSCEIVER_TRANSMITSPEAKERMODE</a> is only applicable to the transmission format, not the receive format. This means this parameter is ignored in 'receive mode'. This allows receivers to receive at the speaker mode of the user's choice. Receiving from a mono channel, is cheaper than receiving from a surround channel for example. The 3 speaker modes <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_transceiver_speakermode_mono">FMOD_DSP_TRANSCEIVER_SPEAKERMODE_MONO</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_transceiver_speakermode_stereo">FMOD_DSP_TRANSCEIVER_SPEAKERMODE_STEREO</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_transceiver_speakermode_surround">FMOD_DSP_TRANSCEIVER_SPEAKERMODE_SURROUND</a> are stored as separate buffers in memory for a transmitter channel. To save memory, use 1 common speaker mode for a transmitter.</p>
<p>The transceiver is double buffered to avoid desyncing of transmitters and receivers. This means there will be a 1 block delay on a receiver, compared to the data sent from a transmitter. Multiple transmitters sending to the same channel will be mixed together.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_transceiver">FMOD_DSP_TYPE_TRANSCEIVER</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_transceiver_gain">FMOD_DSP_TRANSCEIVER_GAIN</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterbool">DSP::setParameterBool</a></p>
<h2 api="enum" id="fmod_dsp_transceiver_speakermode"><a href="#fmod_dsp_transceiver_speakermode">FMOD_DSP_TRANSCEIVER_SPEAKERMODE</a></h2>
<p>Speaker mode values for the <a href="effects-reference.html#transceiver">transceiver DSP</a>.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_TRANSCEIVER_SPEAKERMODE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_TRANSCEIVER_SPEAKERMODE_AUTO</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span>
<span class="n">FMOD_DSP_TRANSCEIVER_SPEAKERMODE_MONO</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="n">FMOD_DSP_TRANSCEIVER_SPEAKERMODE_STEREO</span><span class="p">,</span>
<span class="n">FMOD_DSP_TRANSCEIVER_SPEAKERMODE_SURROUND</span>
<span class="p">}</span> <span class="n">FMOD_DSP_TRANSCEIVER_SPEAKERMODE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_TRANSCEIVER_SPEAKERMODE</span>
<span class="p">{</span>
<span class="n">AUTO</span> <span class="p">=</span> <span class="p">-</span><span class="m">1</span><span class="p">,</span>
<span class="n">MONO</span> <span class="p">=</span> <span class="m">0</span><span class="p">,</span>
<span class="n">STEREO</span><span class="p">,</span>
<span class="n">SURROUND</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TRANSCEIVER_SPEAKERMODE_AUTO</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TRANSCEIVER_SPEAKERMODE_MONO</span> <span class="o">=</span> <span class="mi">0</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TRANSCEIVER_SPEAKERMODE_STEREO</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TRANSCEIVER_SPEAKERMODE_SURROUND</span>
</pre></div>
<dl>
<dt id="fmod_dsp_transceiver_speakermode_auto">FMOD_DSP_TRANSCEIVER_SPEAKERMODE_AUTO</dt>
<dd>The transmitter uses the channel count of its input <a href="glossary.html#signal">signal</a> as the channel count of its channel buffer. </dd>
<dt id="fmod_dsp_transceiver_speakermode_mono">FMOD_DSP_TRANSCEIVER_SPEAKERMODE_MONO</dt>
<dd>The transmitter downmixes its input signal to a mono channel buffer.</dd>
<dt id="fmod_dsp_transceiver_speakermode_stereo">FMOD_DSP_TRANSCEIVER_SPEAKERMODE_STEREO</dt>
<dd>The transmitter upmixes or downmixes its input signal to a stereo channel buffer. </dd>
<dt id="fmod_dsp_transceiver_speakermode_surround">FMOD_DSP_TRANSCEIVER_SPEAKERMODE_SURROUND</dt>
<dd>The transmitter upmixes or downmixes its input signal to a surround channel buffer. Surround could mean any speaker mode above stereo, so this could mean quad/surround/5.1/7.1. </dd>
</dl>
<p>The speaker mode of a transceiver buffer (of which there are up to 32) is determined automatically depending on the signal flowing through the transceiver <a href="glossary.html#effect">effect</a>, or it can be forced to a specific mode. Smaller fixed speaker mode buffers can save memory. This is only relevant for transmitter <a href="glossary.html#dsp">DSPs</a>, as only transmitters control the format of the transceiver channel's buffer.</p>
<p>If multiple transceivers transmit to a single buffer in different speaker modes, the buffer allocates memory for each of those speaker modes. This uses more memory than a single speaker mode. If there are multiple receivers reading from a channel with multiple speaker modes in its buffer, each receiver reads them all and mixes them together.</p>
<p>If the system's speaker mode is stereo or mono, it will not create a 3rd buffer, it will just use the mono/stereo speaker mode buffer.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_transceiver">FMOD_DSP_TYPE_TRANSCEIVER</a>, <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_transceiver_speakermode">FMOD_DSP_TRANSCEIVER_SPEAKERMODE</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterint">DSP::setParameterInt</a></p>
<h2 api="enum" id="fmod_dsp_tremolo"><a href="#fmod_dsp_tremolo">FMOD_DSP_TREMOLO</a></h2>
<p><a href="effects-reference.html#tremolo">Tremolo DSP</a> parameter types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_TREMOLO</span> <span class="p">{</span>
<span class="n">FMOD_DSP_TREMOLO_FREQUENCY</span><span class="p">,</span>
<span class="n">FMOD_DSP_TREMOLO_DEPTH</span><span class="p">,</span>
<span class="n">FMOD_DSP_TREMOLO_SHAPE</span><span class="p">,</span>
<span class="n">FMOD_DSP_TREMOLO_SKEW</span><span class="p">,</span>
<span class="n">FMOD_DSP_TREMOLO_DUTY</span><span class="p">,</span>
<span class="n">FMOD_DSP_TREMOLO_SQUARE</span><span class="p">,</span>
<span class="n">FMOD_DSP_TREMOLO_PHASE</span><span class="p">,</span>
<span class="n">FMOD_DSP_TREMOLO_SPREAD</span>
<span class="p">}</span> <span class="n">FMOD_DSP_TREMOLO</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_TREMOLO</span>
<span class="p">{</span>
<span class="n">FREQUENCY</span><span class="p">,</span>
<span class="n">DEPTH</span><span class="p">,</span>
<span class="n">SHAPE</span><span class="p">,</span>
<span class="n">SKEW</span><span class="p">,</span>
<span class="n">DUTY</span><span class="p">,</span>
<span class="n">SQUARE</span><span class="p">,</span>
<span class="n">PHASE</span><span class="p">,</span>
<span class="n">SPREAD</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TREMOLO_FREQUENCY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TREMOLO_DEPTH</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TREMOLO_SHAPE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TREMOLO_SKEW</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TREMOLO_DUTY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TREMOLO_SQUARE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TREMOLO_PHASE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TREMOLO_SPREAD</span>
</pre></div>
<dl>
<dt id="fmod_dsp_tremolo_frequency">FMOD_DSP_TREMOLO_FREQUENCY</dt>
<dd>
<p>LFO frequency.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Hertz</li>
<li><span class="label">Range:</span> [0.1, 20]</li>
<li><span class="label">Default:</span> 5</li>
</ul>
</dd>
<dt id="fmod_dsp_tremolo_depth">FMOD_DSP_TREMOLO_DEPTH</dt>
<dd>
<p>Tremolo depth.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0, 1]</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
<dt id="fmod_dsp_tremolo_shape">FMOD_DSP_TREMOLO_SHAPE</dt>
<dd>
<p>LFO shape morph between triangle and sine.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0, 1]</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
<dt id="fmod_dsp_tremolo_skew">FMOD_DSP_TREMOLO_SKEW</dt>
<dd>
<p>Time-skewing of LFO cycle.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [-1, 1]</li>
<li><span class="label">Default:</span> 0 </li>
</ul>
</dd>
<dt id="fmod_dsp_tremolo_duty">FMOD_DSP_TREMOLO_DUTY</dt>
<dd>
<p>LFO on-time.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0, 1]</li>
<li><span class="label">Default:</span> 0.5</li>
</ul>
</dd>
<dt id="fmod_dsp_tremolo_square">FMOD_DSP_TREMOLO_SQUARE</dt>
<dd>
<p>Flatness of the LFO shape.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0, 1]</li>
<li><span class="label">Default:</span> 1</li>
</ul>
</dd>
<dt id="fmod_dsp_tremolo_phase">FMOD_DSP_TREMOLO_PHASE</dt>
<dd>
<p>Instantaneous LFO phase.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [0, 1]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
<dt id="fmod_dsp_tremolo_spread">FMOD_DSP_TREMOLO_SPREAD</dt>
<dd>
<p>Rotation / auto-pan <a href="glossary.html#effect">effect</a>.</p>
<ul>
<li>Type: float</li>
<li><span class="label">Units:</span> Linear</li>
<li><span class="label">Range:</span> [-1, 1]</li>
<li><span class="label">Default:</span> 0</li>
</ul>
</dd>
</dl>
<p>The tremolo effect varies the amplitude of a sound. Depending on the settings, this unit can produce a tremolo, chopper or auto-pan effect.</p>
<p>The shape of the LFO (low freq. oscillator) can morphed between sine, triangle and sawtooth waves using the <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_tremolo_shape">FMOD_DSP_TREMOLO_SHAPE</a> and <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_tremolo_skew">FMOD_DSP_TREMOLO_SKEW</a> parameters.</p>
<p><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_tremolo_duty">FMOD_DSP_TREMOLO_DUTY</a> and <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_tremolo_square">FMOD_DSP_TREMOLO_SQUARE</a> are useful for a chopper-type effect where the first controls the on-time duration and second controls the flatness of the envelope.</p>
<p><a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_tremolo_spread">FMOD_DSP_TREMOLO_SPREAD</a> varies the LFO phase between channels to get an auto-pan effect. This works best with a sine shape LFO.</p>
<p>The LFO can be synchronized using the <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_tremolo_phase">FMOD_DSP_TREMOLO_PHASE</a> parameter which sets its instantaneous phase.</p>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_type_tremolo">FMOD_DSP_TYPE_TREMOLO</a>, <a class="apilink" href="core-api-dsp.html#dsp_setparameterfloat">DSP::setParameterFloat</a></p>
<h2 api="enum" id="fmod_dsp_type"><a href="#fmod_dsp_type">FMOD_DSP_TYPE</a></h2>
<p><a href="glossary.html#dsp">DSP</a> types.</p>
<p>
<div class="language-selector">
<div class="language-tab" data-language="language-c">C</div>
<div class="language-tab" data-language="language-cpp">C++</div>
<div class="language-tab" data-language="language-csharp">C#</div>
<div class="language-tab" data-language="language-javascript">JS</div>
</div>
</p>
<div class="highlight language-c-cpp"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span> <span class="n">FMOD_DSP_TYPE</span> <span class="p">{</span>
<span class="n">FMOD_DSP_TYPE_UNKNOWN</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_MIXER</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_OSCILLATOR</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_LOWPASS</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_ITLOWPASS</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_HIGHPASS</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_ECHO</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_FADER</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_FLANGE</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_DISTORTION</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_NORMALIZE</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_LIMITER</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_PARAMEQ</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_PITCHSHIFT</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_CHORUS</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_ITECHO</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_COMPRESSOR</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_SFXREVERB</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_LOWPASS_SIMPLE</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_DELAY</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_TREMOLO</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_SEND</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_RETURN</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_HIGHPASS_SIMPLE</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_PAN</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_THREE_EQ</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_FFT</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_LOUDNESS_METER</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_CONVOLUTIONREVERB</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_CHANNELMIX</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_TRANSCEIVER</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_OBJECTPAN</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_MULTIBAND_EQ</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_MULTIBAND_DYNAMICS</span><span class="p">,</span>
<span class="n">FMOD_DSP_TYPE_MAX</span>
<span class="p">}</span> <span class="n">FMOD_DSP_TYPE</span><span class="p">;</span>
</pre></div>
<div class="highlight language-csharp"><pre><span></span><span class="k">enum</span> <span class="n">DSP_TYPE</span> <span class="p">:</span> <span class="kt">int</span>
<span class="p">{</span>
<span class="n">UNKNOWN</span><span class="p">,</span>
<span class="n">MIXER</span><span class="p">,</span>
<span class="n">OSCILLATOR</span><span class="p">,</span>
<span class="n">LOWPASS</span><span class="p">,</span>
<span class="n">ITLOWPASS</span><span class="p">,</span>
<span class="n">HIGHPASS</span><span class="p">,</span>
<span class="n">ECHO</span><span class="p">,</span>
<span class="n">FADER</span><span class="p">,</span>
<span class="n">FLANGE</span><span class="p">,</span>
<span class="n">DISTORTION</span><span class="p">,</span>
<span class="n">NORMALIZE</span><span class="p">,</span>
<span class="n">LIMITER</span><span class="p">,</span>
<span class="n">PARAMEQ</span><span class="p">,</span>
<span class="n">PITCHSHIFT</span><span class="p">,</span>
<span class="n">CHORUS</span><span class="p">,</span>
<span class="n">ITECHO</span><span class="p">,</span>
<span class="n">COMPRESSOR</span><span class="p">,</span>
<span class="n">SFXREVERB</span><span class="p">,</span>
<span class="n">LOWPASS_SIMPLE</span><span class="p">,</span>
<span class="n">DELAY</span><span class="p">,</span>
<span class="n">TREMOLO</span><span class="p">,</span>
<span class="n">SEND</span><span class="p">,</span>
<span class="n">RETURN</span><span class="p">,</span>
<span class="n">HIGHPASS_SIMPLE</span><span class="p">,</span>
<span class="n">PAN</span><span class="p">,</span>
<span class="n">THREE_EQ</span><span class="p">,</span>
<span class="n">FFT</span><span class="p">,</span>
<span class="n">LOUDNESS_METER</span><span class="p">,</span>
<span class="n">CONVOLUTIONREVERB</span><span class="p">,</span>
<span class="n">CHANNELMIX</span><span class="p">,</span>
<span class="n">TRANSCEIVER</span><span class="p">,</span>
<span class="n">OBJECTPAN</span><span class="p">,</span>
<span class="n">MULTIBAND_EQ</span><span class="p">,</span>
<span class="n">MULTIBAND_DYNAMICS</span><span class="p">,</span>
<span class="n">MAX</span>
<span class="p">}</span>
</pre></div>
<div class="highlight language-javascript"><pre><span></span><span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_UNKNOWN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_MIXER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_OSCILLATOR</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_LOWPASS</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_ITLOWPASS</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_HIGHPASS</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_ECHO</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_FADER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_FLANGE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_DISTORTION</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_NORMALIZE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_LIMITER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_PARAMEQ</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_PITCHSHIFT</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_CHORUS</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_ITECHO</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_COMPRESSOR</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_SFXREVERB</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_LOWPASS_SIMPLE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_DELAY</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_TREMOLO</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_SEND</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_RETURN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_HIGHPASS_SIMPLE</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_PAN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_THREE_EQ</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_FFT</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_LOUDNESS_METER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_CONVOLUTIONREVERB</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_CHANNELMIX</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_TRANSCEIVER</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_OBJECTPAN</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_MULTIBAND_EQ</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_MULTIBAND_DYNAMICS</span>
<span class="nx">FMOD</span><span class="p">.</span><span class="nx">DSP_TYPE_MAX</span>
</pre></div>
<dl>
<dt id="fmod_dsp_type_unknown">FMOD_DSP_TYPE_UNKNOWN</dt>
<dd>Was created via a non-FMOD plug-in and has an unknown purpose.</dd>
<dt id="fmod_dsp_type_mixer">FMOD_DSP_TYPE_MIXER</dt>
<dd>Does not process the <a href="glossary.html#signal">signal</a>. Acts as a unit purely for mixing inputs.</dd>
<dt id="fmod_dsp_type_oscillator">FMOD_DSP_TYPE_OSCILLATOR</dt>
<dd>Generates sine/square/saw/triangle or noise tones. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_oscillator">FMOD_DSP_OSCILLATOR</a> for parameter information, <a href="effects-reference.html#oscillator">Effect reference - Oscillator</a> for overview.</dd>
<dt id="fmod_dsp_type_lowpass">FMOD_DSP_TYPE_LOWPASS</dt>
<dd>Filters sound using a high quality, resonant lowpass filter algorithm but consumes more CPU time. Deprecated and will be removed in a future release. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_lowpass">FMOD_DSP_LOWPASS</a> remarks for parameter information, <a href="effects-reference.html#low-pass">Effect reference - Low Pass</a> for overview.</dd>
<dt id="fmod_dsp_type_itlowpass">FMOD_DSP_TYPE_ITLOWPASS</dt>
<dd>Filters sound using a resonant lowpass filter algorithm that is used in Impulse Tracker, but with limited cutoff range (0 to 8060hz). See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_itlowpass">FMOD_DSP_ITLOWPASS</a> for parameter information, <a href="effects-reference.html#it-low-pass">Effect reference - IT Low Pass</a> for overview.</dd>
<dt id="fmod_dsp_type_highpass">FMOD_DSP_TYPE_HIGHPASS</dt>
<dd>Filters sound using a resonant highpass filter algorithm. Deprecated and will be removed in a future release. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_highpass">FMOD_DSP_HIGHPASS</a> remarks for parameter information, <a href="effects-reference.html#high-pass">Effect reference - High Pass</a> for overview.</dd>
<dt id="fmod_dsp_type_echo">FMOD_DSP_TYPE_ECHO</dt>
<dd>Produces an echo on the sound and fades out at the desired rate. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_echo">FMOD_DSP_ECHO</a> for parameter information, <a href="effects-reference.html#echo">Effect reference - Echo</a> for overview.</dd>
<dt id="fmod_dsp_type_fader">FMOD_DSP_TYPE_FADER</dt>
<dd>Pans and scales the volume of a unit. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fader">FMOD_DSP_FADER</a> for parameter information, <a href="effects-reference.html#fader">Effect reference - Fader</a> for overview.</dd>
<dt id="fmod_dsp_type_flange">FMOD_DSP_TYPE_FLANGE</dt>
<dd>Produces a flange effect on the sound. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_flange">FMOD_DSP_FLANGE</a> for parameter information, <a href="effects-reference.html#flange">Effect reference - Flange</a> for overview.</dd>
<dt id="fmod_dsp_type_distortion">FMOD_DSP_TYPE_DISTORTION</dt>
<dd>Distorts the sound. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_distortion">FMOD_DSP_DISTORTION</a> for parameter information, <a href="effects-reference.html#distortion">Effect reference - Distortion</a> for overview.</dd>
<dt id="fmod_dsp_type_normalize">FMOD_DSP_TYPE_NORMALIZE</dt>
<dd>Normalizes or amplifies the sound to a certain level. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_normalize">FMOD_DSP_NORMALIZE</a> for parameter information, <a href="effects-reference.html#normalize">Effect reference - Normalize</a> for overview.</dd>
<dt id="fmod_dsp_type_limiter">FMOD_DSP_TYPE_LIMITER</dt>
<dd>Limits the sound to a certain level. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_limiter">FMOD_DSP_LIMITER</a> for parameter information, <a href="effects-reference.html#limiter">Effect reference - Limiter</a> for overview.</dd>
<dt id="fmod_dsp_type_parameq">FMOD_DSP_TYPE_PARAMEQ</dt>
<dd>Attenuates or amplifies a selected frequency range. Deprecated and will be removed in a future release. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_parameq">FMOD_DSP_PARAMEQ</a> for parameter information, <a href="effects-reference.html#parametric-eq">Effect reference - Parametric EQ</a> for overview.</dd>
<dt id="fmod_dsp_type_pitchshift">FMOD_DSP_TYPE_PITCHSHIFT</dt>
<dd>Bends the pitch of a sound without changing the speed of playback. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pitchshift">FMOD_DSP_PITCHSHIFT</a> for parameter information, <a href="effects-reference.html#pitch-shifter">Effect reference - Pitch Shifter</a> for overview.</dd>
<dt id="fmod_dsp_type_chorus">FMOD_DSP_TYPE_CHORUS</dt>
<dd>Produces a chorus effect on the sound. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_chorus">FMOD_DSP_CHORUS</a> for parameter information, <a href="effects-reference.html#chorus">Effect reference - Chorus</a> for overview.</dd>
<dt id="fmod_dsp_type_itecho">FMOD_DSP_TYPE_ITECHO</dt>
<dd>Produces an echo on the sound and fades out at the desired rate as is used in Impulse Tracker. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_itecho">FMOD_DSP_ITECHO</a> for parameter information, <a href="effects-reference.html#it-echo">Effect reference - IT Echo</a> for overview.</dd>
<dt id="fmod_dsp_type_compressor">FMOD_DSP_TYPE_COMPRESSOR</dt>
<dd>Dynamic compression (linked/unlinked multi-channel, wideband). See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_compressor">FMOD_DSP_COMPRESSOR</a> for parameter information, <a href="effects-reference.html#compressor">Effect reference - Compressor</a> for overview.</dd>
<dt id="fmod_dsp_type_sfxreverb">FMOD_DSP_TYPE_SFXREVERB</dt>
<dd>I3DL2 reverb effect. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_sfxreverb">FMOD_DSP_SFXREVERB</a> for parameter information, <a href="effects-reference.html#sfx-reverb">Effect reference - SFX Reverb</a> for overview.</dd>
<dt id="fmod_dsp_type_lowpass_simple">FMOD_DSP_TYPE_LOWPASS_SIMPLE</dt>
<dd>Filters sound using a simple lowpass with no resonance, but has flexible cutoff and is fast. Deprecated and will be removed in a future release. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_lowpass_simple">FMOD_DSP_LOWPASS_SIMPLE</a> remarks for parameter information, <a href="effects-reference.html#low-pass-simple">Effect reference - Low Pass Simple</a> for overview.</dd>
<dt id="fmod_dsp_type_delay">FMOD_DSP_TYPE_DELAY</dt>
<dd>Produces different delays on individual channels of the sound. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_delay">FMOD_DSP_DELAY</a> for parameter information, <a href="effects-reference.html#delay">Effect reference - Delay</a> for overview.</dd>
<dt id="fmod_dsp_type_tremolo">FMOD_DSP_TYPE_TREMOLO</dt>
<dd>Produces a tremolo / chopper effect on the sound. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_tremolo">FMOD_DSP_TREMOLO</a> for parameter information, <a href="effects-reference.html#tremolo">Effect reference - Tremolo</a> for overview.</dd>
<dt id="fmod_dsp_type_send">FMOD_DSP_TYPE_SEND</dt>
<dd>Sends a copy of the signal to a return DSP anywhere in the DSP tree. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_send">FMOD_DSP_SEND</a> for parameter information, <a href="effects-reference.html#send">Effect reference - Send</a> for overview.</dd>
<dt id="fmod_dsp_type_return">FMOD_DSP_TYPE_RETURN</dt>
<dd>Receives signals from a number of send DSPs. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_return">FMOD_DSP_RETURN</a> for parameter information, <a href="effects-reference.html#return">Effect reference - Return</a> for overview.</dd>
<dt id="fmod_dsp_type_highpass_simple">FMOD_DSP_TYPE_HIGHPASS_SIMPLE</dt>
<dd>Filters sound using a simple highpass with no resonance, but has flexible cutoff and is fast. Deprecated and will be removed in a future release. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_highpass_simple">FMOD_DSP_HIGHPASS_SIMPLE</a> remarks for parameter information, <a href="effects-reference.html#high-pass-simple">Effect reference - High Pass Simple</a> for overview.</dd>
<dt id="fmod_dsp_type_pan">FMOD_DSP_TYPE_PAN</dt>
<dd>Pans the signal in 2D or 3D, possibly upmixing or downmixing as well. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_pan">FMOD_DSP_PAN</a> for parameter information, <a href="effects-reference.html#pan">Effect reference - Pan</a> for overview.</dd>
<dt id="fmod_dsp_type_three_eq">FMOD_DSP_TYPE_THREE_EQ</dt>
<dd>Three-band equalizer. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_three_eq">FMOD_DSP_THREE_EQ</a> for parameter information, <a href="effects-reference.html#three-eq">Effect reference - Three EQ</a> for overview.</dd>
<dt id="fmod_dsp_type_fft">FMOD_DSP_TYPE_FFT</dt>
<dd>Analyzes the signal and provides spectrum information back through getParameter. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_fft">FMOD_DSP_FFT</a> for parameter information, <a href="effects-reference.html#fft">Effect reference - FFT</a> for overview.</dd>
<dt id="fmod_dsp_type_loudness_meter">FMOD_DSP_TYPE_LOUDNESS_METER</dt>
<dd>Analyzes the loudness and true peak of the signal.</dd>
<dt id="fmod_dsp_type_convolutionreverb">FMOD_DSP_TYPE_CONVOLUTIONREVERB</dt>
<dd>Convolution reverb. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_convolution_reverb">FMOD_DSP_CONVOLUTION_REVERB</a> for parameter information, <a href="effects-reference.html#convolution-reverb">Effect reference - Convolution Reverb</a> for overview.</dd>
<dt id="fmod_dsp_type_channelmix">FMOD_DSP_TYPE_CHANNELMIX</dt>
<dd>Provides per channel gain, channel grouping of the input signal which also sets the speaker format for the output signal, and customizable input to output channel routing. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_channelmix">FMOD_DSP_CHANNELMIX</a> for parameter information, <a href="effects-reference.html#channel-mix">Effect reference - Channel Mix</a> for overview.</dd>
<dt id="fmod_dsp_type_transceiver">FMOD_DSP_TYPE_TRANSCEIVER</dt>
<dd>'sends' and 'receives' from a selection of up to 32 different slots. It is like a send/return but it uses global slots rather than returns as the destination. It also has other features. Multiple transceivers can receive from a single channel, or multiple transceivers can send to a single channel, or a combination of both. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_transceiver">FMOD_DSP_TRANSCEIVER</a> for parameter information, <a href="effects-reference.html#transceiver">Effect reference - Transceiver</a> for overview.</dd>
<dt id="fmod_dsp_type_objectpan">FMOD_DSP_TYPE_OBJECTPAN</dt>
<dd>Spatializes input signal by passing it to an external object mixer. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_objectpan">FMOD_DSP_OBJECTPAN</a> for parameter information, <a href="effects-reference.html#object-panner">Effect reference - Object Panner</a> for overview.</dd>
<dt id="fmod_dsp_type_multiband_eq">FMOD_DSP_TYPE_MULTIBAND_EQ</dt>
<dd>Five band parametric equalizer. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_eq">FMOD_DSP_MULTIBAND_EQ</a> for parameter information, <a href="effects-reference.html#multiband-equalizer">Effect reference - Multiband Equalizer</a> for overview.</dd>
<dt id="fmod_dsp_type_multiband_dynamics">FMOD_DSP_TYPE_MULTIBAND_DYNAMICS</dt>
<dd>Three-band compressor/expander. See <a class="apilink" href="core-api-common-dsp-effects.html#fmod_dsp_multiband_dynamics">FMOD_DSP_MULTIBAND_DYNAMICS</a> for parameter information, <a href="effects-reference.html#multiband-dynamics">Effect reference - Multiband Dynamics</a> for overview.</dd>
<dt id="fmod_dsp_type_max">FMOD_DSP_TYPE_MAX</dt>
<dd>Maximum number of pre-defined DSP types.</dd>
</dl>
<p><strong>See Also:</strong> <a class="apilink" href="core-api-system.html#system_createdspbytype">System::createDSPByType</a></p></div>
<p class="manual-footer">FMOD Engine User Manual 2.03.07 (2025-04-02). &copy; 2025 Firelight Technologies Pty Ltd.</p>
</body>
</html>
</div>
Reference in a new issue View git blame Copy permalink