Firelight Technologies FMOD Studio API

Studio::System::getListenerWeight

Gets the listener weighting, which allows listeners to fade in and out.

C++ Syntax

FMOD_RESULT Studio::System::getListenerWeight(
  int listener,
  float *weight
);

C Syntax

FMOD_RESULT FMOD_Studio_System_GetListenerWeight(
  FMOD_STUDIO_SYSTEM *system,
  int listener,
  float *weight
);

C# Syntax

RESULT Studio.System.getListenerWeight(
  int listener,
  out float weight
);

JavaScript Syntax

System.getListenerWeight(
  listener,                        
  weight                           // writes value to weight.val
);

Parameters

listener

Listener index.

weight

Address of a variable to receive the weighting value.

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

• Studio::System::setListenerWeight
• Studio::System::setNumListeners
• Studio::System::getListenerAttributes

Version 1.10.03 Built on Feb 1, 2018