IAudioMeterInformation::GetPeakValue メソッド (endpointvolume.h)

  • [アーティクル]

GetPeakValue メソッドは、オーディオ ストリーム内のチャネルのピーク サンプル値を取得します。

構文

HRESULT GetPeakValue(
  [out] float *pfPeak
);

パラメーター

[out] pfPeak

メソッドがオーディオ ストリームのピーク サンプル値を書き込む float 変数へのポインター。 ピーク値は、0.0 から 1.0 までの正規化された範囲の数値です。

戻り値

メソッドが成功した場合は、S_OK を返します。 エラーが発生した場合、次の表に示す値が、可能なリターン コードに含まれますが、これらに限定されません。

リターン コード 説明
E_POINTER
 パラメーター pfPeak は NULL です。

解説

このメソッドは、ストリーム内のすべてのチャネルに記録されたピーク サンプル値を取得します。 各チャネルのピーク値は、1 つのデバイス期間にわたって記録され、後続のデバイス期間中に使用可能になります。 したがって、このメソッドは、前のデバイス期間中に記録されたピーク値を常に取得します。 デバイス期間を取得するには、 IAudioClient::GetDevicePeriod メソッドを 呼び出します。

GetPeakValue メソッドを使用するコード例については、「Peak Meters」を参照してください。

要件

   
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー endpointvolume.h

関連項目

IAudioClient::GetDevicePeriod

IAudioMeterInformation インターフェイス