Metode IAudioClient3::GetSharedModeEnginePeriod (audioclient.h)

Mengembalikan rentang periode yang didukung oleh mesin untuk format aliran yang ditentukan. Periodisitas mesin adalah laju di mana mesin membangunkan klien audio berbasis peristiwa untuk mentransfer data audio ke atau dari mesin. Nilai yang dikembalikan bergantung pada karakteristik klien audio seperti yang ditentukan melalui panggilan sebelumnya ke IAudioClient2::SetClientProperties.

Sintaks

HRESULT GetSharedModeEnginePeriod(
  [in]  const WAVEFORMATEX *pFormat,
  [out] UINT32             *pDefaultPeriodInFrames,
  [out] UINT32             *pFundamentalPeriodInFrames,
  [out] UINT32             *pMinPeriodInFrames,
  [out] UINT32             *pMaxPeriodInFrames
);

Parameter

[in] pFormat

Jenis: const WAVEFORMATEX*

Format aliran yang dikueri oleh periodicities yang didukung.

[out] pDefaultPeriodInFrames

Jenis: UINT32*

Periode default yang dengannya mesin akan membangunkan klien untuk mentransfer sampel audio

[out] pFundamentalPeriodInFrames

Jenis: UINT32*

Periode mendasar di mana mesin akan membangunkan klien untuk mentransfer sampel audio. Saat mengatur periodisitas mesin audio, Anda harus menggunakan kelipatan integral dari nilai ini.

[out] pMinPeriodInFrames

Jenis: UINT32*

Periode terpendek, dalam bingkai audio, yang dengannya mesin audio akan membangunkan klien untuk mentransfer sampel audio.

[out] pMaxPeriodInFrames

Jenis: UINT32*

Periode terpanjang, dalam bingkai audio, yang dengannya mesin audio akan membangunkan klien untuk mentransfer sampel audio.

Nilai kembali

Jenis: HRESULT

Metode ini mengembalikan S_OK untuk menunjukkan bahwa metode telah berhasil diselesaikan. Jika tidak, ia mengembalikan kode kesalahan yang sesuai.

Keterangan

Klien audio meminta periodisitas tertentu dari mesin audio dengan parameter PeriodInFrames ke IAudioClient3::InitializeSharedAudioStream. Nilai PeriodInFrames harus merupakan kelipatan integral dari nilai yang dikembalikan dalam parameter pFundamentalPeriodInFrames . PeriodInFrames juga harus lebih besar dari atau sama dengan nilai yang dikembalikan dalam pMinPeriodInFrames dan kurang dari atau sama dengan nilai pMaxPeriodInFrames.

Misalnya, untuk format 44100 kHz, GetSharedModeEnginePeriod mungkin mengembalikan:

• pDefaultPeriodInFrames = 448 bingkai (sekitar 10,16 milidetik)

• pFundamentalPeriodInFrames = 4 bingkai (sekitar 0,09 milidetik)

• pMinPeriodInFrames = 48 bingkai (sekitar 1,09 milidetik)

• pMaxPeriodInFrames = 448 bingkai (sama dengan default)

Nilai yang diizinkan untuk parameter PeriodInFrames ke InitializeSharedAudioStream akan mencakup 48 dan 448. Mereka juga akan menyertakan hal-hal seperti 96 dan 128.

Mereka TIDAK akan menyertakan 4 (yang lebih kecil dari nilai minimum yang diizinkan) atau 98 (yang bukan kelipatan dari dasarnya) atau 1000 (yang lebih besar dari nilai maksimum yang diizinkan).

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 10 [khusus aplikasi desktop]
Server minimum yang didukung	Windows Server 2016 [hanya aplikasi desktop]
Target Platform	Windows
Header	audioclient.h

Lihat juga

IAudioClient3