DSP::setWetDryMix

FMOD Studio API

Firelight Technologies FMOD Studio API

DSP::setWetDryMix

Allows the user to scale the affect of a DSP effect, through control of the 'wet' mix, which is the post-processed signal and the 'dry' which is the pre-processed signal.

C++ Syntax

FMOD_RESULT DSP::setWetDryMix(
  float prewet,
  float postwet,
  float dry
);

C Syntax

FMOD_RESULT FMOD_DSP_SetWetDryMix(
  FMOD_DSP *dsp,
  float prewet,
  float postwet,
  float dry
);

C# Syntax

RESULT DSP.setWetDryMix(
  float prewet,
  float postwet,
  float dry
);

JavaScript Syntax

DSP.setWetDryMix(
  prewet,                          
  postwet,                         
  dry                              
);

Parameters

prewet
Floating point value from 0 to 1, describing a linear scale of the 'wet' (pre-processed signal) mix of the effect. Default = 1.0. Scale can be lower than 0 (negating) and higher than 1 (amplifying).
postwet
Floating point value from 0 to 1, describing a linear scale of the 'wet' (post-processed signal) mix of the effect. Default = 1.0. Scale can be lower than 0 (negating) and higher than 1 (amplifying).
dry
Floating point value from 0 to 1, describing a linear scale of the 'dry' (pre-processed signal) mix of the effect. Default = 0.0. Scale can be lower than 0 and higher than 1 (amplifying).

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

The dry signal path is silent by default, because dsp effects transform the input and pass the newly processed result to the output. It does not add to the input.

See Also




Version 1.10.03 Built on Feb 1, 2018