Studio::System::setListenerAttributes

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::System::setListenerAttributes

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

C++ Syntax

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

C Syntax

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

C# Syntax

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

JavaScript Syntax

System.setListenerAttributes(
  listener,                        
  attributes                       
);

Parameters

listener
Listener index. Specify 0 if there is only 1 listener.
attributes
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.

Remarks

This should be called every game tick, or at least whenever the listener moves.

See Also




Version 1.10.03 Built on Feb 1, 2018