Edit

Share via

IAudioSystemEffects3::GetControllableSystemEffectsList method (audioengineextensionapo.h)

  • Article

Implemented by System Effects Audio Processing Object (sAPO) audio effects to allow the caller to get the current list of effects.

Syntax

HRESULT GetControllableSystemEffectsList(
  AUDIO_SYSTEMEFFECT **effects,
  UINT               *numEffects,
  HANDLE             event
);

Parameters

effects

Receives a pointer to an array of AUDIO_SYSTEMEFFECT_STATE structures representing the current list of audio effects.

numEffects

Receives the number of AUDIO_EFFECT structures returned in effects.

event

The HANDLE of the event that will be signaled if the list changes.

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