IXAudio2Voice::GetEffectParameters Method

Returns the current effect-specific parameters of a given effect in the voice’s effect chain.

Syntax

public:
HRESULT GetEffectParameters(
         UINT32 EffectIndex,
         void *pParameters,
         UINT32 ParametersByteSize
)  

Parameters

EffectIndex
Type: UINT32 

Zero-based index of an effect within the voice’s effect chain.

pParameters
Type: void *

[out] Returns the current values of the effect-specific parameters.

ParametersByteSize
Type: UINT32 

Size, in bytes, of the pParameters array.

Return value

Type: HRESULT 

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

Requirements

Header: Declared in xaudio2.h.

Library: Use xaudio2.lib.

See also

IXAudio2Voice

IXAudio2Voice Members