Metodo IAudioSystemEffects2::GetEffectsList (audioenginebaseapo.h)
Il metodo GetEffectsList viene utilizzato per recuperare l'elenco di effetti di elaborazione audio attualmente attivi e archivia un evento da segnalare se l'elenco cambia.
Sintassi
HRESULT GetEffectsList(
[out] LPGUID *ppEffectsIds,
[out] UINT *pcEffects,
[in] HANDLE Event
);
Parametri
[out] ppEffectsIds
Puntatore all'elenco di GUID che rappresentano gli effetti di elaborazione audio. Il chiamante è responsabile della liberazione di questa memoria chiamando CoTaskMemFree.
[out] pcEffects
Conteggio degli effetti di elaborazione audio nell'elenco.
[in] Event
HANDLE dell'evento che verrà segnalato se l'elenco viene modificato.
Valore restituito
Il metodo GetEffectsList restituisce S_OK, se la chiamata al metodo ha esito positivo. Se non sono presenti effetti nell'elenco, la funzione ha comunque esito positivo, ppEffectsIds restituisce un puntatore NULL e pcEffects restituisce un conteggio pari a 0.
Commenti
L'apo segnala l'evento specificato quando l'elenco degli effetti di elaborazione audio cambia dall'elenco restituito da GetEffectsList. L'APO usa questo evento fino a quando non viene chiamato nuovamente GetEffectsList o l'APO non viene eliminato definitivamente. L'handle passato può essere NULL, nel qual caso l'APO smette di usare qualsiasi handle precedente e non segnala un evento.
Un apo implementa questo metodo per consentire a Windows di individuare gli effetti correnti applicati dall'APO. L'elenco degli effetti può dipendere dalla modalità di elaborazione inizializzata dall'APO e da qualsiasi configurazione dell'utente finale. La modalità di elaborazione è indicata dal membro AudioProcessingMode di APOInitSystemEffects2.
Le API devono identificare gli effetti usando GUID definiti da Windows, ad esempio AUDIO_EFFECT_TYPE_ACOUSTIC_ECHO_CANCELLATION. Un apo deve solo definire e restituire un GUID personalizzato in rari casi in cui il tipo di effetto è chiaramente diverso da quelli definiti da Windows.
Requisiti
| Requisito | Valore |
|---|---|
| Piattaforma di destinazione | Desktop |
| Intestazione | audioenginebaseapo.h |