Microsoft Windows CE 3.0  

IMediaSample::SetPreroll

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

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

HRESULT SetPreroll(
BOOL
bIsPreroll
);

Parameters

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

Return Values

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

E_FAIL Failure.
E_POINTER Null pointer argument.
E_INVALIDARG Invalid argument.
E_NOTIMPL Method isn't 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 SetPrerollwith a value of TRUE (1) sets the preroll property, calling IsPrerollon a preroll sample returns S_OK (0).