Firelight Technologies FMOD Studio API

Channel::get3DDistanceFilter

Retrieve the settings for the 3D distance filter properties for a Channel or Channel Group.

C++ Syntax

FMOD_RESULT Channel::get3DDistanceFilter(
  bool *custom,
  float *customLevel,
  float *centerFreq
);

C Syntax

FMOD_RESULT FMOD_Channel_Get3DDistanceFilter(
  FMOD_CHANNEL *channel,
  FMOD_BOOL *custom,
  float *customLevel,
  float *centerFreq
);

C# Syntax

RESULT Channel.get3DDistanceFilter(
  out bool custom,
  out float customLevel,
  out float centerFreq
);

JavaScript Syntax

Channel.get3DDistanceFilter(
  custom,                          // writes value to custom.val
  customLevel,                     // writes value to customLevel.val
  centerFreq                       // writes value to centerFreq.val
);

Parameters

custom

Address of a variable to receive the enabled/disabled state of the FMOD distance rolloff calculation. Default = false.

customLevel

Address of a variable to receive the manual user attenuation, where 1.0 = no attenuation and 0 = complete attenuation. Default = 1.0.

centerFreq

Address of a variable to receive center frequency in hz for the high-pass filter used to simulate distance attenuation, from 10.0 to 22050.0. Default = 1500.0.

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::set3DDistanceFilter

Version 1.10.03 Built on Feb 1, 2018