IBroadcastEvent インターフェイス

[アーティクル]
04/22/2010

このトピックは Windows XP にのみ適用。

IBroadcastEvent インターフェイスは、オブジェクトが直接接続ポイントを設定せずに別のオブジェクトからイベントを受信できるようにする。アプリケーションは、通常このインターフェイスを使う必要はない。

IUnknown から継承したメソッドに加えて、IBroadcastEvent インターフェイスは次のメソッドを公開する。

メソッド	説明
Fire	イベントを発生させる。

注意

ブロードキャストイベントによって、DirectShow フィルタ、ビデオコントロールの機能、ビデオコントロールデバイスオブジェクトの間で通信が可能になる。ブロードキャストイベントを送信するために、オブジェクトはブロードキャストイベントサービスオブジェクトの IBroadcastEvent::Fire を呼び出す。他のオブジェクトは、ブロードキャストイベントサービスオブジェクトとの接続ポイントを設定することによってイベントの発生を待機できる。リスナは IBroadcastEvent を実装し、新しいブロードキャストイベントが発生するたびに、ブロードキャストイベントサービスオブジェクトはリスナの Fire メソッドを呼び出す。

ブロードキャストイベントは次のような理由で便利である。

DirectShow のイベントメカニズムである IMediaEventSink は、複数のリスナをサポートしていない。DirectShow イベントはキューに入れられ、イベントを取得するとキューから削除される。
COM 接続ポイントは、ソースオブジェクトを特定するシンクオブジェクトを必要とする。ブロードキャストイベントを使うと、ブロードキャストイベントサービスはソースオブジェクトとシンクオブジェクトとの中継点として機能する。
接続ポイントでは、ソースは、シンクが接続を確立するために使ったスレッドと同じスレッドでイベントを発生させるか、またはイベントインターフェイスポインタをマーシャリングする必要がある。フィルタグラフはマルチスレッド化されているので、ブロードキャストイベントサービスオブジェクトは必要なマーシャリングを実装している。ブロードキャストイベントサービスオブジェクトは、バックグラウンドスレッドを使って、登録されているすべてのリスナにイベントを配信する。

IBroadcastEvent インターフェイスはサービスであり、フィルタグラフマネージャの IServiceProvider インターフェイスを介して取得できる。そのためには、IServiceProvider::QueryService を呼び出して、次の値を指定する。

サービス識別子 :SID_SBroadcastEventService
インターフェイス識別子 :IID_IBroadcastEvent

QueryService の失敗コードは、オブジェクトがフィルタグラフマネージャにブロードキャストイベントサービスオブジェクトを登録していないことを示す。この場合は、次の作業を行う。

CoCreateInstance を使って、新しいブロードキャストイベントサービスオブジェクトを作成する。
フィルタグラフマネージャに IRegisterServiceProvider を照会する。
サービス識別子を指定して IRegisterServiceProvider::RegisterService を呼び出す。

IBroadcastEvent インターフェイスへのポインタを取得したら、そのポインタを使ってイベントを送信するか、イベントをシンクすることができる。イベントを送信するには、Fire メソッドを呼び出す。イベントをシンクするには、シンクオブジェクトに IBroadcastEvent を実装し、ブロードキャストイベントサービスに IConnectionPoint を照会し、IConnectionPoint::Advise を呼び出して接続を確立する。定義済みのブロードキャストイベントの一覧については、「IBroadcastEvent::Fire」を参照すること。

サンプルコード

次の例では、ブロードキャストイベントを送信またはシンクできるクラスを実装する。

class TunerEvent : public IBroadcastEvent
{

private:
    long m_nRefCount; // 参照カウントを保持する。
public:
    // IUnknown メソッド
    STDMETHODIMP_(ULONG) AddRef()
    {
        return InterlockedIncrement(&m_nRefCount);
    }
    STDMETHODIMP_(ULONG) Release()
    {
        _ASSERT(m_nRefCount >= 0);
        ULONG uCount = InterlockedDecrement(&m_nRefCount);
        if (uCount == 0)
        {
            delete this;
        }
        // スレッド セーフのために、メンバ変数ではなく、
        // 一時変数を返す。
        return uCount;
    }
    STDMETHODIMP QueryInterface(REFIID riid, void **ppvObject)
    {
        if (NULL == ppvObject)
            return E_POINTER;
        if (riid == __uuidof(IUnknown))
            *ppvObject = static_cast<IUnknown*>(this);
        else if (riid == __uuidof(IBroadcastEvent))
            *ppvObject = static_cast<IBroadcastEvent*>(this);
        else 
            return E_NOINTERFACE;
        AddRef();
        return S_OK;
    }

