Studio::System::flushCommands

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::System::flushCommands

Waits until all pending commands have been executed.

C++ Syntax

FMOD_RESULT Studio::System::flushCommands();

C Syntax

FMOD_RESULT FMOD_Studio_System_FlushCommands(FMOD_STUDIO_SYSTEM *system);

C# Syntax

RESULT Studio.System.flushCommands();

JavaScript Syntax

System.flushCommands();

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

When Studio has been initialized in asynchronous mode, this function will block the calling thread until the pending command buffer is empty and until all non-blocking bank loads have completed.

This is equivalent to calling Studio::System::update and then sleeping until the asynchronous thread has finished executing all pending commands.

You can use this function to ensure that Studio has finished executing all pending commands, for example, when measuring memory usage after calling bank unload.

This function does not wait for sample data loading to complete.

See Also




Version 1.10.03 Built on Feb 1, 2018