Firelight Technologies FMOD Studio API

DSP::getMeteringEnabled

Retrieve the information about metering for a particular DSP to see if it is enabled or not.

C++ Syntax

FMOD_RESULT DSP::getMeteringEnabled(
  bool *inputEnabled,
  bool *outputEnabled
);

C Syntax

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

C# Syntax

RESULT DSP.getMeteringEnabled(
  out bool inputEnabled,
  out bool outputEnabled
);

JavaScript Syntax

DSP.getMeteringEnabled(
  inputEnabled,                    // writes value to inputEnabled.val
  outputEnabled                    // writes value to outputEnabled.val
);

Parameters

inputEnabled

Address of a variable to receive the metering enabled state for the DSP, for the intput signal (pre-processing). true = on, false = off. Optional. Specify 0 or NULL to ignore.

outputEnabled

Address of a variable to receive the metering enabled state for the DSP, for the output signal (post-processing). true = on, false = off. Optional. Specify 0 or NULL to ignore.

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

• DSP::setMeteringEnabled
• DSP::getMeteringInfo
• System::init

Version 1.10.03 Built on Feb 1, 2018