IXAudio2::StartEngine method (xaudio2.h)

Starts the audio processing thread.

Syntax

HRESULT StartEngine();

Return value

Returns S_OK if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.

Remarks

After StartEngine is called, all started voices begin to consume audio. All enabled effects start running, and the resulting audio is sent to any connected output devices. When XAudio2 is first initialized, the engine is already in the started state.

It is invalid to call StartEngine from within a callback (that is, IXAudio2EngineCallback or IXAudio2VoiceCallback). If StartEngine is called within a callback, it returns XAUDIO2_E_INVALID_CALL.

Platform Requirements

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Requirements

   
Target Platform Windows
Header xaudio2.h

See also

IXAudio2