IAudioAutoGainControl::SetEnabled メソッド (devicetopology.h)

SetEnabled メソッドは AGC を有効または無効にします。

構文

HRESULT SetEnabled(
  [in] BOOL    bEnable,
  [in] LPCGUID pguidEventContext
);

パラメーター

[in] bEnable

新しい AGC 状態。 このパラメーターが TRUE (0 以外) の場合、 メソッドは AGC を有効にします。 FALSE の場合、AGC が無効になります。

[in] pguidEventContext

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

戻り値

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

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

注釈

無効になっている AGC コントロールはパススルー モードで動作します。 このモードでは、オーディオ ストリームは変更なしでコントロールを通過します。

要件

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

こちらもご覧ください

IAudioAutoGainControl インターフェイス