IXAudio2Voice::SetFilterParameters Method

Sets the voice’s filter parameters.

Syntax

public:
HRESULT SetFilterParameters(
         const XAUDIO2_FILTER_PARAMETERS *pParameters,
         UINT32 OperationSet
)

Parameters

pParameters
Type: XAUDIO2_FILTER_PARAMETERS *

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

OperationSet
Type: UINT32

Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.

Return value

Type: HRESULT

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

Requirements

Header: Declared in xaudio2.h.