Metode IXAudio2Voice::D isableEffect (xaudio2.h)

Menonaktifkan efek pada posisi tertentu dalam rantai efek suara.

Sintaks

\\HRESULT DisableEffect(
  [in] UINT32 EffectIndex,
  [in] UINT32 OperationSet
);

Parameter

[in] EffectIndex

Indeks berbasis nol efek dalam rantai efek suara.

[in] OperationSet

Mengidentifikasi panggilan ini sebagai bagian dari batch yang ditangguhkan. Lihat gambaran umum XAudio2 Operation Sets untuk informasi selengkapnya.

Nilai kembali

Mengembalikan S_OK jika berhasil; jika tidak, kode kesalahan. Lihat Kode Kesalahan XAudio2 untuk deskripsi kode kesalahan yang valid.

Keterangan

Efek dalam rantai efek suara XAudio2 tertentu harus mengonsumsi dan menghasilkan audio pada tingkat sampel pemrosesan suara tersebut. Satu-satunya aspek format audio yang dapat mereka ubah adalah jumlah saluran. Misalnya efek reverb dapat mengonversi data mono menjadi 5.1. Klien dapat menggunakan bidang OutputChannels struktur XAUDIO2_EFFECT_DESCRIPTOR untuk menentukan jumlah saluran yang ingin dihasilkan setiap efek. Setiap efek dalam rantai efek harus menghasilkan sejumlah saluran yang dapat dikonsumsi efek berikutnya. Setiap panggilan ke IXAudio2Voice::EnableEffect atau IXAudio2Voice::D isableEffect yang akan membuat rantai efek berhenti memenuhi persyaratan ini akan gagal.

Menonaktifkan efek segera menghapusnya dari grafik pemrosesan. Audio apa pun yang tertunda efeknya—seperti ekor gaung—tidak diputar. Hati-hati menonaktifkan efek saat suara yang menghostingnya sedang berjalan. Ini dapat menghasilkan artefak yang dapat didengar jika efeknya secara signifikan mengubah nada atau volume audio.

DisableEffect langsung berlaku ketika dipanggil dari panggilan balik XAudio2 dengan OperationSetXAUDIO2_COMMIT_NOW.

Persyaratan Platform

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Persyaratan

Persyaratan	Nilai
Target Platform	Windows
Header	xaudio2.h

Lihat juga

IXAudio2Voice

Gambaran Umum XAPO