ホーム › Media.Audio › IAudioAutoGainControl
IAudioAutoGainControl
COM公式ドキュメント
IAudioAutoGainControl インターフェイスは、ハードウェアの自動ゲイン制御 (AGC) へのアクセスを提供します。
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
GetEnabled メソッドは、AGC の現在の状態 (有効または無効) を取得します。
| pbEnabled | BOOL* | out | メソッドが現在の AGC 状態を書き込む BOOL 変数へのポインター。状態が TRUE の場合、AGC は有効です。FALSE の場合、AGC は無効です。 |
戻り値
メソッドが成功した場合は S_OK を返します。失敗した場合、返される可能性のあるコードには次の表に示す値が含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| ポインター pbEnabled が NULL です。 |
解説(Remarks)
無効化された AGC はパススルーモードで動作します。このモードでは、オーディオストリームは AGC を変更なしで通過します。
SetEnabled メソッドは、AGC を有効または無効にします。
| bEnable | BOOL | in | 新しい AGC 状態。このパラメーターが TRUE (0 以外) の場合、メソッドは AGC を有効にします。FALSE の場合、AGC を無効にします。 |
| pguidEventContext | GUID* | inoptional | IControlChangeNotify::OnNotify メソッドのコンテキスト値。このパラメーターはイベントコンテキスト GUID を指します。SetEnabled の呼び出しによって AGC コントロールの状態が変化した場合、そのコントロールに IControlChangeNotify インターフェイスを登録しているすべてのクライアントが通知を受け取ります。OnNotify メソッドの実装において、クライアントはイベントコンテキスト GUID を検査することで、コントロール変更イベントの発生元が自身であるか別のクライアントであるかを判別できます。呼び出し元がこのパラメーターに NULL ポインターを指定した場合、クライアントの通知メソッドは NULL のコンテキストポインターを受け取ります。 |
戻り値
メソッドが成功した場合は S_OK を返します。失敗した場合、返される可能性のあるコードには次の表に示す値が含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メモリ不足です。 |
解説(Remarks)
無効化された AGC コントロールはパススルーモードで動作します。このモードでは、オーディオストリームはコントロールを変更なしで通過します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
出力引数:
#define global IID_IAudioAutoGainControl "{85401FD4-6DE4-4B9D-9869-2D6753A82F3C}" #usecom global IAudioAutoGainControl IID_IAudioAutoGainControl "{}" #comfunc global IAudioAutoGainControl_GetEnabled 3 var #comfunc global IAudioAutoGainControl_SetEnabled 4 int,var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IAudioAutoGainControl "{85401FD4-6DE4-4B9D-9869-2D6753A82F3C}" #usecom global IAudioAutoGainControl IID_IAudioAutoGainControl "{}" #comfunc global IAudioAutoGainControl_GetEnabled 3 sptr #comfunc global IAudioAutoGainControl_SetEnabled 4 int,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。