Metode IAudioSystemEffects2::GetEffectsList (audioenginebaseapo.h)

Metode GetEffectsList digunakan untuk mengambil daftar efek pemrosesan audio yang saat ini aktif, dan menyimpan peristiwa yang akan disinyalkan jika daftar berubah.

Sintaks

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

Parameter

[out] ppEffectsIds

Arahkan ke daftar GUID yang mewakili efek pemrosesan audio. Pemanggil bertanggung jawab untuk membebaskan memori ini dengan memanggil CoTaskMemFree.

[out] pcEffects

Hitungan efek pemrosesan audio dalam daftar.

[in] Event

HANDLE peristiwa yang akan disinyalkan jika daftar berubah.

Menampilkan nilai

Metode GetEffectsList mengembalikan S_OK, Jika panggilan metode berhasil. Jika tidak ada efek dalam daftar, fungsi masih berhasil, ppEffectsIds mengembalikan pointer NULL, dan pcEffects mengembalikan hitungan 0.

Keterangan

APO memberi sinyal peristiwa yang ditentukan ketika daftar efek pemrosesan audio berubah dari daftar yang dikembalikan oleh GetEffectsList. APO menggunakan peristiwa ini sampai GetEffectsList dipanggil lagi, atau APO dihancurkan. Handel yang diteruskan dapat berupa NULL, dalam hal ini APO berhenti menggunakan handel sebelumnya dan tidak memberi sinyal peristiwa.

APO mengimplementasikan metode ini untuk memungkinkan Windows menemukan efek saat ini yang diterapkan oleh APO. Daftar efek dapat bergantung pada mode pemrosesan yang diinisialisasi APO, dan pada konfigurasi pengguna akhir apa pun. Mode pemrosesan ditunjukkan oleh anggota AudioProcessingMode dari APOInitSystemEffects2.

API harus mengidentifikasi efek menggunakan GUID yang ditentukan oleh Windows, seperti AUDIO_EFFECT_TYPE_ACOUSTIC_ECHO_CANCELLATION. APO hanya boleh menentukan dan mengembalikan GUID kustom dalam kasus yang jarang terjadi di mana jenis efeknya jelas berbeda dari yang ditentukan oleh Windows.

Persyaratan

Persyaratan	Nilai
Target Platform	Desktop
Header	audioenginebaseapo.h

Lihat juga

APOInitSystemEffects2

IAudioSystemEffects2