IAudioEndpointVolume::SetMute メソッド (endpointvolume.h)

SetMute メソッドは、オーディオ エンドポイント デバイスに出入りするオーディオ ストリームのミュート状態を設定します。

構文

HRESULT SetMute(
  [in] BOOL    bMute,
  [in] LPCGUID pguidEventContext
);

パラメーター

[in] bMute

新しいミュート状態。 bMute が TRUE の場合、メソッドはストリームをミュートします。 FALSE の場合、メソッドはミュートをオフにします。

[in] pguidEventContext

IAudioEndpointVolumeCallback::OnNotify メソッドのコンテキスト値。 このパラメーターは、イベント コンテキスト GUID を指します。 SetMute 呼び出しでエンドポイントのミュート状態が変更された場合、そのエンドポイントに IAudioEndpointVolumeCallback インターフェイスを登録したすべてのクライアントが通知を受け取ります。 OnNotify メソッドの実装では、クライアントはイベント コンテキスト GUID を検査して、それがコントロール変更イベントのソースであるかどうかを検出できます。 呼び出し元がこのパラメーターに NULL ポインターを指定すると、通知ルーチンはコンテキスト GUID 値GUID_NULLを受け取ります。

戻り値

メソッドが成功し、ミュート状態が変更された場合、メソッドはS_OKを返します。 メソッドが成功し、新しいミュート状態が前のミュート状態と同じ場合、メソッドはS_FALSEを返します。 メソッドが失敗した場合、可能な戻りコードには、次の表に示す値が含まれますが、これらに限定されません。

リターン コード	説明
E_OUTOFMEMORY	メモリが不足しています。

解説

SetMute を呼び出すコード例については、「エンドポイント ボリュームコントロール」を参照してください。

要件

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

関連項目

IAudioEndpointVolume インターフェイス

IAudioEndpointVolumeCallback インターフェイス

IAudioEndpointVolumeCallback::OnNotify