Firelight Technologies FMOD Studio API

Sound::get3DConeSettings

Retrieves the inside and outside angles of the sound projection cone.

C++ Syntax

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

C Syntax

FMOD_RESULT FMOD_Sound_Get3DConeSettings(
  FMOD_SOUND *sound,
  float *insideconeangle,
  float *outsideconeangle,
  float *outsidevolume
);

C# Syntax

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

JavaScript Syntax

Sound.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 angle of the sound projection cone, in degrees. This is the angle within which the sound is at its normal volume. Optional. Specify 0 or NULL to ignore.

outsideconeangle

Address of a variable that receives the outside angle of the sound projection cone, in degrees. This is the angle outside of which the sound is at its outside volume. Optional. Specify 0 or NULL to ignore.

outsidevolume

Address of a variable that receives the cone outside volume for this sound. 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.

See Also

• Sound::set3DConeSettings
• Channel::set3DConeSettings

Version 1.10.03 Built on Feb 1, 2018