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

IMFSimpleAudioVolume

COM
📘 Microsoft Learn (日本語) · English
IID089edf13-cf71-4338-8d13-9e569dbdc319継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ストリーミングオーディオレンダラー(SAR)およびオーディオキャプチャソースに関連付けられたオーディオセッションのマスター音量レベルを制御します。

解説(Remarks)

個々のチャンネルの音量レベルを制御するには、IMFAudioStreamVolume インターフェイスを使用します。IMFAudioStreamVolume インターフェイスは SAR でのみサポートされます。

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

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

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

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

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

メソッド 4

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

vtbl 3 HRESULT SetMasterVolume(FLOAT fLevel)

マスター音量レベルを設定します。

fLevelFLOATin音量レベル。音量は減衰レベルとして表され、0.0 は無音を、1.0 はフルボリューム(減衰なし)を示します。

戻り値

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

戻り値 説明
S_OK
 メソッドが成功しました。
MF_E_NOT_INITIALIZED
 オーディオレンダラーが初期化されていません。
MF_E_STREAMSINK_REMOVED
 オーディオレンダラーがパイプラインから削除されました。

解説(Remarks)

アプリケーション外部のイベントによってマスター音量レベルが変更されることがあります。たとえば、ユーザーはシステムの音量調整プログラム(SndVol)から音量を変更できます。外部イベントによってマスター音量が変更された場合、オーディオレンダラーは MEAudioSessionVolumeChanged イベントを送信し、Media Session がそれをアプリケーションに転送します。

vtbl 4 HRESULT GetMasterVolume(FLOAT* pfLevel)

マスター音量レベルを取得します。

pfLevelFLOAT*out音量レベルを受け取ります。音量は減衰レベルとして表され、0.0 は無音を、1.0 はフルボリューム(減衰なし)を示します。

戻り値

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

戻り値 説明
S_OK
 メソッドが成功しました。
MF_E_NOT_INITIALIZED
 オーディオレンダラーが初期化されていません。
MF_E_STREAMSINK_REMOVED
 オーディオレンダラーがパイプラインから削除されました。

解説(Remarks)

外部イベントによってマスター音量が変更された場合、オーディオレンダラーは MEAudioSessionVolumeChanged イベントを送信し、Media Session がそれをアプリケーションに転送します。

vtbl 5 HRESULT SetMute(BOOL bMute)

オーディオをミュートまたはミュート解除します。(IMFSimpleAudioVolume.SetMute)

bMuteBOOLinオーディオをミュートするには TRUE を、ミュートを解除するには FALSE を指定します。

戻り値

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

戻り値 説明
S_OK
 メソッドが成功しました。
MF_E_NOT_INITIALIZED
 オーディオレンダラーが初期化されていません。
MF_E_STREAMSINK_REMOVED
 オーディオレンダラーがパイプラインから削除されました。

解説(Remarks)

このメソッドは、IMFSimpleAudioVolume::GetMasterVolume 関数が返す音量レベルを変更しません。

vtbl 6 HRESULT GetMute(BOOL* pbMute)

オーディオがミュートされているかどうかを照会します。(IMFSimpleAudioVolume.GetMute)

pbMuteBOOL*outブール値を受け取ります。TRUE の場合、オーディオはミュートされています。それ以外の場合、オーディオはミュートされていません。

戻り値

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

戻り値 説明
S_OK
 メソッドが成功しました。
MF_E_NOT_INITIALIZED
 オーディオレンダラーが初期化されていません。
MF_E_STREAMSINK_REMOVED
 オーディオレンダラーがパイプラインから削除されました。

解説(Remarks)

音量を設定するために IMFSimpleAudioVolume::SetMasterVolume を呼び出しても、オーディオがミュートされているかどうかは変わりません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IMFSimpleAudioVolume "{089EDF13-CF71-4338-8D13-9E569DBDC319}"
#usecom global IMFSimpleAudioVolume IID_IMFSimpleAudioVolume "{}"
#comfunc global IMFSimpleAudioVolume_SetMasterVolume  3 float
#comfunc global IMFSimpleAudioVolume_GetMasterVolume  4 var
#comfunc global IMFSimpleAudioVolume_SetMute          5 int
#comfunc global IMFSimpleAudioVolume_GetMute          6 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。