Firelight Technologies FMOD Studio API

Studio::System::getListenerAttributes

Retrieves the position, velocity and orientation of the 3D sound listener.

C++ Syntax

FMOD_RESULT Studio::System::getListenerAttributes(
  int listener,
  FMOD_3D_ATTRIBUTES *attributes
);

C Syntax

FMOD_RESULT FMOD_Studio_System_GetListenerAttributes(
  FMOD_STUDIO_SYSTEM *system,
  int listener,
  FMOD_3D_ATTRIBUTES *attributes
);

C# Syntax

RESULT Studio.System.getListenerAttributes(
  int listener,
  out _3D_ATTRIBUTES attributes
);

JavaScript Syntax

System.getListenerAttributes(
  listener,                        
  attributes                       // writes value to attributes.val
);

Parameters

listener

Listener index. Specify 0 if there is only 1 listener.

attributes

Address of a variable to receive the 3D attributes for the listener. See FMOD_3D_ATTRIBUTES.

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::EventInstance::get3DAttributes
• Studio::System::getNumListeners
• Studio::System::setListenerAttributes

Version 1.10.03 Built on Feb 1, 2018