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::SetFilterParameters method
Sets the voice's filter parameters.
Syntax
HRESULT SetFilterParameters( [in] const XAUDIO2_FILTER_PARAMETERS *pParameters, [in] UINT32 OperationSet = XAUDIO2_COMMIT_NOW );
Parameters
- pParameters [in]
-
Pointer to an XAUDIO2_FILTER_PARAMETERS structure containing the filter information.
- OperationSet [in]
-
Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.
Return value
Returns S_OK if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.
Remarks
SetFilterParameters will fail if the voice was not created with the XAUDIO2_VOICE_USEFILTER flag.
This method is usable only on source and submix voices and has no effect on mastering voices.
Note IXAudio2Voice::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).
Platform Requirements
Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)
Requirements
|
Header |
|
|---|
See also
Show: