Edit

Share via

IAudioSystemEffects3::SetAudioSystemEffectState method (audioengineextensionapo.h)

  • Article

Implemented by System Effects Audio Processing Object (sAPO) audio effects to allow the caller to set the state of effects.

Syntax

HRESULT SetAudioSystemEffectState(
  GUID                     effectId,
  AUDIO_SYSTEMEFFECT_STATE state
);

Parameters

effectId

The GUID identifier for an audio effect. Audio effect GUIDs are defined in ksmedia.h.

state

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

Return value

An HRESULT.

Remarks

For more information on the Windows 11 APIs for the Audio Processing Objects (APOs) that can ship with audio drivers, see Windows 11 APIs for Audio Processing Objects.

Requirements

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