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

IMFMediaEventGenerator

COM
IID2cd0bd52-bcd5-4b89-b62c-eadc0c031e7d継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

イベントを生成する任意の Media Foundation オブジェクトからイベントを取得します。

解説(Remarks)

このインターフェイスをサポートするオブジェクトは、イベントのキューを保持します。オブジェクトのクライアントは、イベントを同期的にも非同期的にも取得できます。同期メソッドは GetEvent です。非同期メソッドは BeginGetEventEndGetEvent です。

メソッド 4

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

vtbl 3 HRESULT GetEvent(MEDIA_EVENT_GENERATOR_GET_EVENT_FLAGS dwFlags, IMFMediaEvent** ppEvent)

キュー内の次のイベントを取得します。このメソッドは同期的です。

dwFlagsMEDIA_EVENT_GENERATOR_GET_EVENT_FLAGSin

次のいずれかの値を指定します。

意味
0
イベントジェネレーターがイベントをキューに登録するまで、このメソッドはブロックします。
MF_EVENT_FLAG_NO_WAIT
このメソッドは直ちに戻ります。
ppEventIMFMediaEvent**outIMFMediaEvent インターフェイスへのポインターを受け取ります。呼び出し元はこのインターフェイスを解放する必要があります。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_INVALIDARG
NULL ポインター引数です。
MF_E_MULTIPLE_SUBSCRIBERS
保留中の要求があります。
MF_E_NO_EVENTS_AVAILABLE
キューにイベントがありません。
MF_E_SHUTDOWN
オブジェクトはシャットダウンされました。

解説(Remarks)

このメソッドは同期的に実行されます。

キューに既にイベントが含まれている場合、このメソッドは直ちに S_OK を返します。キューにイベントが含まれていない場合の動作は、dwFlags の値によって異なります。

以前に IMFMediaEventGenerator::BeginGetEvent を呼び出し、まだ IMFMediaEventGenerator::EndGetEvent を呼び出していない場合、このメソッドは MF_E_MULTIPLE_SUBSCRIBERS を返します。
vtbl 4 HRESULT BeginGetEvent(IMFAsyncCallback* pCallback, IUnknown* punkState)

キュー内の次のイベントに対する非同期要求を開始します。

pCallbackIMFAsyncCallback*inコールバックオブジェクトの IMFAsyncCallback インターフェイスへのポインター。クライアントはこのインターフェイスを実装する必要があります。
punkStateIUnknown*in呼び出し元が定義する状態オブジェクトの IUnknown インターフェイスへのポインター。このパラメーターは NULL にできます。このオブジェクトを使用して状態情報を保持できます。コールバックが呼び出されるときに、このオブジェクトが呼び出し元に返されます。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_INVALIDARG
NULL ポインター引数です。
MF_E_MULTIPLE_BEGIN
同じコールバックポインターと異なる状態オブジェクトを持つ保留中の要求があります。
MF_E_MULTIPLE_SUBSCRIBERS
異なるコールバックポインターを持つ保留中の要求があります。
MF_E_SHUTDOWN
オブジェクトはシャットダウンされました。
MF_S_MULTIPLE_BEGIN
同じコールバックポインターと状態オブジェクトを持つ保留中の要求があります。

解説(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;
}
vtbl 5 HRESULT EndGetEvent(IMFAsyncResult* pResult, IMFMediaEvent** ppEvent)

キュー内の次のイベントに対する非同期要求を完了します。

pResultIMFAsyncResult*inIMFAsyncResult インターフェイスへのポインター。コールバックオブジェクトが Invoke メソッドで受け取ったものと同じポインターを渡します。
ppEventIMFMediaEvent**outIMFMediaEvent インターフェイスへのポインターを受け取ります。呼び出し元はこのインターフェイスを解放する必要があります。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
MF_E_SHUTDOWN
オブジェクトはシャットダウンされました。

解説(Remarks)

このメソッドは、アプリケーションの IMFAsyncCallback::Invoke メソッド内から呼び出します。コード例については、IMFMediaEventGenerator::BeginGetEvent を参照してください。

vtbl 6 HRESULT QueueEvent(DWORD met, GUID* guidExtendedType, HRESULT hrStatus, PROPVARIANT* pvValue)

オブジェクトのキューに新しいイベントを登録します。

metDWORDinイベントの種類を指定します。イベントの種類は、イベントの IMFMediaEvent::GetType メソッドによって返されます。イベントの種類の一覧については、Media Foundation Events を参照してください。
guidExtendedTypeGUID*in拡張型。イベントに拡張型がない場合は、値 GUID_NULL を使用します。拡張型は、イベントの IMFMediaEvent::GetExtendedType メソッドによって返されます。
hrStatusHRESULTinイベントの状態を示す成功または失敗のコード。この値は、イベントの IMFMediaEvent::GetStatus メソッドによって返されます。
pvValuePROPVARIANT*inイベント値を含む PROPVARIANT へのポインター。このパラメーターは NULL にできます。この値は、イベントの IMFMediaEvent::GetValue メソッドによって返されます。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
MF_E_SHUTDOWN
オブジェクトはシャットダウンされました。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_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 指定が可能。