Metode IXAudio2Voice::SetEffectChain (xaudio2.h)

Menggantikan rantai efek suara.

Sintaks

\\HRESULT SetEffectChain(
  [in, optional] const XAUDIO2_EFFECT_CHAIN *pEffectChain
);

Parameter

[in, optional] pEffectChain

Arahkan ke struktur XAUDIO2_EFFECT_CHAIN yang menjelaskan rantai efek baru untuk digunakan. Jika NULL diteruskan, rantai efek saat ini akan dihapus.

Catatan Jika pEffectChain bukan NULL, struktur XAUDIO2_EFFECT_CHAIN yang dirujuknya harus menentukan setidaknya satu efek.

 

Nilai kembali

Mengembalikan S_OK jika berhasil; jika tidak, kode kesalahan.

Lihat Kode Kesalahan XAudio2 untuk deskripsi kode kesalahan spesifik XAudio2.

Keterangan

Jumlah saluran output yang diizinkan untuk rantai efek suara dikunci saat pembuatan suara. Jika Anda membuat suara dengan rantai efek, rantai efek baru yang diteruskan ke SetEffectChain harus memiliki jumlah saluran input dan output yang sama dengan rantai efek asli. Jika Anda membuat suara tanpa rantai efek, jumlah saluran output yang diizinkan untuk rantai efek akan default ke jumlah saluran input untuk suara. Jika ada bagian dari pembuatan rantai efek yang gagal, tidak ada yang diterapkan.

Setelah Anda melampirkan efek ke suara XAudio2, XAudio2 mengendalikan efeknya, dan klien tidak boleh melakukan panggilan lebih lanjut ke dalamnya. Cara paling sederhana untuk memastikan hal ini adalah dengan melepaskan semua penunjuk ke efeknya.

Tidak valid untuk memanggil SetEffectChain dari dalam panggilan balik (yaitu, IXAudio2EngineCallback atau IXAudio2VoiceCallback). Jika Anda memanggil SetEffectChain dalam panggilan balik, setEffectChain akan mengembalikan XAUDIO2_E_INVALID_CALL.

XAUDIO2_EFFECT_CHAIN yang diteruskan sebagai argumen pEffectChain dan informasi XAUDIO2_EFFECT_DESCRIPTOR apa pun yang terkandung di dalamnya tidak lagi diperlukan setelah SetEffectChain berhasil diselesaikan, dan dapat dihapus segera setelah SetEffectChain dipanggil.

Persyaratan Platform

Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Persyaratan

Persyaratan	Nilai
Target Platform	Windows
Header	xaudio2.h

Lihat juga

Cara: Membuat Rantai Efek

IXAudio2Voice

Gambaran Umum XAPO