Firelight Technologies FMOD Studio API

ChannelGroup::getAudibility

Retrieves the combined volume after 3D spatialization and geometry occlusion calculations including any volumes set via the API.

C++ Syntax

FMOD_RESULT ChannelGroup::getAudibility(
  float *audibility
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetAudibility(
  FMOD_CHANNELGROUP *channelgroup,
  float *audibility
);

C# Syntax

RESULT ChannelGroup.getAudibility(
  out float audibility
);

JavaScript Syntax

ChannelGroup.getAudibility(
  audibility                       // writes value to audibility.val
);

Parameters

audibility

Address of a variable that receives the audibility value.

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

This does not represent the waveform, just the calculated result of all volume modifiers. This value is used by the virtual channel system to order its channels between real and virtual.

See the Virtual Voice System page for more details about how the audibility is calculated.

See Also

• Channel::isVirtual
• ChannelControl::getVolume
• ChannelControl::get3DOcclusion
• ChannelControl::get3DAttributes
• FMOD_DSP_PARAMETER_OVERALLGAIN
• FMOD_DSP_PARAMETER_DATA_TYPE_OVERALLGAIN

Version 1.10.03 Built on Feb 1, 2018