Método IAudioSystemEffects2::GetEffectsList (audioenginebaseapo.h)
El método GetEffectsList se usa para recuperar la lista de efectos de procesamiento de audio que están activos actualmente y almacena un evento que se indicará si cambia la lista.
Sintaxis
HRESULT GetEffectsList(
[out] LPGUID *ppEffectsIds,
[out] UINT *pcEffects,
[in] HANDLE Event
);
Parámetros
[out] ppEffectsIds
Puntero a la lista de GUID que representan efectos de procesamiento de audio. El autor de la llamada es responsable de liberar esta memoria llamando a CoTaskMemFree.
[out] pcEffects
Recuento de los efectos de procesamiento de audio en la lista.
[in] Event
Identificador del evento que se indicará si cambia la lista.
Valor devuelto
El método GetEffectsList devuelve S_OK, si la llamada al método se realiza correctamente. Si no hay ningún efecto en la lista, la función sigue funcionando correctamente, ppEffectsIds devuelve un puntero NULL y pcEffects devuelve un recuento de 0.
Comentarios
El APO señala el evento especificado cuando cambia la lista de efectos de procesamiento de audio de la lista devuelta por GetEffectsList. El APO usa este evento hasta que se vuelva a llamar a GetEffectsList o se destruya el APO. El identificador pasado puede ser NULL, en cuyo caso el APO deja de usar cualquier identificador anterior y no señala un evento.
Un APO implementa este método para permitir que Windows detecte los efectos actuales aplicados por el APO. La lista de efectos puede depender del modo de procesamiento que inicializó el APO y de cualquier configuración del usuario final. El modo de procesamiento se indica mediante el miembro AudioProcessingMode de APOInitSystemEffects2.
Las API deben identificar efectos mediante GUID definidos por Windows, como AUDIO_EFFECT_TYPE_ACOUSTIC_ECHO_CANCELLATION. Un APO solo debe definir y devolver un GUID personalizado en casos poco frecuentes en los que el tipo de efecto es claramente diferente de los definidos por Windows.
Requisitos
| Requisito | Value |
|---|---|
| Plataforma de destino | Escritorio |
| Encabezado | audioenginebaseapo.h |