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

IAudioMute

COM
📘 Microsoft Learn (日本語) · English
IIDdf45aeea-b74a-4b6b-afad-2366b6aa012e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

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

メソッド 2

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

vtbl 3 HRESULT SetMute(BOOL bMuted, GUID* pguidEventContext)

SetMute メソッドは、ミュートコントロールを有効または無効にします。

bMutedBOOLin新しいミュート状態。bMuted が TRUE(0 以外)の場合、メソッドはミュートを有効にします。FALSE の場合、メソッドはミュートを無効にします。
pguidEventContextGUID*inoptionalIControlChangeNotify::OnNotify メソッドのコンテキスト値。このパラメーターは、イベントコンテキスト GUID を指します。SetMute の呼び出しによってミュートコントロールの状態が変化した場合、そのコントロールに対して IControlChangeNotify インターフェイスを登録しているすべてのクライアントに通知が送られます。OnNotify メソッドの実装において、クライアントはイベントコンテキスト GUID を調べることで、コントロール変更イベントの発生源が自分自身なのか、それとも別のクライアントなのかを判別できます。呼び出し元がこのパラメーターに NULL ポインターを指定した場合、クライアントの通知メソッドは NULL のコンテキストポインターを受け取ります。

戻り値

メソッドが成功した場合は S_OK を返します。失敗した場合、返される可能性のあるコードには、次の表に示す値が含まれますが、これらに限定されません。

戻り値 説明
E_OUTOFMEMORY
 メモリ不足です。
vtbl 4 HRESULT GetMute(BOOL* pbMuted)

GetMute メソッドは、ミュートコントロールの現在の状態(有効または無効)を取得します。

pbMutedBOOL*outメソッドがミュートコントロールの現在の状態を書き込む BOOL 変数へのポインター。状態が TRUE の場合、ミュートは有効です。FALSE の場合、ミュートは無効です。

戻り値

戻り値 説明
E_POINTER ポインター pbMuted が 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_IAudioMute "{DF45AEEA-B74A-4B6B-AFAD-2366B6AA012E}"
#usecom global IAudioMute IID_IAudioMute "{}"
#comfunc global IAudioMute_SetMute  3 int,var
#comfunc global IAudioMute_GetMute  4 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。