IXAudio2Voice::GetOutputFilterParameters method (xaudio2.h)

Article
02/22/2024

Returns the filter parameters from one of this voice's sends.

Syntax

\\ void GetOutputFilterParameters(
  [in]  IXAudio2Voice             *pDestinationVoice,
  [out] XAUDIO2_FILTER_PARAMETERS *pParameters
);

Parameters

[in] pDestinationVoice

IXAudio2Voice pointer to the destination voice of the send whose filter parameters will be read.

[out] pParameters

Pointer to an XAUDIO2_FILTER_PARAMETERS structure containing the filter information.

Return value

This method does not return a value.

Remarks

GetOutputFilterParameters will fail if the send was not created with the XAUDIO2_SEND_USEFILTER flag. This method is usable only on sends belonging to source and submix voices and has no effect on mastering voices’ sends.

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

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

Share via