Firelight Technologies FMOD Studio API

System::getSoundRAM

Retrieves the amount of dedicated sound ram available if the platform supports it.
Most platforms use main ram to store audio data, so this function usually isn't necessary.

C++ Syntax

FMOD_RESULT System::getSoundRAM(
  int *currentalloced,
  int *maxalloced,
  int *total
);

C Syntax

FMOD_RESULT FMOD_System_GetSoundRAM(
  FMOD_SYSTEM *system,
  int *currentalloced,
  int *maxalloced,
  int *total
);

C# Syntax

RESULT System.getSoundRAM(
  out int currentalloced,
  out int maxalloced,
  out int total
);

JavaScript Syntax

System.getSoundRAM(
  currentalloced,                  // writes value to currentalloced.val
  maxalloced,                      // writes value to maxalloced.val
  total                            // writes value to total.val
);

Parameters

currentalloced

Address of a variable that receives the currently allocated sound ram memory at time of call. Optional. Specify 0 or NULL to ignore.

maxalloced

Address of a variable that receives the maximum allocated sound ram memory since System::init. Optional. Specify 0 or NULL to ignore.

total

Address of a variable that receives the total amount of sound ram available on this device.

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

• Memory_GetStats

Version 1.10.03 Built on Feb 1, 2018