Méthode IAudioSystemEffects2 ::GetEffectsList (audioenginebaseapo.h)

La méthode GetEffectsList est utilisée pour récupérer la liste des effets de traitement audio actuellement actifs et stocke un événement à signaler si la liste change.

Syntaxe

HRESULT GetEffectsList(
  [out] LPGUID *ppEffectsIds,
  [out] UINT   *pcEffects,
  [in]  HANDLE Event
);

Paramètres

[out] ppEffectsIds

Pointeur vers la liste des GUID qui représentent les effets de traitement audio. L’appelant est responsable de libérer cette mémoire en appelant CoTaskMemFree.

[out] pcEffects

Nombre d’effets de traitement audio dans la liste.

[in] Event

HANDLE de l’événement qui sera signalé si la liste change.

Valeur retournée

La méthode GetEffectsList retourne S_OK, Si l’appel de méthode réussit. S’il n’y a aucun effet dans la liste, la fonction réussit toujours, ppEffectsIds retourne un pointeur NULL et pcEffects retourne un nombre de 0.

Remarques

L’APO signale l’événement spécifié lorsque la liste des effets de traitement audio change de la liste retournée par GetEffectsList. L’APO utilise cet événement jusqu’à ce que GetEffectsList soit appelé à nouveau ou que l’APO soit détruit. Le handle passé peut être NULL, auquel cas l’APO cesse d’utiliser un handle précédent et ne signale pas d’événement.

Une APO implémente cette méthode pour permettre à Windows de découvrir les effets actuels appliqués par l’APO. La liste des effets peut dépendre du mode de traitement initialisé par l’APO et de toute configuration de l’utilisateur final. Le mode de traitement est indiqué par le membre AudioProcessingModed’APOInitSystemEffects2.

Les API doivent identifier les effets à l’aide de GUID définis par Windows, tels que AUDIO_EFFECT_TYPE_ACOUSTIC_ECHO_CANCELLATION. Un APO ne doit définir et renvoyer un GUID personnalisé que dans de rares cas où le type d’effet est clairement différent de ceux définis par Windows.

Configuration requise

Voir aussi

APOInitSystemEffects2

IAudioSystemEffects2