Firelight Technologies FMOD Studio API

System::getFileUsage

Retrieves information about file reads by FMOD.

C++ Syntax

FMOD_RESULT System::getFileUsage(
  long long *sampleBytesRead,
  long long *streamBytesRead,
  long long *otherBytesRead
);

C Syntax

FMOD_RESULT FMOD_System_GetFileUsage(
  FMOD_SYSTEM *system,
  long long *sampleBytesRead,
  long long *streamBytesRead,
  long long *otherBytesRead
);

C# Syntax

RESULT System.getFileUsage(
  out Int64 sampleBytesRead,
  out Int64 streamBytesRead,
  out Int64 otherBytesRead
);

JavaScript Syntax

System.getFileUsage(
  sampleBytesRead,                 // writes value to sampleBytesRead.val
  streamBytesRead,                 // writes value to streamBytesRead.val
  otherBytesRead                   // writes value to otherBytesRead.val
);

Parameters

sampleBytesRead

Address of a variable that receives the total bytes read from file for loading sample data. Optional. Specify 0 or NULL to ignore.

streamBytesRead

Address of a variable that receives the total bytes read from file for streaming sounds. Optional. Specify 0 or NULL to ignore.

otherBytesRead

Address of a variable that receives the total bytes read for non-audio data such as FMOD Studio banks. 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.

Remarks

The values returned are running totals that never reset.

Version 1.10.03 Built on Feb 1, 2018