Edit

IAudioEffectsManager::GetAudioEffects method (audioclient.h)

  • Article

Gets the current list of audio effects for the associated audio stream.

Syntax

HRESULT GetAudioEffects(
  AUDIO_EFFECT **effects,
  UINT32       *numEffects
);

Parameters

effects

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

numEffects

Receives the number of AUDIO_EFFECT structures returned in effects.

Return value

Returns an HRESULT including but not limited to the following.

Value Description
S_OK Success
AUDCLNT_E_DEVICE_INVALIDATED The associated audio stream has been destroyed.

Remarks

The caller is responsible for freeing the array using CoTaskMemFree.

Register an IAudioEffectsChangedNotificationClient to receive notifications when the list of audio effects changes.

Requirements

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

See also

AUDIO_EFFECT IAudioEffectsChangedNotificationClient