Edit

IAudioEffectsManager::SetAudioEffectState method (audioclient.h)

  • Article

Sets the state of the specified audio effect.

Syntax

HRESULT SetAudioEffectState(
  GUID               effectId,
  AUDIO_EFFECT_STATE state
);

Parameters

effectId

The GUID identifier of the effect for which the state is being changed. Audio effect GUIDs are defined in ksmedia.h.

state

A value from the AUDIO_EFFECT_STATE enumerating specifying the state to set.

Return value

Returns an HRESULT including but not limited to the following.

Value Description
S_OK Success
AUDCLNT_E_EFFECT_NOT_AVAILABLE The specifed effect is not available
AUDCLNT_E_EFFECT_STATE_READ_ONLY The specified effect has a state that is read-only
AUDCLNT_E_DEVICE_INVALIDATED The associated audio stream has been destroyed.

Remarks

Get the current list of audio effects for the associated audio stream by calling GetAudioEffects.

Requirements

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