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
);
C# Syntax
RESULT DSP.setMeteringEnabled(
bool inputEnabled,
bool outputEnabled
);
JavaScript Syntax
DSP.setMeteringEnabled(
inputEnabled,
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.
Remarks
FMOD_INIT_PROFILE_METER_ALL with System::init will automatically turn on metering for all DSP units inside the FMOD mixer graph.
See Also
Version 1.10.03 Built on Feb 1, 2018