IMFMediaEventGenerator
COM公式ドキュメント
イベントを生成する任意の Media Foundation オブジェクトからイベントを取得します。
解説(Remarks)
このインターフェイスをサポートするオブジェクトは、イベントのキューを保持します。オブジェクトのクライアントは、イベントを同期的にも非同期的にも取得できます。同期メソッドは GetEvent です。非同期メソッドは BeginGetEvent と EndGetEvent です。
メソッド 4
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
キュー内の次のイベントを取得します。このメソッドは同期的です。
| dwFlags | MEDIA_EVENT_GENERATOR_GET_EVENT_FLAGS | in | 次のいずれかの値を指定します。
| ||||||
| ppEvent | IMFMediaEvent** | out | IMFMediaEvent インターフェイスへのポインターを受け取ります。呼び出し元はこのインターフェイスを解放する必要があります。 |
戻り値
このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは成功しました。 | |
| NULL ポインター引数です。 | |
| 保留中の要求があります。 | |
| キューにイベントがありません。 | |
| オブジェクトはシャットダウンされました。 |
解説(Remarks)
このメソッドは同期的に実行されます。
キューに既にイベントが含まれている場合、このメソッドは直ちに S_OK を返します。キューにイベントが含まれていない場合の動作は、dwFlags の値によって異なります。
- dwFlags が 0 の場合、このメソッドは新しいイベントがキューに登録されるか、またはイベントジェネレーターがシャットダウンされるまで、無期限にブロックします。
- dwFlags が MF_EVENT_FLAG_NO_WAIT の場合、このメソッドは戻り値 MF_E_NO_EVENTS_AVAILABLE で直ちに失敗します。
キュー内の次のイベントに対する非同期要求を開始します。
| pCallback | IMFAsyncCallback* | in | コールバックオブジェクトの IMFAsyncCallback インターフェイスへのポインター。クライアントはこのインターフェイスを実装する必要があります。 |
| punkState | IUnknown* | in | 呼び出し元が定義する状態オブジェクトの IUnknown インターフェイスへのポインター。このパラメーターは NULL にできます。このオブジェクトを使用して状態情報を保持できます。コールバックが呼び出されるときに、このオブジェクトが呼び出し元に返されます。 |
戻り値
このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは成功しました。 | |
| NULL ポインター引数です。 | |
| 同じコールバックポインターと異なる状態オブジェクトを持つ保留中の要求があります。 | |
| 異なるコールバックポインターを持つ保留中の要求があります。 | |
| オブジェクトはシャットダウンされました。 | |
| 同じコールバックポインターと状態オブジェクトを持つ保留中の要求があります。 |
解説(Remarks)
新しいイベントが利用可能になると、イベントジェネレーターは IMFAsyncCallback::Invoke メソッドを呼び出します。Invoke メソッドは IMFMediaEventGenerator::EndGetEvent を呼び出して IMFMediaEvent インターフェイスへのポインターを取得し、そのインターフェイスを使用してイベントを調べる必要があります。
EndGetEvent を呼び出す前に、BeginGetEvent を 2 回目に呼び出さないでください。最初の呼び出しがまだ保留中の間は、同じオブジェクトに対する追加の呼び出しは失敗します。また、非同期要求がまだ保留中の場合、IMFMediaEventGenerator::GetEvent メソッドも失敗します。
例
次のコードは、BeginGetEvent メソッドに対する IMFAsyncCallback::Invoke の典型的な実装を示しています。Invoke メソッドは EndGetEvent を呼び出してイベントデータを取得します。その後、再び BeginGetEvent を呼び出して別のイベントを要求します。
//////////////////////////////////////////////////////////////////////
// Name: CEventHandler::Invoke
// Callback for asynchronous BeginGetEvent method.
//
// pAsyncResult: Pointer to the result.
//
// This code example assumes that CEventHandler is a class that
// implements the IMFAsyncCallback interface.
///////////////////////////////////////////////////////////////////////
HRESULT CEventHandler::Invoke(IMFAsyncResult *pAsyncResult)
{
HRESULT hr = S_OK;
IMFMediaEvent* pEvent = NULL;
MediaEventType meType = MEUnknown;
BOOL fGetAnotherEvent = TRUE;
HRESULT hrStatus = S_OK;
// Get the event from the event queue.
// Assume that m_pEventGenerator is a valid pointer to the
// event generator's IMFMediaEventGenerator interface.
hr = m_pEventGenerator->EndGetEvent(pAsyncResult, &pEvent);
// Get the event type.
if (SUCCEEDED(hr))
{
hr = pEvent->GetType(&meType);
}
// Get the event status. If the operation that triggered the event
// did not succeed, the status is a failure code.
if (SUCCEEDED(hr))
{
hr = pEvent->GetStatus(&hrStatus);
}
if (SUCCEEDED(hr))
{
// TODO: Handle the event.
}
// If not finished, request another event.
// Pass in a pointer to this instance of the application's
// CEventHandler class, which implements the callback.
if (fGetAnotherEvent)
{
hr = m_pEventGenerator->BeginGetEvent(this, NULL);
}
SAFE_RELEASE(pEvent);
return hr;
}
キュー内の次のイベントに対する非同期要求を完了します。
| pResult | IMFAsyncResult* | in | IMFAsyncResult インターフェイスへのポインター。コールバックオブジェクトが Invoke メソッドで受け取ったものと同じポインターを渡します。 |
| ppEvent | IMFMediaEvent** | out | IMFMediaEvent インターフェイスへのポインターを受け取ります。呼び出し元はこのインターフェイスを解放する必要があります。 |
戻り値
このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは成功しました。 | |
| オブジェクトはシャットダウンされました。 |
解説(Remarks)
このメソッドは、アプリケーションの IMFAsyncCallback::Invoke メソッド内から呼び出します。コード例については、IMFMediaEventGenerator::BeginGetEvent を参照してください。
オブジェクトのキューに新しいイベントを登録します。
| met | DWORD | in | イベントの種類を指定します。イベントの種類は、イベントの IMFMediaEvent::GetType メソッドによって返されます。イベントの種類の一覧については、Media Foundation Events を参照してください。 |
| guidExtendedType | GUID* | in | 拡張型。イベントに拡張型がない場合は、値 GUID_NULL を使用します。拡張型は、イベントの IMFMediaEvent::GetExtendedType メソッドによって返されます。 |
| hrStatus | HRESULT | in | イベントの状態を示す成功または失敗のコード。この値は、イベントの IMFMediaEvent::GetStatus メソッドによって返されます。 |
| pvValue | PROPVARIANT* | in | イベント値を含む PROPVARIANT へのポインター。このパラメーターは NULL にできます。この値は、イベントの IMFMediaEvent::GetValue メソッドによって返されます。 |
戻り値
このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれますが、これらに限定されません。
| 戻り値 | 説明 |
|---|---|
| メソッドは成功しました。 | |
| オブジェクトはシャットダウンされました。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IMFMediaEventGenerator "{2CD0BD52-BCD5-4B89-B62C-EADC0C031E7D}" #usecom global IMFMediaEventGenerator IID_IMFMediaEventGenerator "{}" #comfunc global IMFMediaEventGenerator_GetEvent 3 int,sptr #comfunc global IMFMediaEventGenerator_BeginGetEvent 4 sptr,sptr #comfunc global IMFMediaEventGenerator_EndGetEvent 5 sptr,sptr #comfunc global IMFMediaEventGenerator_QueueEvent 6 int,var,int,var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IMFMediaEventGenerator "{2CD0BD52-BCD5-4B89-B62C-EADC0C031E7D}" #usecom global IMFMediaEventGenerator IID_IMFMediaEventGenerator "{}" #comfunc global IMFMediaEventGenerator_GetEvent 3 int,sptr #comfunc global IMFMediaEventGenerator_BeginGetEvent 4 sptr,sptr #comfunc global IMFMediaEventGenerator_EndGetEvent 5 sptr,sptr #comfunc global IMFMediaEventGenerator_QueueEvent 6 int,sptr,int,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。