System::mixerSuspend

FMOD Studio API

Firelight Technologies FMOD Studio API

System::mixerSuspend

Suspend mixer thread and relinquish usage of audio hardware while maintaining internal state.

C++ Syntax

FMOD_RESULT System::mixerSuspend();

C Syntax

FMOD_RESULT FMOD_System_MixerSuspend(FMOD_SYSTEM *system);

C# Syntax

RESULT System.mixerSuspend();

JavaScript Syntax

System.mixerSuspend();

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

Used on mobile platforms when entering a backgrounded state to reduce CPU to 0%.

All internal state will be maintained, i.e. created sound and channels will stay available in memory.

See Also




Version 1.10.03 Built on Feb 1, 2018