CTransformInputPin.EndOfStream method

[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.]

The EndOfStream method notifies the pin that no additional data is expected. This method implements the IPin::EndOfStream method.

Syntax

HRESULT EndOfStream();

Parameters

This method has no parameters.

Return value

Returns an HRESULT value. Possible values include those shown in the following table.

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

Remarks

This method calls the filter's CTransformFilter::EndOfStream method to deliver the end-of-stream notification downstream.

Requirements

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