IAudioSystemEffects2::GetEffectsList-Methode (audioenginebaseapo.h)

Die GetEffectsList-Methode wird zum Abrufen der Liste der derzeit aktiven Audioverarbeitungseffekte verwendet und speichert ein Ereignis, das signalisiert werden soll, wenn sich die Liste ändert.

Syntax

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

Parameter

[out] ppEffectsIds

Zeiger auf die Liste der GUIDs, die Audioverarbeitungseffekte darstellen. Der Aufrufer ist für die Freigabe dieses Arbeitsspeichers verantwortlich, indem er CoTaskMemFree aufruft.

[out] pcEffects

Eine Anzahl der Audioverarbeitungseffekte in der Liste.

[in] Event

Der HANDLE des Ereignisses, das signalisiert wird, wenn sich die Liste ändert.

Rückgabewert

Die GetEffectsList-Methode gibt S_OK zurück, Wenn der Methodenaufruf erfolgreich ist. Wenn keine Auswirkungen in der Liste vorhanden sind, ist die Funktion weiterhin erfolgreich, ppEffectsIds gibt einen NULL-Zeiger zurück, und pcEffects gibt die Anzahl 0 zurück.

Hinweise

Der APO signalisiert das angegebene Ereignis, wenn sich die Liste der Audioverarbeitungseffekte aus der Von GetEffectsList zurückgegebenen Liste ändert. Der APO verwendet dieses Ereignis, bis entweder GetEffectsList erneut aufgerufen wird oder das APO zerstört wird. Das übergebene Handle kann NULL sein. In diesem Fall verwendet der APO kein vorheriges Handle mehr und signalisiert kein Ereignis.

Ein APO implementiert diese Methode, damit Windows die aktuellen Effekte erkennen kann, die vom APO angewendet werden. Die Liste der Auswirkungen hängt möglicherweise vom Verarbeitungsmodus ab, den der APO initialisiert hat, und von jeder Endbenutzerkonfiguration. Der Verarbeitungsmodus wird durch das AudioProcessingMode-Element von APOInitSystemEffects2 angegeben.

APOs sollten Effekte mithilfe von von Windows definierten GUIDs wie AUDIO_EFFECT_TYPE_ACOUSTIC_ECHO_CANCELLATION identifizieren. Ein APO sollte eine benutzerdefinierte GUID nur in seltenen Fällen definieren und zurückgeben, in denen sich der Typ des Effekts deutlich von den von Windows definierten unterscheidet.

Anforderungen

Anforderung	Wert
Zielplattform	Desktop
Kopfzeile	audioenginebaseapo.h

Weitere Informationen

APOInitSystemEffects2

IAudioSystemEffects2