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

IMFAudioStreamVolume

COM
📘 Microsoft Learn (日本語) · English
IID76b1bbdb-4ec8-4f36-b106-70a9316df593継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

個々のオーディオチャンネルの音量レベルを制御します。

解説(Remarks)

アプリケーションでチャンネル単位の音量制御が不要な場合は、IMFSimpleAudioVolume インターフェイスを使用して、オーディオセッションのマスター音量レベルを制御できます。

音量は減衰レベルとして表され、0.0 は無音を、1.0 はフルボリューム(減衰なし)を示します。各チャンネルの減衰レベルは、次の値の積になります。

たとえば、マスター音量が 0.8 でチャンネル音量が 0.5 の場合、そのチャンネルの減衰は 0.8 × 0.5 = 0.4 になります。音量レベルは 1.0 を超える(正のゲイン)ことも可能ですが、オーディオエンジンは 0 デシベルを超えるオーディオサンプルをクリップします。

音量レベルをデシベル(dB)スケールに変換するには、次の式を使用します。

減衰(dB)= 20 * log10(Level)

たとえば、音量レベル 0.50 は 6.02 dB の減衰を表します。

メソッド 5

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

vtbl 3 HRESULT GetChannelCount(DWORD* pdwCount)

オーディオストリーム内のチャンネル数を取得します。

pdwCountDWORD*outオーディオストリーム内のチャンネル数を受け取ります。

戻り値

このメソッドは HRESULT を返します。とり得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドが成功しました。
vtbl 4 HRESULT SetChannelVolume(DWORD dwIndex, FLOAT fLevel)

オーディオストリーム内の指定したチャンネルの音量レベルを設定します。

dwIndexDWORDinオーディオチャンネルのゼロベースのインデックス。チャンネル数を取得するには、IMFAudioStreamVolume::GetChannelCount を呼び出します。
fLevelFLOATinチャンネルの音量レベル。

戻り値

このメソッドは HRESULT を返します。とり得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドが成功しました。
vtbl 5 HRESULT GetChannelVolume(DWORD dwIndex, FLOAT* pfLevel)

オーディオストリーム内の指定したチャンネルの音量レベルを取得します。

dwIndexDWORDinオーディオチャンネルのゼロベースのインデックス。チャンネル数を取得するには、IMFAudioStreamVolume::GetChannelCount を呼び出します。
pfLevelFLOAT*outチャンネルの音量レベルを受け取ります。

戻り値

このメソッドは HRESULT を返します。とり得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドが成功しました。
vtbl 6 HRESULT SetAllVolumes(DWORD dwCount, FLOAT* pfVolumes)

オーディオストリーム内のすべてのチャンネルについて、個々の音量レベルを設定します。

dwCountDWORDinpfVolumes 配列内の要素数。この値はチャンネル数と等しくなければなりません。チャンネル数を取得するには、IMFAudioStreamVolume::GetChannelCount を呼び出します。
pfVolumesFLOAT*in呼び出し元が割り当てた、サイズ dwCount の配列のアドレス。この配列はすべてのチャンネルの音量レベルを指定します。メソッドを呼び出す前に、配列の各要素にそのチャンネルの目的の音量レベルを設定します。

戻り値

このメソッドは HRESULT を返します。とり得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドが成功しました。
vtbl 7 HRESULT GetAllVolumes(DWORD dwCount, FLOAT* pfVolumes)

オーディオストリーム内のすべてのチャンネルの音量レベルを取得します。

dwCountDWORDinpfVolumes 配列内の要素数。この値はチャンネル数と等しくなければなりません。チャンネル数を取得するには、IMFAudioStreamVolume::GetChannelCount を呼び出します。
pfVolumesFLOAT*out呼び出し元が割り当てた、サイズ dwCount の配列のアドレス。メソッドは、ストリーム内の各チャンネルの音量レベルでこの配列を埋めます。

戻り値

このメソッドは HRESULT を返します。とり得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドが成功しました。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IMFAudioStreamVolume "{76B1BBDB-4EC8-4F36-B106-70A9316DF593}"
#usecom global IMFAudioStreamVolume IID_IMFAudioStreamVolume "{}"
#comfunc global IMFAudioStreamVolume_GetChannelCount   3 var
#comfunc global IMFAudioStreamVolume_SetChannelVolume  4 int,float
#comfunc global IMFAudioStreamVolume_GetChannelVolume  5 int,var
#comfunc global IMFAudioStreamVolume_SetAllVolumes     6 int,var
#comfunc global IMFAudioStreamVolume_GetAllVolumes     7 int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。