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::SetOutputFilterParameters method

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

Syntax

C++
Copy 

HRESULT SetOutputFilterParameters(
  [in] IXAudio2Voice             *pDestinationVoice,
  [in] XAUDIO2_FILTER_PARAMETERS *pParameters,
  [in] UINT32                    OperationSet = XAUDIO2_COMMIT_NOW
);

Parameters

pDestinationVoice [in]

IXAudio2Voice pointer to the destination voice of the send whose filter parameters will be set.

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

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

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