Firelight Technologies FMOD Studio API

System::get3DSettings

Retrieves the global doppler scale, distance factor and rolloff scale for all 3D sound in FMOD.

C++ Syntax

FMOD_RESULT System::get3DSettings(
  float *dopplerscale,
  float *distancefactor,
  float *rolloffscale
);

C Syntax

FMOD_RESULT FMOD_System_Get3DSettings(
  FMOD_SYSTEM *system,
  float *dopplerscale,
  float *distancefactor,
  float *rolloffscale
);

C# Syntax

RESULT System.get3DSettings(
  out float dopplerscale,
  out float distancefactor,
  out float rolloffscale
);

JavaScript Syntax

System.get3DSettings(
  dopplerscale,                    // writes value to dopplerscale.val
  distancefactor,                  // writes value to distancefactor.val
  rolloffscale                     // writes value to rolloffscale.val
);

Parameters

dopplerscale

Address of a variable that receives the scaling factor for doppler shift. Optional. Specify 0 or NULL to ignore.

distancefactor

Address of a variable that receives the relative distance factor to FMOD's units. Optional. Specify 0 or NULL to ignore.

rolloffscale

Address of a variable that receives the scaling factor for 3D sound rolloff or attenuation. Optional. Specify 0 or NULL to ignore.

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

• System::set3DSettings

Version 1.10.03 Built on Feb 1, 2018