IltmmMediaSampleDisp::get_Preroll

#include "ltmm.h"

C Syntax

HRESULT IltmmMediaSampleDisp__get_Preroll(pMediaSampleDisp, pVal)

C++ Syntax

HRESULT get_Preroll(pVal)

 

IltmmMediaSampleDisp *pMediaSampleDisp;

/* pointer to an interface */

VARIANT_BOOL *pVal;

/* pointer to a variable */

Determines if this sample is a preroll sample. A preroll sample should not be displayed.

Parameter

Description

pMediaSampleDisp

Pointer to an IltmmMediaSampleDisp interface.

pVal

Pointer to a variable to be updated with a value that indicates whether the sample is a preroll sample. Possible values are:

 

Value

Meaning

 

VARIANT_TRUE

The sample is a preroll sample.

 

VARIANT_FALSE

The sample is not a preroll sample.

Returns

S_OK

The function was successful.

<> S_OK

An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

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

Required DLLs and Libraries

LTMM

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

IltmmMediaSampleDisp::get_ActualDataLength, IltmmMediaSampleDisp::get_Buffer, IltmmMediaSampleDisp::get_BufferSize, IltmmMediaSampleDisp::get_Discontinuity, IltmmMediaSampleDisp::get_SyncPoint, IltmmMediaSampleDisp::GetData, IltmmMediaSampleDisp::GetMediaTime, IltmmMediaSampleDisp::GetMediaType, IltmmMediaSampleDisp::GetTime, IltmmMediaSampleDisp::put_ActualDataLength, IltmmMediaSampleDisp::put_Discontinuity, IltmmMediaSampleDisp::put_Preroll, IltmmMediaSampleDisp::put_SyncPoint, IltmmMediaSampleDisp::ResetMediaTime, IltmmMediaSampleDisp::ResetTime, IltmmMediaSampleDisp::SetData, IltmmMediaSampleDisp::SetMediaTime, IltmmMediaSampleDisp::SetMediaType, IltmmMediaSampleDisp::SetTime

Topics:

Multimedia Function Group

 

IltmmMediaSampleDisp interface

 

ltmmMediaSample object

Example

For a C example, refer to Copying ltmmMediaSample attributes and data for C.

For a C++ example, refer to Copying ltmmMediaSample attributes and data for C++.