Firelight Technologies FMOD Studio API

System::attachFileSystem

Function to allow a user to 'piggyback' on FMOD's file reading routines. This allows users to capture data as FMOD reads it, which may be useful for ripping the raw data that FMOD reads for hard to support sources (for example internet streams).

C++ Syntax

FMOD_RESULT System::attachFileSystem(
  FMOD_FILE_OPEN_CALLBACK useropen,
  FMOD_FILE_CLOSE_CALLBACK userclose,
  FMOD_FILE_READ_CALLBACK userread,
  FMOD_FILE_SEEK_CALLBACK userseek
);

C Syntax

FMOD_RESULT FMOD_System_AttachFileSystem(
  FMOD_SYSTEM *system,
  FMOD_FILE_OPEN_CALLBACK useropen,
  FMOD_FILE_CLOSE_CALLBACK userclose,
  FMOD_FILE_READ_CALLBACK userread,
  FMOD_FILE_SEEK_CALLBACK userseek
);

C# Syntax

RESULT System.attachFileSystem(
  FILE_OPENCALLBACK useropen,
  FILE_CLOSECALLBACK userclose,
  FILE_READCALLBACK userread,
  FILE_SEEKCALLBACK userseek
);

JavaScript Syntax

System.attachFileSystem(
  useropen,                        
  userclose,                       
  userread,                        
  userseek                         
);

Parameters

useropen

Pointer to an open callback which is called after a file is opened by FMOD.

userclose

Pointer to a close callback which is called after a file is closed by FMOD.

userread

Pointer to a read callback which is called after a file is read by FMOD.

userseek

Pointer to a seek callback which is called after a file is seeked into by FMOD.

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

NOTE! Do not use this to 'override' FMOD's file system! That is what setFileSystem is for. This function is purely for 'snooping' and letting FMOD do its own file access, but if you want to capture what FMOD is reading you can do it with this function.

See Also

• System::setFileSystem
• FMOD_FILE_OPEN_CALLBACK
• FMOD_FILE_CLOSE_CALLBACK
• FMOD_FILE_READ_CALLBACK
• FMOD_FILE_SEEK_CALLBACK

Version 1.10.03 Built on Feb 1, 2018