AUDIO_EFFECT_STATE enumeration (audioclient.h)

Specifies the state of an audio effect.

Syntax

typedef enum AUDIO_EFFECT_STATE {
  AUDIO_EFFECT_STATE_OFF,
  AUDIO_EFFECT_STATE_ON
} ;

Constants

 
AUDIO_EFFECT_STATE_OFF
The audio effect is off.
AUDIO_EFFECT_STATE_ON
The audio effect is on.

Remarks

Get the state of an audio effect by calling IAudioEffectsManager::GetAudioEffects and checking the state field of the returned AUDIO_EFFECT structures.

Set the state of an audio effect by calling IAudioEffectsManager::SetAudioEffectState.

Requirements

Requirement Value
Minimum supported client Windows Build 22000
Header audioclient.h

See also

IAudioEffectsManager::GetAudioEffects

IAudioEffectsManager::SetAudioEffectState

AUDIO_EFFECT