Channel::set3DConeSettings

FMOD Studio API

Firelight Technologies FMOD Studio API

Channel::set3DConeSettings

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

C++ Syntax

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

C Syntax

FMOD_RESULT FMOD_Channel_Set3DConeSettings(
  FMOD_CHANNEL *channel,
  float insideconeangle,
  float outsideconeangle,
  float outsidevolume
);

C# Syntax

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

JavaScript Syntax

Channel.set3DConeSettings(
  insideconeangle,                 
  outsideconeangle,                
  outsidevolume                    
);

Parameters

insideconeangle
Inside cone angle, in degrees. 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. 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.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.

Remarks

To define the parameters per sound use Sound::set3DConeSettings.

See Also




Version 1.10.03 Built on Feb 1, 2018