ホーム › Media.DirectShow › IAMOverlayFX

IAMOverlayFX

COM

📘 Microsoft Learn (日本語) · English

IID62fae250-7e65-4460-bfc9-6398b322073c継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IAMOverlayFX インターフェースは、ビデオオーバーレイがユーザーの画面上でどのように表示されるかを制御します。このインターフェースは Overlay Mixer フィルターによって実装されます。

メソッド 3

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

vtbl 3 HRESULT QueryOverlayFXCaps(DWORD* lpdwOverlayFXCaps)

QueryOverlayFXCaps メソッドは、Overlay Mixer フィルターで利用可能なオーバーレイ効果に関する情報を取得します。

lpdwOverlayFXCaps

DWORD*

out

オーバーレイサーフェスのオーバーレイ効果に関する機能を示す値を受け取る変数へのポインター。値は AMOVERLAYFX 列挙型のフラグの論理的な組み合わせです。

戻り値

インターフェースの実装に依存する HRESULT 値を返します。DirectShow の実装では、次のいずれかの値を返します。

戻り値	説明
E_FAIL	失敗。
E_POINTER	NULL ポインター引数。
S_OK	成功。

vtbl 4 HRESULT SetOverlayFX(DWORD dwOverlayFX)

SetOverlayFX メソッドは、指定された効果をオーバーレイサーフェスに適用します。

dwOverlayFX

DWORD

どの効果を適用するかを指定する値。この値は AMOVERLAYFX 列挙型のフラグの論理的な組み合わせでなければなりません。そうでない場合、このメソッドは E_INVALIDARG を返します。

戻り値

インターフェースの実装に依存する HRESULT 値を返します。DirectShow の実装では、次のいずれかの値、または一覧にないその他の値を返すことがあります。

戻り値	説明
E_FAIL	失敗。
E_INVALIDARG	無効な引数。
S_OK	成功。

解説(Remarks)

アプリケーションは、フィルターグラフが実行されている間にこのメソッドを呼び出す必要があります。効果は即座に適用されます。

vtbl 5 HRESULT GetOverlayFX(DWORD* lpdwOverlayFX)

GetOverlayFX メソッドは、現在オーバーレイサーフェスに適用されている効果があれば、それを取得します。アプリケーションは、フィルターグラフが実行されている間にこのメソッドを呼び出すことができます。

lpdwOverlayFX

DWORD*

out

現在オーバーレイサーフェスに適用されている効果があれば、それがどの効果であるかを示す値を受け取る変数へのポインター。値は AMOVERLAYFX 列挙型のフラグの論理的な組み合わせです。

戻り値

インターフェースの実装に依存する HRESULT 値を返します。DirectShow の実装では、成功した場合は S_OK を返し、NULL ポインター引数を示す場合は E_POINTER を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IAMOverlayFX "{62FAE250-7E65-4460-BFC9-6398B322073C}"
#usecom global IAMOverlayFX IID_IAMOverlayFX "{}"
#comfunc global IAMOverlayFX_QueryOverlayFXCaps  3 var
#comfunc global IAMOverlayFX_SetOverlayFX        4 int
#comfunc global IAMOverlayFX_GetOverlayFX        5 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IAMOverlayFX "{62FAE250-7E65-4460-BFC9-6398B322073C}"
#usecom global IAMOverlayFX IID_IAMOverlayFX "{}"
#comfunc global IAMOverlayFX_QueryOverlayFXCaps  3 sptr
#comfunc global IAMOverlayFX_SetOverlayFX        4 int
#comfunc global IAMOverlayFX_GetOverlayFX        5 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。