    // IBroadcastEvent メソッド
    STDMETHOD(Fire)(GUID eventID)
    {
        // イベントを定義した
        if (eventID == EVENTID_TuningChanged)
        {
            // チューナーが局またはチャンネルを変更した。
        }
        
        return S_OK;
    }

    TunerEvent() : m_dwBroadcastEventCookie(0), m_nRefCount(1) {};

private:
    HRESULT HookupGraphEventService(IFilterGraph *pGraph);
    HRESULT RegisterForTunerEvents();
    HRESULT UnRegisterForTunerEvents();
    HRESULT Fire_Event(GUID eventID);

    CComPtr<IBroadcastEvent>   m_spBroadcastEvent; 
    DWORD m_dwBroadcastEventCookie;
};

// フィルタ グラフ マネージャにブロードキャスト イベント サービスを問い合わせる。
// 見つからない場合は、ブロードキャスト イベント サービスを作成して登録する。
HRESULT TunerEvent::HookupGraphEventService(IFilterGraph *pGraph)
{
    HRESULT hr = S_OK;
    if (!m_spBroadcastEvent)
    {
        CComQIPtr<IServiceProvider> spServiceProvider(pGraph);
        if (!spServiceProvider)
        {
            return E_NOINTERFACE;
        }
        hr = spServiceProvider->QueryService(SID_SBroadcastEventService, 
            IID_IBroadcastEvent, 
            reinterpret_cast<void**>(&m_spBroadcastEvent));
        if (FAILED(hr))
        {
            // ブロードキャスト イベント サービス オブジェクトを作成する。
            hr = m_spBroadcastEvent.CoCreateInstance(
                CLSID_BroadcastEventService,
                NULL, CLSCTX_INPROC_SERVER);
            if (FAILED(hr))
            {
                return hr; 
            }
            
            CComQIPtr<IRegisterServiceProvider> spRegService(pGraph);
            if (!spRegService)
            {
                return E_NOINTERFACE;
            }
            
            // ブロードキャスト イベント サービス オブジェクトをサービスとして登録する。
            hr = spRegService->RegisterService(
                SID_SBroadcastEventService,
                m_spBroadcastEvent);
        }
    }
    return hr;
}

// イベントを受信するための接続ポイントを確立する。
HRESULT TunerEvent::RegisterForTunerEvents()
{
    if (!m_spBroadcastEvent)
    {
        return E_FAIL;  // HookupGraphEventService の呼び出しを忘れた。
    }
    if(m_dwBroadcastEventCookie)
    {
        return S_FALSE;  // 既に接続が存在する場合は、何もしない。
    }
    CComQIPtr<IConnectionPoint> spConnectionPoint(m_spBroadcastEvent);
    if(!spConnectionPoint)
    {
        return E_NOINTERFACE;
    }
    return spConnectionPoint->Advise(static_cast<IBroadcastEvent*>(this),
        &m_dwBroadcastEventCookie);
}

// イベント用に登録を解除する。
HRESULT TunerEvent::UnRegisterForTunerEvents()
{
    HRESULT hr = S_OK;
    if(!m_dwBroadcastEventCookie)
    {
        return S_OK; // イベント用に登録されていない場合は、何もしない。
    }
    CComQIPtr<IConnectionPoint> spConnectionPoint(m_spBroadcastEvent);
    if(!spConnectionPoint)
    {
        return E_NOINTERFACE;
    }
    
    // 接続ポイントを解放する。
    hr = spConnectionPoint->Unadvise(m_dwBroadcastEventCookie);
    if (FAILED(hr))
    {
        // エラー : 接続ポイントのアドバイズを解除できない。
        return hr;
    }
    m_dwBroadcastEventCookie = 0;
    m_spBroadcastEvent.Release();
    return S_OK;
}

// ソース オブジェクトのイベントを送信する。
HRESULT TunerEvent::Fire_Event(GUID eventID)
{
    if (!m_spBroadcastEvent)
    {
        return E_FAIL; // HookupGraphEventService の呼び出しを忘れた。
    }
    return m_spBroadcastEvent->Fire(eventID);
}

次の方法で共有

IBroadcastEvent インターフェイス

その他のリソース