IMediaFilter::GetState メソッド (strmif.h)

[このページに関連付けられている機能 DirectShow は、従来の機能です。 MediaPlayer、IMFMediaEngine、Media Foundation のオーディオ/ビデオ キャプチャに置き換わりました。 これらの機能は、Windows 10とWindows 11用に最適化されています。 新しいコードでは、可能であれば、DirectShow ではなく Media Foundation で MediaPlayerIMFMediaEngineAudio/Video Capture を使用することを強くお勧めします。 Microsoft は、レガシ API を使用する既存のコードを、可能であれば新しい API を使用するように書き換えるよう提案しています。]

GetState メソッドは、フィルターの状態 (実行中、停止、または一時停止) を取得します。

構文

HRESULT GetState(
  [in]  DWORD        dwMilliSecsTimeout,
  [out] FILTER_STATE *State
);

パラメーター

[in] dwMilliSecsTimeout

タイムアウト間隔 (ミリ秒単位)。 無期限にブロックするには、値 INFINITE を使用します。

[out] State

フィルターの状態を示す、 FILTER_STATE 列挙型のメンバーを受け取ります。

戻り値

HRESULT 値を返します。 次の表に示す値を指定できます。

リターン コード 説明
S_OK
成功しました。
E_POINTER
NULL ポインター引数。
VFW_S_STATE_INTERMEDIATE
中間状態。
VFW_S_CANT_CUE
フィルターはアクティブですが、データを配信できません。

解説

状態遷移は非同期にすることができます。 フィルターが新しい状態に遷移していて、遷移が完了する前にメソッドがタイムアウトした場合、メソッドは VFW_S_STATE_INTERMEDIATEを返します。

何らかの理由でフィルターがデータを配信できない場合は、 VFW_S_CANT_CUEが返されます。 ライブ キャプチャ フィルターは、一時停止状態のデータを配信しないため、一時停止中にこの値を返します。

詳細については、「フィルター グラフのData Flow」を参照してください。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー strmif.h (Dshow.h を含む)
Library Strmiids.lib

関連項目

エラーコードと成功コード

IBaseFilter

IMediaFilter インターフェイス