IAudioClient3::GetSharedModeEnginePeriod メソッド (audioclient.h)

指定したストリーム形式のエンジンでサポートされている周期性の範囲を返します。 エンジンの周期性は、エンジンがイベント ドリブン オーディオ クライアントをウェイクアップして、エンジンとの間でオーディオ データを転送する速度です。 返される値は、 IAudioClient2::SetClientProperties の以前の呼び出しで指定されたオーディオ クライアントの特性によって異なります。

構文

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

パラメーター

[in] pFormat

種類: const WAVEFORMATEX*

サポートされている周期性が照会されるストリーム形式。

[out] pDefaultPeriodInFrames

種類: UINT32*

オーディオ サンプルを転送するためにエンジンがクライアントをスリープ解除する既定の期間

[out] pFundamentalPeriodInFrames

種類: UINT32*

オーディオ サンプルを転送するためにエンジンがクライアントをスリープ解除する基本的な期間。 オーディオ エンジンの周期性を設定する場合は、この値の整数倍数を使用する必要があります。

[out] pMinPeriodInFrames

種類: UINT32*

オーディオ フレーム内の最短の期間。オーディオ エンジンは、オーディオ サンプルを転送するためにクライアントをスリープ解除します。

[out] pMaxPeriodInFrames

種類: UINT32*

オーディオ フレーム内で最も長い期間。オーディオ エンジンは、オーディオ サンプルを転送するためにクライアントをスリープ解除します。

戻り値

型: HRESULT

このメソッドは 、正常に 完了したことを示すS_OKを返します。 それ以外の場合は、適切なエラー コードを返します。

注釈

オーディオ クライアントは、 PeriodInFrames パラメーターを使用してオーディオ エンジンから IAudioClient3::InitializeSharedAudioStream に特定の周期性を要求します。 PeriodInFrames の値は、pFundamentalPeriodInFrames パラメーターで返される値の整数倍数である必要があります。 PeriodInFrames は、pMinPeriodInFrames で返される値以上で、pMaxPeriodInFrames の値以下である必要もあります。

たとえば、44100 kHz 形式の 場合、GetSharedModeEnginePeriod は次を返します。

• pDefaultPeriodInFrames = 448 フレーム (約 10.16 ミリ秒)

• pFundamentalPeriodInFrames = 4 フレーム (約 0.09 ミリ秒)

• pMinPeriodInFrames = 48 フレーム (約 1.09 ミリ秒)

• pMaxPeriodInFrames = 448 フレーム (既定値と同じ)

InitializeSharedAudioStream に対して PeriodInFrames パラメーターに使用できる値には、48 と 448 が含まれます。 また、96 や 128 なども含まれます。

4 (最小値より小さい) または 98 (基本の倍数ではない) または 1000 (最大許容値より大きい) は含まれません。

要件

要件	値
サポートされている最小のクライアント	Windows 10 [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2016 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	audioclient.h

こちらもご覧ください

IAudioClient3