Firelight Technologies FMOD Studio API

Channel::set3DLevel

Sets how much the 3D engine has an effect on the channel, versus that set by 2D panning functions.

C++ Syntax

FMOD_RESULT Channel::set3DLevel(
  float level
);

C Syntax

FMOD_RESULT FMOD_Channel_Set3DLevel(
  FMOD_CHANNEL *channel,
  float level
);

C# Syntax

RESULT Channel.set3DLevel(
  float level
);

JavaScript Syntax

Channel.set3DLevel(
  level                            
);

Parameters

level

3D pan level from 0.0 (attenuation is ignored and panning as set by 2D panning functions) to 1.0 (pan and attenuate according to 3D position), 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

Only affects sounds created FMOD_3D.

2D panning functions include ChannelControl::setPan, ChannelControl::setMixLevelsOutput, ChannelControl::setMixLevelsInput, ChannelControl::setMixMatrix, etc

Useful for morhping a sound between 3D and 2D. This is most common in volumetric sound, when the sound goes from directional, to 'all around you' (and doesn't pan according to listener position / direction).

See Also

• ChannelControl::get3DLevel
• ChannelControl::setPan
• ChannelControl::setMixLevelsOutput
• ChannelControl::setMixLevelsInput
• ChannelControl::setMixMatrix

Version 1.10.03 Built on Feb 1, 2018