IXAudio2Voice::GetFilterParameters method (xaudio2.h)

Article
10/13/2021

Gets the voice's filter parameters.

Syntax

\\ void GetFilterParameters(
  [out] XAUDIO2_FILTER_PARAMETERS *pParameters
);

Parameters

[out] pParameters

Pointer to an XAUDIO2_FILTER_PARAMETERS structure containing the filter information.

Return value

This method does not return a value.

Remarks

GetFilterParameters will fail if the voice was not created with the XAUDIO2_VOICE_USEFILTER flag.

GetFilterParameters always returns this voice's actual current filter parameters. However, these may not match the parameters set by the most recent IXAudio2Voice::SetFilterParameters call: the actual parameters are only changed the next time the audio engine runs after the IXAudio2Voice::SetFilterParameters call (or after the corresponding IXAudio2::CommitChanges call, if IXAudio2Voice::SetFilterParameters was called with a deferred operation ID).

Note GetFilterParameters is usable only on source and submix voices and has no effect on mastering voices.

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