Channel::get3DLevel

FMOD Studio API

Firelight Technologies FMOD Studio API

Channel::get3DLevel

Retrieves the current 3D mix level set by ChannelControl::set3DPanLevel.

C++ Syntax

FMOD_RESULT Channel::get3DLevel(
  float *level
);

C Syntax

FMOD_RESULT FMOD_Channel_Get3DLevel(
  FMOD_CHANNEL *channel,
  float *level
);

C# Syntax

RESULT Channel.get3DLevel(
  out float level
);

JavaScript Syntax

Channel.get3DLevel(
  level                            // writes value to level.val
);

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).

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::set3DPanLevel



Version 1.10.03 Built on Feb 1, 2018