IXAudio2Voice::GetEffectState Method

Returns the running state of the effect at a specified position in the effect chain of the voice.

Syntax

public:
void GetEffectState(
         UINT32 EffectIndex,
         BOOL *pEnabled
)  

Parameters

EffectIndex
Type: UINT32 

Zero-based index of an effect in the effect chain of the voice.

pEnabled
Type: BOOL *

[out] Returns TRUE If the effect is enabled. If the effect is disabled, returns FALSE.

Return value

None.

Remarks

GetEffectState always returns the effect’s actual current state. However, this may not be the state set by the most recent IXAudio2Voice::EnableEffect or IXAudio2Voice::DisableEffect call: the actual state is only changed the next time the audio engine runs after the IXAudio2Voice::EnableEffect or IXAudio2Voice::DisableEffect call (or after the corresponding IXAudio2::CommitChanges call, if EnableEffect/DisableEffect was called with a deferred operation ID).

Requirements

Header: Declared in xaudio2.h.

Library: Use xaudio2.lib.

See also

IXAudio2Voice

IXAudio2Voice Members