Firelight Technologies FMOD Studio API
System::lockDSP
Mutual exclusion function to lock the FMOD DSP engine (which runs asynchronously in another thread), so that it
will not execute. If the FMOD DSP engine is already executing, this function will block until it has completed.
The function may be used to synchronize DSP network operations carried out by the user.
An example of using this function may be for when the user wants to construct a DSP sub-network, without the DSP
engine executing in the background while the sub-network is still under construction.
C++ Syntax
FMOD_RESULT System::lockDSP();C Syntax
FMOD_RESULT FMOD_System_LockDSP(FMOD_SYSTEM *system);C# Syntax
RESULT System.lockDSP();JavaScript Syntax
System.lockDSP();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
Once the user no longer needs the DSP engine locked, it must be unlocked with System::unlockDSP.
Note that the DSP engine should not be locked for a significant amount of time, otherwise inconsistency in the
audio output may result. (audio skipping/stuttering).
See Also
Version 1.10.03 Built on Feb 1, 2018