Firelight Technologies FMOD Studio API

Sound::getDefaults

Retrieves a sound's default attributes for when it is played on a channel with System::playSound.

C++ Syntax

FMOD_RESULT Sound::getDefaults(
  float *frequency,
  int *priority
);

C Syntax

FMOD_RESULT FMOD_Sound_GetDefaults(
  FMOD_SOUND *sound,
  float *frequency,
  int *priority
);

C# Syntax

RESULT Sound.getDefaults(
  out float frequency,
  out int priority
);

JavaScript Syntax

Sound.getDefaults(
  frequency,                       // writes value to frequency.val
  priority                         // writes value to priority.val
);

Parameters

frequency

Address of a variable that receives the default frequency for the sound. Optional. Specify 0 or NULL to ignore.

priority

Address of a variable that receives the default priority for the sound when played on a channel. Result will be from 0 to 256. 0 = most important, 256 = least important. Default = 128. 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

• Sound::setDefaults
• System::createSound
• System::playSound

Version 1.10.03 Built on Feb 1, 2018