CVideoTransformFilter.AbortPlayback 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 AbortPlayback method is used to signal a streaming error. It sends an EC_ERRORABORT event to the Filter Graph Manager, and sends an end-of-stream notification downstream.

Syntax

HRESULT AbortPlayback(
   HRESULT hr
);

Parameters

hr

HRESULT value of the operation that failed. This value is used as the first event parameter for the EC_ERRORABORT event.

Return value

Returns the value of the hr parameter.

Requirements

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

See also

CVideoTransformFilter Class