IXAudio2Voice::GetEffectParameters method
Returns the current effect-specific parameters of a given effect in the voice's effect chain.
Syntax
HRESULT GetEffectParameters( [in] UINT32 EffectIndex, [out] void *pParameters, [out] UINT32 ParametersByteSize );
Parameters
- EffectIndex [in]
-
Zero-based index of an effect within the voice's effect chain.
- pParameters [out]
-
Returns the current values of the effect-specific parameters.
- ParametersByteSize [out]
-
Size, in bytes, of the pParameters array.
Return value
Returns S_OK if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.
Fails with E_NOTIMPL if the effect does not support a generic parameter control interface.
Remarks
GetEffectParameters always returns the effect's actual current parameters. However, these may not match the parameters set by the most recent call to IXAudio2Voice::SetEffectParameters: the actual parameters are only changed the next time the audio engine runs after the IXAudio2Voice::SetEffectParameters call (or after the corresponding IXAudio2::CommitChanges call, if IXAudio2Voice::SetEffectParameters 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