Firelight Technologies FMOD Studio API

ChannelGroup::getLowPassGain

Retrieves the gain of the dry signal when lowpass filtering is applied.

C++ Syntax

FMOD_RESULT ChannelGroup::getLowPassGain(
  float *gain
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetLowPassGain(
  FMOD_CHANNELGROUP *channelgroup,
  float *gain
);

C# Syntax

RESULT ChannelGroup.getLowPassGain(
  out float gain
);

JavaScript Syntax

ChannelGroup.getLowPassGain(
  gain                             // writes value to gain.val
);

Parameters

gain

Address of a variable that receives the linear gain level, from 0 (silent) to 1.0 (full volume).

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

• ChannelControl::setLowPassGain

Version 1.10.03 Built on Feb 1, 2018