IXAudio2Voice::GetOutputFilterParameters Method

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

Syntax

public:
void GetOutputFilterParameters(
         IXAudio2Voice *pDestinationVoice,
         XAUDIO2_FILTER_PARAMETERS *pParameters
)

Parameters

pDestinationVoice
Type: IXAudio2Voice *

[in, optional] IXAudio2Voice pointer to the destination voice of the send whose filter parameters will be read.

pParameters
Type: XAUDIO2_FILTER_PARAMETERS *

[out] Pointer to an XAUDIO2_FILTER_PARAMETERS structure containing the filter information.

Return value

None.

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).

Requirements

Header: Declared in xaudio2.h.