IXAudio2Voice::GetFilterParameters Method

Gets the voice’s filter parameters.

Syntax

public:
void GetFilterParameters(
         XAUDIO2_FILTER_PARAMETERS *pParameters
)  

Parameters

pParameters
Type: XAUDIO2_FILTER_PARAMETERS *

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

Return value

None.

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.

Requirements

Header: Declared in xaudio2.h.

Library: Use xaudio2.lib.

See also

IXAudio2Voice

IXAudio2Voice Members