Firelight Technologies FMOD Studio API

DSP::getMeteringInfo

Retrieve the metering information for a particular DSP.

C++ Syntax

FMOD_RESULT DSP::getMeteringInfo(
  FMOD_DSP_METERING_INFO *inputInfo,
  FMOD_DSP_METERING_INFO *outputInfo
);

C Syntax

FMOD_RESULT FMOD_DSP_GetMeteringInfo(
  FMOD_DSP *dsp,
  FMOD_DSP_METERING_INFO *inputInfo,
  FMOD_DSP_METERING_INFO *outputInfo
);

C# Syntax

RESULT DSP.getMeteringInfo(
  DSP_METERING_INFO inputInfo,
  DSP_METERING_INFO outputInfo
);

JavaScript Syntax

DSP.getMeteringInfo(
  inputInfo,                       // writes value to inputInfo.val
  outputInfo                       // writes value to outputInfo.val
);

Parameters

inputInfo

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

outputInfo

Address of a variable to receive metering information 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

• FMOD_DSP_METERING_INFO
• DSP::setMeteringEnabled
• DSP::getMeteringEnabled
• System::init

Version 1.10.03 Built on Feb 1, 2018