Firelight Technologies FMOD Studio API
System::set3DNumListeners
Sets the number of 3D 'listeners' in the 3D sound scene. This function is useful mainly for split-screen game purposes.
C++ Syntax
FMOD_RESULT System::set3DNumListeners(
int numlisteners
);
C Syntax
FMOD_RESULT FMOD_System_Set3DNumListeners(
FMOD_SYSTEM *system,
int numlisteners
);
C# Syntax
RESULT System.set3DNumListeners(
int numlisteners
);
JavaScript Syntax
System.set3DNumListeners(
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 panning and doppler are turned off. All sound effects will be mono. FMOD uses a 'closest sound to the listener' method to determine what should be heard in this case.
NOTE! Users of the Studio API should call Studio::System::setNumListeners instead of this function.
See Also
Version 1.10.03 Built on Feb 1, 2018