Firelight Technologies FMOD Studio API

DSP::setMeteringEnabled

Enable metering for a DSP unit so that DSP::getMeteringInfo will return metering information, and so that FMOD Studio profiler tool can visualize the levels.

C++ Syntax

FMOD_RESULT DSP::setMeteringEnabled(
  bool inputEnabled,
  bool outputEnabled
);

C Syntax

FMOD_RESULT FMOD_DSP_SetMeteringEnabled(
  FMOD_DSP *dsp,
  FMOD_BOOL inputEnabled,
  FMOD_BOOL outputEnabled
);

Parameters

inputEnabled
Enable metering for the input signal (pre-processing). Specify true to turn on input level metering, false to turn it off.
outputEnabled
Enable metering for the output signal (post-processing). Specify true to turn on output level metering, false to turn it off.

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.

See Also




Version 1.03.06 Built on Apr 17, 2014