CMediaSample.GetMediaTime method

[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 GetMediaTime method retrieves the media times for this sample. This method implements the IMediaSample::GetMediaTime method.

Syntax

HRESULT GetMediaTime(
   LONGLONG *pStart,
   LONGLONG *pEnd
);

Parameters

pStart

Pointer to a variable that receives the media start time.

pEnd

Pointer to a variable that receives the media stop time.

Return value

Returns one of the HRESULT values shown in the following table.

Return code	Description
S_OK	Success.
VFW_E_MEDIA_TIME_NOT_SET	No media times were set for this sample.

Remarks

The CMediaSample::m_MediaEnd member variable specifies an offset from CMediaSample::m_MediaStart, but the value received by the pEnd parameter is an absolute media time, calculated as m_MediaStart + m_MediaEnd.

For information about media times, see Time and Clocks in DirectShow.

Requirements

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

See also

CMediaSample Class