Edit

CMediaSample.SetPreroll 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.]

The SetPreroll method specifies whether this sample is a preroll sample. A preroll sample should not be displayed. This method implements the IMediaSample::SetPreroll method.

Syntax

HRESULT SetPreroll(
   BOOL bIsPreroll
);

Parameters

bIsPreroll

Boolean value that specifies whether this is a preroll sample. If TRUE, this is a preroll sample.

Return value

Returns S_OK.

Remarks

This method updates the CMediaSample::m_dwFlags member variable, which specifies the preroll property.

Requirements

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

See also

CMediaSample Class