CBaseRenderer.SetAbortSignal 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 SetAbortSignal method sets a flag which indicates whether to stop rendering and reject further samples.

Syntax

void SetAbortSignal(
   BOOL bAbort
);

Parameters

bAbort

Boolean value indicating whether to stop rendering. If TRUE, the filter will not render any more samples.

Return value

This method does not return a value.

Remarks

This method sets the CBaseRenderer::m_bAbort flag.

Requirements

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

See also

CBaseRenderer Class