IMediaSample::SetPreroll (Compact 2013)

  • Article

3/26/2014

This method sets the preroll property. If TRUE, this sample is for preroll only and should not be displayed.

Syntax

HRESULT SetPreroll(
  BOOL bIsPreroll
);

Parameters

  • bIsPreroll
    [in] Set to TRUE to specify the media sample as a preroll sample; otherwise, set to FALSE.

Return Value

Returns an HRESULT value that depends on the implementation. HRESULT can be one of the following standard constants, or other values not listed.

Value

Description

E_FAIL

Failure.

E_POINTER

Null pointer argument.

E_INVALIDARG

Invalid argument.

E_NOTIMPL

Method is not supported.

S_OK or NOERROR

Success.

Remarks

Preroll samples are samples that are processed but not displayed, and are located in the media stream before the displayable samples.

While calling SetPreroll with a value of TRUE (1) sets the preroll property, calling IsPreroll on a preroll sample returns S_OK (0).

Requirements

Header

dshow.h

Library

Strmiids.lib

See Also

Reference

IMediaSample Interface