IMediaSample::IsPreroll method (strmif.h)

[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 IsPreroll method determines if this sample is a preroll sample. A preroll sample should not be displayed.

Syntax

HRESULT IsPreroll();

Return value

Returns S_OK if the sample is a preroll sample. Otherwise, returns S_FALSE.

Remarks

Preroll samples are processed but not displayed. They are located in the media stream before the displayable samples.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header strmif.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IMediaSample Interface