Stops the audio processing thread.
public:
void StopEngine()
To correctly pause XAudio2, for example as required by the user when entering Constrained mode, a title should call StopEngine. When resuming a call should be made to StartEngine.
When StopEngine is called, all output is stopped immediately. However, the audio graph is left untouched, preserving effect parameters, effect histories (for example, the data stored by a reverb effect in order to emit echoes of a previous sound), voice states, pending source buffers, cursor positions, and so forth. When the engine is restarted, the resulting audio output will be identical—apart from a period of silence—to the output that would have been produced if the engine had never been stopped.
It is invalid to call StopEngine from within a callback (that is, IXAudio2EngineCallback or IXAudio2VoiceCallback).
Header: Declared in xaudio2.h.
Library: Use xaudio2.lib.