IXAudio2VoiceCallback::OnVoiceError method (xaudio2.h)

Article
10/05/2021

Called when a critical error occurs during voice processing.

Syntax

void OnVoiceError(
  void    *pBufferContext,
  HRESULT Error
);

Parameters

pBufferContext

Context pointer that was assigned to the pContext member of the XAUDIO2_BUFFER structure when the buffer was submitted.

Error

The HRESULT code of the error encountered.

Return value

None

Remarks

OnVoiceError is called in the event of an error during voice processing, such as a hardware XMA decoder error on the Xbox 360. The arguments report which buffer was being processed at the time of the error, and its HRESULT code. If the error is not recoverable by destroying and re-creating the voice, the OnCriticalError engine callback will be called as well.

Platform Requirements

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

Requirements

Requirement	Value
Target Platform	Windows
Header	xaudio2.h