Firelight Technologies FMOD Studio API

ChannelGroup::get3DMinMaxDistance

Retrieves the minimum and maximum audible distance.

C++ Syntax

FMOD_RESULT ChannelGroup::get3DMinMaxDistance(
  float *mindistance,
  float *maxdistance
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_Get3DMinMaxDistance(
  FMOD_CHANNELGROUP *channelgroup,
  float *mindistance,
  float *maxdistance
);

C# Syntax

RESULT ChannelGroup.get3DMinMaxDistance(
  out float mindistance,
  out float maxdistance
);

JavaScript Syntax

ChannelGroup.get3DMinMaxDistance(
  mindistance,                     // writes value to mindistance.val
  maxdistance                      // writes value to maxdistance.val
);

Parameters

mindistance

Address of a variable that receives the minimum volume distance in 'units' (see remarks). Optional, specify 0 or NULL to ignore.

maxdistance

Address of a variable that receives the maximum volume distance in 'units' (see remarks). 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 Also

• ChannelControl::set3DMinMaxDistance
• System::set3DSettings

Version 1.10.03 Built on Feb 1, 2018