IXAudio2SourceVoice::Stop method (xaudio2.h)
Menghentikan konsumsi audio dengan suara saat ini.
Sintaks
HRESULT Stop(
[in] UINT32 Flags,
[in] UINT32 OperationSet
);
Parameter
[in] Flags
Bendera yang mengontrol cara suara dihentikan. Bisa 0 atau berikut ini:
Nilai | Deskripsi |
---|---|
XAUDIO2_PLAY_TAILS | Lanjutkan memancarkan output efek setelah suara dihentikan. |
[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, kode kesalahan sebaliknya. Lihat Kode Kesalahan XAudio2 untuk deskripsi kode kesalahan spesifik XAudio2.
Keterangan
Semua buffer sumber yang diantrekan pada suara dan posisi kursor saat ini dipertahankan. Ini memungkinkan suara untuk melanjutkan dari tempat yang ditinggalkannya, ketika dimulai ulang. Metode IXAudio2SourceVoice::FlushSourceBuffers dapat digunakan untuk membersihkan buffer sumber yang diantrekan.
Secara default, output apa pun yang tertunda dari efek suara—misalnya, ekor gaung—tidak diputar. Sebaliknya, suara segera dirender diam. Bendera XAUDIO2_PLAY_TAILS dapat digunakan untuk terus memancarkan output efek setelah suara berhenti berjalan.
Suara berhenti dengan bendera XAUDIO2_PLAY_TAILS berhenti mengkonsumsi buffer sumber, tetapi terus memproses efeknya dan mengirim audio ke suara tujuannya. Suara dalam status ini nantinya dapat dihentikan sepenuhnya dengan memanggil Hentikan lagi dengan argumen Bendera diatur ke 0. Ini memungkinkan menghentikan suara dengan XAUDIO2_PLAY_TAILS, menunggu cukup waktu untuk audio apa pun yang dihasilkan oleh efeknya selesai, dan kemudian sepenuhnya menghentikan suara dengan memanggil Berhenti lagi tanpa XAUDIO2_PLAY_TAILS. Teknik ini memungkinkan suara dengan efek dihentikan dengan anggun sambil memastikan suara menganggur tidak akan terus diproses setelah selesai menghasilkan audio.
Stop selalu asinkron, bahkan jika dipanggil dalam panggilan balik.
Persyaratan Platform
Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)Persyaratan
Target Platform | Windows |
Header | xaudio2.h |