Windows apps
Collapse the table of content
Expand the table of content
Information
Switch
Switch
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IXAudio2Voice::GetFilterParameters method

Gets the voice's filter parameters.

Syntax

C++
Copy 

void GetFilterParameters(
  [out] XAUDIO2_FILTER_PARAMETERS *pParameters
);

Parameters

pParameters [out]

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

Header
XAudio2.h

See also

IXAudio2Voice

 

 

Show:
© 2017 Microsoft