DSP::getWetDryMix

FMOD Studio API

Firelight Technologies FMOD Studio API

DSP::getWetDryMix

Retrieves the wet/dry scale of a DSP effect, through the 'wet' mix, which is the post-processed signal and the 'dry' mix which is the pre-processed signal.

C++ Syntax

FMOD_RESULT DSP::getWetDryMix(
  float *prewet,
  float *postwet,
  float *dry
);

C Syntax

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

C# Syntax

RESULT DSP.getWetDryMix(
  out float prewet,
  out float postwet,
  out float dry
);

JavaScript Syntax

DSP.getWetDryMix(
  prewet,                          // writes value to prewet.val
  postwet,                         // writes value to postwet.val
  dry                              // writes value to dry.val
);

Parameters

prewet
Address of a floating point value, to receive typically 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
Address of a floating point value, to receive typically 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
Address of a floating point value, to receive typically 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