IXAudio2::RegisterForCallbacks Method

Adds an IXAudio2EngineCallback pointer to the XAudio2 engine callback list.

Syntax

public:
HRESULT RegisterForCallbacks(
         IXAudio2EngineCallback *pCallback
)

Parameters

pCallback
Type: IXAudio2EngineCallback *

[in] IXAudio2EngineCallback pointer to add to the XAudio2 engine callback list.

Return value

Type: HRESULT

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

Remarks

This method can be called multiple times, allowing different components or layers of the same application to manage their own engine callback implementations separately.

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

Requirements

Header: Declared in xaudio2.h.