Firelight Technologies FMOD Studio API

ChannelGroup::get3DConeSettings

Retrieves the angles that define the sound projection cone including the volume when outside the cone.

C++ Syntax

FMOD_RESULT ChannelGroup::get3DConeSettings(
  float *insideconeangle,
  float *outsideconeangle,
  float *outsidevolume
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_Get3DConeSettings(
  FMOD_CHANNELGROUP *channelgroup,
  float *insideconeangle,
  float *outsideconeangle,
  float *outsidevolume
);

C# Syntax

RESULT ChannelGroup.get3DConeSettings(
  out float insideconeangle,
  out float outsideconeangle,
  out float outsidevolume
);

JavaScript Syntax

ChannelGroup.get3DConeSettings(
  insideconeangle,                 // writes value to insideconeangle.val
  outsideconeangle,                // writes value to outsideconeangle.val
  outsidevolume                    // writes value to outsidevolume.val
);

Parameters

insideconeangle

Address of a variable that receives the inside cone angle, in degrees. This is the angle within which the sound is at its normal volume.

outsideconeangle

Address of a variable that receives the outside cone angle, in degrees. This is the angle outside of which the sound is at its outside volume.

outsidevolume

Address of a variable that receives the cone outside 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::set3DConeSettings

Version 1.10.03 Built on Feb 1, 2018