Firelight Technologies FMOD Studio API
Studio::System::flushSampleLoading
Waits until all sample loading and unloading has completed.
C++ Syntax
FMOD_RESULT Studio::System::flushSampleLoading();C Syntax
FMOD_RESULT FMOD_Studio_System_FlushSampleLoading(FMOD_STUDIO_SYSTEM *system);C# Syntax
RESULT Studio.System.flushSampleLoading();JavaScript Syntax
System.flushSampleLoading();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
This function will block the calling thread until all pending sample loading and unloading has completed.
Sample loading can be caused by Studio::Bank::loadSampleData, Studio::EventDescription::loadSampleData, and Studio::EventDescription::createInstance.
You can use this function to ensure that Studio has finished executing sample loading, for example measuring memory or disk usage.
NOTE! This function may stall for a long time if other threads are continuing to issue calls to load and unload sample data, such continually creating new event instances.
See Also
Version 1.10.03 Built on Feb 1, 2018