IXAudio2Voice::SetOutputFilterParameters Method

Sets the filter parameters on one of this voice’s sends.

Syntax

public:
HRESULT SetOutputFilterParameters(
         IXAudio2Voice *pDestinationVoice,
         const XAUDIO2_FILTER_PARAMETERS *pParameters,
         UINT32 OperationSet
)

Parameters

pDestinationVoice
Type: IXAudio2Voice *

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

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

SetOutputFilterParameters 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 a mastering voice’s 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.