Firelight Technologies FMOD Studio API

Sound::get3DMinMaxDistance

Retrieve the minimum and maximum audible distance for a sound.

C++ Syntax

FMOD_RESULT Sound::get3DMinMaxDistance(
  float *min,
  float *max
);

C Syntax

FMOD_RESULT FMOD_Sound_Get3DMinMaxDistance(
  FMOD_SOUND *sound,
  float *min,
  float *max
);

C# Syntax

RESULT Sound.get3DMinMaxDistance(
  out float min,
  out float max
);

JavaScript Syntax

Sound.get3DMinMaxDistance(
  min,                             // writes value to min.val
  max                              // writes value to max.val
);

Parameters

min

Pointer to value to be filled with the minimum volume distance for the sound. See remarks for more on units. Optional. Specify 0 or NULL to ignore.

max

Pointer to value to be filled with the maximum volume distance for the sound. See remarks for more on units. 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

A 'distance unit' is specified by System::set3DSettings. By default this is set to meters which is a distance scale of 1.0.
See System::set3DSettings for more on this.
The default units for minimum and maximum distances are 1.0 and 10,000.0f.

See Also

• Sound::set3DMinMaxDistance
• Channel::set3DMinMaxDistance
• Channel::get3DMinMaxDistance
• System::set3DSettings

Version 1.10.03 Built on Feb 1, 2018