IXAudio2::StopEngine method

Stops the audio processing thread.

Syntax


void StopEngine();

Parameters

This method has no parameters.

Return value

This method does not return a value.

Remarks

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).

Platform Requirements

Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Requirements

Header

Xaudio2.h

See also

IXAudio2
XAPO Overview

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.