Win32 API 日本語リファレンス
ホームMedia.DirectShow › IVideoFrameStep

IVideoFrameStep

COM
IIDe46a9787-2b71-444d-a4b5-1fab7b708d6a継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IVideoFrameStep インターフェイスは、ビデオ ストリームをフレーム単位で送ります。

メソッド 3

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

vtbl 3 HRESULT Step(DWORD dwFrames, IUnknown* pStepObject)

Step メソッドは、フィルター グラフを指定したフレーム数だけ前方に進めます。

dwFramesDWORDinスキップするフレーム数を指定します。dwFrames が 1 の場合、グラフは 1 フレーム前方に進みます。dwFrames が 1 より大きい数値 n の場合、グラフは n - 1 フレームをスキップして n 番目のフレームを表示します。
pStepObjectIUnknown*inoptionalステップ操作を制御するフィルター上のインターフェイスへのポインター、または NULL。グラフ内のレンダラー フィルターを使用してフレーム ステップを実行するには NULL を指定します。NULL 以外の場合、そのオブジェクトは IKsPropertySet インターフェイスを実装し、AM_KSPROPSETID_FrameStep プロパティをサポートしている必要があります (詳細については、Frame Stepping Property Set を参照してください)。グラフにフレーム ステップを実装するカスタム フィルターが含まれている場合、pStepObject にそのフィルターへのポインターを指定できます。

戻り値

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

リターン コード 説明
S_OK
成功しました。
VFW_E_FRAME_STEP_UNSUPPORTED
フレーム ステップはサポートされていません。
E_INVALIDARG
pStepObject パラメーターが無効です。

解説(Remarks)

ステップ操作が完了すると、このメソッドは EC_STEP_COMPLETE イベント通知をフィルター グラフ マネージャーに送信します。フィルター グラフ マネージャーはこれをアプリケーションのイベント ループに渡し、フィルター グラフを一時停止状態に設定します。

フレームはリアルタイムでステップされます。つまり、ムービーが 1 秒あたり 30 フレームで再生されている場合、dwFrames を 60 に設定して IVideoFrameStep::Step を呼び出すと実行に 2 秒かかります。このインターフェイスのすべてのメソッドは非同期であるため、制御はただちにアプリケーションに戻ります。

vtbl 4 HRESULT CanStep(INT bMultiple, IUnknown* pStepObject)

CanStep メソッドは、指定したフィルターのステップ機能を判定します。

bMultipleINTinbMultiple が 0 でメソッドが S_OK を返す場合、グラフは 1 度に 1 フレームずつステップできます。bMultiple が 0 より大きくメソッドが S_OK を返す場合、グラフは 1 度に bMultiple フレームずつステップできます。
pStepObjectIUnknown*inoptionalステップ操作を制御するフィルター上のインターフェイスへのポインター。グラフ内のレンダラー フィルターを使用してフレーム ステップを実行するには NULL を指定します。グラフにフレーム ステップを実装するカスタム フィルターが含まれている場合、pStepObject にはそのフィルターの IBaseFilter インターフェイスを指定してください。

戻り値

オブジェクトがステップできる場合は S_OK を、pStepObject が無効な場合は E_INVALIDARG を返します。

vtbl 5 HRESULT CancelStep()

CancelStep メソッドは、直前の IVideoFrameStep::Step 操作をキャンセルします。

戻り値

Step 操作が正常にキャンセルされた場合は S_OK を、それ以外の場合は E_FAIL を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IVideoFrameStep "{E46A9787-2B71-444D-A4B5-1FAB7B708D6A}"
#usecom global IVideoFrameStep IID_IVideoFrameStep "{}"
#comfunc global IVideoFrameStep_Step        3 int,sptr
#comfunc global IVideoFrameStep_CanStep     4 int,sptr
#comfunc global IVideoFrameStep_CancelStep  5
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。