ホーム › Media.DirectShow › IFileSinkFilter

IFileSinkFilter

COM

📘 Microsoft Learn (日本語) · English

IIDa2104830-7c70-11cf-8bce-00aa00a3f1a6継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IFileSinkFilter インターフェースは、メディアストリームをファイルに書き込むフィルターに実装されます。

解説(Remarks)

IFileSinkFilter2 インターフェースは IFileSinkFilter を拡張します。

メソッド 2

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

vtbl 3 HRESULT SetFileName(LPWSTR pszFileName, AM_MEDIA_TYPE* pmt)

SetFileName メソッドは、メディアサンプルの書き込み先となるファイルの名前を設定します。

pszFileName	LPWSTR	in	メディアサンプルを受け取るファイルの名前へのポインター。
pmt	AM_MEDIA_TYPE*	inoptional	ファイルに書き込むメディアサンプルの型、およびシンクフィルターの入力ピンのメディア型へのポインター。

戻り値

HRESULT 値を返します。

解説(Remarks)

pszFileName パラメーターが存在しないファイルを指定している場合、そのファイルが作成されます。既存のファイルを指定している場合、シンクフィルターはそのファイルを最初に削除せずに上書きします。

vtbl 4 HRESULT GetCurFile(LPWSTR* ppszFileName, AM_MEDIA_TYPE* pmt)

GetCurFile メソッドは、現在のファイルの名前とメディア型を取得します。(IFileSinkFilter.GetCurFile)

ppszFileName	LPWSTR*	out	ファイルの名前を OLESTR 型として受け取るポインターのアドレス。
pmt	AM_MEDIA_TYPE*	out	メディア型を受け取る AM_MEDIA_TYPE 構造体へのポインター。このパラメーターは NULL にすることができ、その場合メソッドはメディア型を返しません。

戻り値

HRESULT 値を返します。取り得る値には次のものが含まれます。

戻り値	説明
S_OK	成功。
E_FAIL	ファイルが開かれていません。
E_OUTOFMEMORY	メモリが不足しています。
E_POINTER	ppszFileName に NULL ポインター引数が渡されました。

解説(Remarks)

フィルターがファイルを開いていない場合、メソッドは成功しても ppszFileName パラメーターに NULL を返すことがあります。メソッドが戻った際には値を確認してください。

メソッドは、ppszFileName で返される文字列用のメモリと、メディア型内のフォーマットブロック(存在する場合)用のメモリを割り当てます。呼び出し元は CoTaskMemFree を呼び出してこれらを解放する必要があります。メディア型については、基底クラスライブラリの FreeMediaType 関数を使用できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFileSinkFilter "{A2104830-7C70-11CF-8BCE-00AA00A3F1A6}"
#usecom global IFileSinkFilter IID_IFileSinkFilter "{}"
#comfunc global IFileSinkFilter_SetFileName  3 wstr,var
#comfunc global IFileSinkFilter_GetCurFile   4 var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IFileSinkFilter "{A2104830-7C70-11CF-8BCE-00AA00A3F1A6}"
#usecom global IFileSinkFilter IID_IFileSinkFilter "{}"
#comfunc global IFileSinkFilter_SetFileName  3 wstr,sptr
#comfunc global IFileSinkFilter_GetCurFile   4 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。