Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 1.9 KB

nf-audioclient-iaudioeffectsmanager-getaudioeffects.md

File metadata and controls

78 lines (60 loc) · 1.9 KB
UID tech.root title ms.date targetos description prerelease req.assembly req.construct-type req.ddi-compliance req.dll req.header req.idl req.include-header req.irql req.kmdf-ver req.lib req.max-support req.namespace req.redist req.target-min-winverclnt req.target-min-winversvr req.target-type req.type-library req.umdf-ver req.unicode-ansi topic_type api_type api_location api_name f1_keywords dev_langs
NF:audioclient.IAudioEffectsManager.GetAudioEffects
CoreAudio
IAudioEffectsManager::GetAudioEffects
06/16/2021
Windows
Gets the current list of audio effects for the associated audio stream.
false
function
audioclient.h
Windows Build 22000
apiref
COM
audioclient.h
IAudioEffectsManager::GetAudioEffects
IAudioEffectsManager::GetAudioEffects
audioclient/IAudioEffectsManager::GetAudioEffects
c++

-description

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

-parameters

-param effects

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

-param numEffects

Receives the number of AUDIO_EFFECT structures returned in effects.

-returns

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.

-see-also

AUDIO_EFFECT IAudioEffectsChangedNotificationClient