Win32 API 日本語リファレンス
ホーム › Media.Audio › IAudioPeakMeter

IAudioPeakMeter

COM
📘 Microsoft Learn (日本語) · English
IIDdd79923c-0599-45e0-b8b6-c8df7db6e796継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IAudioPeakMeter インターフェイスは、ハードウェアのピークメーター コントロールへのアクセスを提供します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetChannelCount(DWORD* pcChannels)

GetChannelCount メソッドは、オーディオ ストリーム内のチャネル数を取得します。(IAudioPeakMeter.GetChannelCount)

pcChannelsDWORD*outメソッドがチャネル数を書き込む UINT 変数へのポインター。

戻り値

メソッドが成功した場合は S_OK を返します。失敗した場合、想定される戻り値には以下の表に示す値が含まれますが、これらに限定されません。

戻り値 説明
E_POINTER
 ポインター pcChannels が NULL です。
vtbl 4 HRESULT GetLevel(DWORD nChannel, FLOAT* pfLevel)

GetLevel メソッドは、指定したチャネルについて、そのチャネルのピーク レベルが前回読み取られて以降にピークメーターが記録したピーク レベルを取得します。

nChannelDWORDinチャネル番号。オーディオ ストリームに N 個のチャネルがある場合、チャネルには 0 から N– 1 までの番号が付けられます。ストリーム内のチャネル数を取得するには、IAudioPeakMeter::GetChannelCount メソッドを呼び出します。
pfLevelFLOAT*outメソッドがピークメーター レベルをデシベル単位で書き込む float 変数へのポインター。

戻り値

メソッドが成功した場合は S_OK を返します。失敗した場合、想定される戻り値には以下の表に示す値が含まれますが、これらに限定されません。

戻り値 説明
E_INVALIDARG
 パラメーター nChannel が範囲外です。
E_POINTER
 ポインター pfLevel が NULL です。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IAudioPeakMeter "{DD79923C-0599-45E0-B8B6-C8DF7DB6E796}"
#usecom global IAudioPeakMeter IID_IAudioPeakMeter "{}"
#comfunc global IAudioPeakMeter_GetChannelCount  3 var
#comfunc global IAudioPeakMeter_GetLevel         4 int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。