Firelight Technologies FMOD Studio API

Studio::System::setNumListeners

Sets the number of listeners in the 3D sound scene. This function is useful mainly for split-screen game purposes.

C++ Syntax

FMOD_RESULT Studio::System::setNumListeners(
  int numlisteners
);

C Syntax

FMOD_RESULT FMOD_Studio_System_SetNumListeners(
  FMOD_STUDIO_SYSTEM *system,
  int numlisteners
);

C# Syntax

RESULT Studio.System.setNumListeners(
  int numlisteners
);

JavaScript Syntax

System.setNumListeners(
  numlisteners                     
);

Parameters

numlisteners

Number of listeners in the scene. Valid values are from 1 to FMOD_MAX_LISTENERS inclusive. Default = 1.

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

If the number of listeners is set to more than 1, then FMOD uses a 'closest sound to the listener' method to determine what should be heard.

See Also

• Studio::System::getNumListeners
• Studio::System::setListenerAttributes
• Studio::System::setListenerWeight
• FMOD_MAX_LISTENERS

Version 1.10.03 Built on Feb 1, 2018