Firelight Technologies FMOD Studio API

System::getSpeakerPosition

Retrieves the current speaker position information for the selected speaker.

C++ Syntax

FMOD_RESULT System::getSpeakerPosition(
  FMOD_SPEAKER speaker,
  float *x,
  float *y,
  bool *active
);

C Syntax

FMOD_RESULT FMOD_System_GetSpeakerPosition(
  FMOD_SYSTEM *system,
  FMOD_SPEAKER speaker,
  float *x,
  float *y,
  FMOD_BOOL *active
);

C# Syntax

RESULT System.getSpeakerPosition(
  SPEAKER speaker,
  out float x,
  out float y,
  out bool active
);

JavaScript Syntax

System.getSpeakerPosition(
  speaker,                         
  x,                               // writes value to x.val
  y,                               // writes value to y.val
  active                           // writes value to active.val
);

Parameters

speaker

The selected speaker of interest to return the x and y position.

x

Address of a variable that receives the 2D X position relative to the listener. Optional. Specify 0 or NULL to ignore.

y

Address of a variable that receives the 2D Y position relative to the listener. Optional. Specify 0 or NULL to ignore.

active

Address of a variable that receives the active state of a speaker.

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

See the System::setSpeakerPosition for more information on speaker positioning.

See Also

• System::setSpeakerPosition
• FMOD_SPEAKERMODE
• FMOD_SPEAKER

Version 1.10.03 Built on Feb 1, 2018