Metode IAudioClient::SetEventHandle (audioclient.h)

Metode SetEventHandle mengatur penanganan aktivitas yang disinyalir sistem saat buffer audio siap diproses oleh klien.

Sintaks

HRESULT SetEventHandle(
  [in] HANDLE eventHandle
);

Parameter

[in] eventHandle

Handel peristiwa.

Nilai kembali

Jika metode berhasil, metode akan mengembalikan S_OK. Jika gagal, kemungkinan kode pengembalian disertakan, tetapi tidak terbatas pada, nilai yang diperlihatkan dalam tabel berikut.

Menampilkan kode	Deskripsi
E_INVALIDARG	Parameter eventHandle adalah NULL atau handel yang tidak valid.
AUDCLNT_E_EVENTHANDLE_NOT_EXPECTED	Aliran audio tidak diinisialisasi untuk buffering berbasis peristiwa.
AUDCLNT_E_NOT_INITIALIZED	Aliran audio belum berhasil diinisialisasi.
AUDCLNT_E_DEVICE_INVALIDATED	Perangkat titik akhir audio telah dicabut, atau perangkat keras audio atau sumber daya perangkat keras terkait telah dikonfigurasi ulang, dinonaktifkan, dihapus, atau tidak tersedia untuk digunakan.
AUDCLNT_E_SERVICE_NOT_RUNNING	Layanan audio Windows tidak berjalan.

Keterangan

Metode ini memerlukan inisialisasi sebelumnya dari antarmuka IAudioClient . Semua panggilan ke metode ini akan gagal dengan kesalahan AUDCLNT_E_NOT_INITIALIZED sampai klien menginisialisasi aliran audio dengan berhasil memanggil metode IAudioClient::Initialize .

Selama inisialisasi streaming, klien dapat, sebagai opsi, mengaktifkan buffering berbasis peristiwa. Untuk melakukannya, klien memanggil metode IAudioClient::Initialize dengan set bendera AUDCLNT_STREAMFLAGS_EVENTCALLBACK. Setelah mengaktifkan buffering berbasis peristiwa, dan sebelum memanggil metode IAudioClient::Start untuk memulai aliran, klien harus memanggil SetEventHandle untuk mendaftarkan penanganan aktivitas yang akan disinyalir sistem setiap kali buffer siap diproses oleh klien.

Handel peristiwa harus dalam status tidak ditandatangani pada saat klien memanggil metode Mulai .

Jika klien telah mengaktifkan buffering aliran berbasis peristiwa, tetapi klien memanggil metode Mulai untuk aliran tersebut tanpa terlebih dahulu memanggil SetEventHandle, panggilan Mulai akan gagal dan mengembalikan kode kesalahan.

Jika klien tidak mengaktifkan buffering aliran berbasis peristiwa tetapi mencoba mengatur penanganan peristiwa untuk aliran dengan memanggil SetEventHandle, panggilan akan gagal dan mengembalikan kode kesalahan.

Untuk contoh kode yang memanggil metode SetEventHandle , lihat Stream Mode Eksklusif.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [aplikasi desktop | Aplikasi UWP]
Server minimum yang didukung	Windows Server 2008 [aplikasi desktop | Aplikasi UWP]
Target Platform	Windows
Header	audioclient.h

Lihat juga

Antarmuka IAudioClient

IAudioClient::Initialize

IAudioClient::Start