Edit

CBaseInputPin.CheckStreaming method

  • Article

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Determines whether the pin can accept samples.

Syntax

virtual HRESULT CheckStreaming();

Parameters

This method has no parameters.

Return value

Returns one of the HRESULT values listed in the following table.

Return code Description
S_OK
 Success.
S_FALSE
 Pin is currently flushing.
VFW_E_RUNTIME_ERROR
 A run-time error occurred.
VFW_E_WRONG_STATE
 The pin is stopped.

Remarks

The derived class can override this method to perform further checks. In the overriding method, also call the base class implementation.

The CBaseInputPin::Receive method calls this method. You should override the CBasePin::EndOfStream method to call this method as well.

Requirements

Requirement Value
Header
Amfilter.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CBaseInputPin Class