ホーム › Media.MediaFoundation › IMFTimer

IMFTimer

COM

📘 Microsoft Learn (日本語) · English

IIDe56e4cbd-8f70-49d8-a0f8-edb3d6ab9bf2継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

指定した時刻にコールバックを呼び出すタイマーを提供します。

解説(Remarks)

プレゼンテーションクロックがこのインターフェイスを公開します。このインターフェイスへのポインターを取得するには、QueryInterface を呼び出します。

メソッド 2

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

vtbl 3 HRESULT SetTimer(DWORD dwFlags, LONGLONG llClockTime, IMFAsyncCallback* pCallback, IUnknown* punkState, IUnknown** ppunkKey)

指定した時刻にコールバックを呼び出すタイマーを設定します。

dwFlags	DWORD	in	MFTIMER_FLAGS 列挙体の 0 個以上のフラグのビットごとの OR です。
llClockTime	LONGLONG	in	タイマーを発火させる時刻を、クロックの周波数を単位として指定します。この時刻は、dwFlags の値に応じて、絶対時刻または現在時刻からの相対時刻のいずれかになります。
pCallback	IMFAsyncCallback*	in	コールバックオブジェクトの IMFAsyncCallback インターフェイスへのポインターです。呼び出し側がこのインターフェイスを実装する必要があります。コールバックの Invoke メソッドは、llClockTime パラメーターで指定した時刻に呼び出されます。
punkState	IUnknown*	in	呼び出し側が定義する状態オブジェクトの IUnknown インターフェイスへのポインターです。このパラメーターは NULL でもかまいません。このオブジェクトを使用して状態情報を保持できます。オブジェクトは、コールバックが呼び出されたときに呼び出し側へ返されます。
ppunkKey	IUnknown**	out	キャンセルオブジェクトの IUnknown インターフェイスへのポインターを受け取ります。呼び出し側はこのインターフェイスを解放する必要があります。タイマーをキャンセルするには、このポインターを IMFTimer::CancelTimer メソッドに渡します。このパラメーターは NULL でもかまいません。

戻り値

このメソッドは HRESULT を返します。取り得る値には、以下の表に示すものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドが成功しました。
MF_E_SHUTDOWN	クロックがシャットダウンされました。
MF_S_CLOCK_STOPPED	メソッドは成功しましたが、クロックは停止しています。

解説(Remarks)

クロックが停止している場合、このメソッドは MF_S_CLOCK_STOPPED を返します。コールバックは、クロックが開始されるまで呼び出されません。

vtbl 4 HRESULT CancelTimer(IUnknown* punkKey)

IMFTimer::SetTimer メソッドで設定したタイマーをキャンセルします。

punkKey

IUnknown*

SetTimer メソッドの ppunkKey パラメーターで返された IUnknown インターフェイスへのポインターです。

戻り値

このメソッドは HRESULT を返します。取り得る値には、以下の表に示すものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドが成功しました。

解説(Remarks)

タイマーは非同期にディスパッチされるため、このメソッドが成功した場合でも、アプリケーションのタイマーコールバックが呼び出されることがあります。

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