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

IAudioLfxControl

COM
📘 Microsoft Learn (日本語) · English
IID076a6922-d802-4f83-baf6-409d9ca11bfe継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IAudioLfxControl インターフェースは、クライアントがオフロードされたオーディオ ストリームに対してローカル エフェクトを適用または解除できるようにします。

メソッド 2

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

vtbl 3 HRESULT SetLocalEffectsState(BOOL bEnabled)

SetLocalEffectsState メソッドは、オフロードされたオーディオ ストリームに適用するローカル エフェクトの状態を設定します。

bEnabledBOOLinオフロードされたオーディオ ストリームに適用するローカル エフェクトの状態を示します。TRUE を指定するとローカル エフェクトが有効になり、オーディオ グラフ内のローカル エフェクトがストリームに適用されます。FALSE を指定するとローカル エフェクトが無効になり、オーディオ グラフ内のローカル エフェクトはオーディオ ストリームに適用されません。

戻り値

SetLocalEffectsState メソッドは、正常に完了した場合は S_OK を返します。それ以外の場合は、適切なエラー コードを返します。

vtbl 4 HRESULT GetLocalEffectsState(BOOL* pbEnabled)

GetLocalEffectsState メソッドは、オフロードされたオーディオ ストリームに現在適用されているローカル エフェクトの状態を取得します。

pbEnabledBOOL*outオフロードされたオーディオ ストリームに適用されているローカル エフェクトの状態を示す Boolean 変数へのポインターです。TRUE の場合、ローカル エフェクトが有効になっており、ストリームに適用されています。FALSE の場合、ローカル エフェクトは無効になっています。

戻り値

GetLocalEffectsState メソッドは、正常に完了した場合は S_OK を返します。それ以外の場合は、適切なエラー コードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IAudioLfxControl "{076A6922-D802-4F83-BAF6-409D9CA11BFE}"
#usecom global IAudioLfxControl IID_IAudioLfxControl "{}"
#comfunc global IAudioLfxControl_SetLocalEffectsState  3 int
#comfunc global IAudioLfxControl_GetLocalEffectsState  4 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。