Sound::set3DConeSettings

FMOD Studio API

Firelight Technologies FMOD Studio API

Sound::set3DConeSettings

Sets the inside and outside angles of the sound projection cone, as well as the volume of the sound outside the outside angle of the sound projection cone.

C++ Syntax

FMOD_RESULT Sound::set3DConeSettings(
  float insideconeangle,
  float outsideconeangle,
  float outsidevolume
);

C Syntax

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

C# Syntax

RESULT Sound.set3DConeSettings(
  float insideconeangle,
  float outsideconeangle,
  float outsidevolume
);

JavaScript Syntax

Sound.set3DConeSettings(
  insideconeangle,                 
  outsideconeangle,                
  outsidevolume                    
);

Parameters

insideconeangle
Inside cone angle, in degrees, from 0 to 360. This is the angle within which the sound is at its normal volume. Must not be greater than outsideconeangle. Default = 360.
outsideconeangle
Outside cone angle, in degrees, from 0 to 360. This is the angle outside of which the sound is at its outside volume. Must not be less than insideconeangle. Default = 360.
outsidevolume
Cone outside volume, from 0 to 1.0. Default = 1.0.

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




Version 1.10.03 Built on Feb 1, 2018