IMediaSample::GetTime method (strmif.h)

Article
02/22/2024

[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 GetTime method retrieves the stream times at which this sample should begin and finish.

Syntax

HRESULT GetTime(
  [out] REFERENCE_TIME *pTimeStart,
  [out] REFERENCE_TIME *pTimeEnd
);

Parameters

[out] pTimeStart

Pointer to a variable that receives the start time.

[out] pTimeEnd

Pointer to a variable that receives the stop time. If the sample has no stop time, the value is set to the start time plus one.

Return value

Returns an HRESULT value. Possible values include those shown in the following table.

Return code	Description
S_OK	Success. The sample has valid start and stop times.
VFW_S_NO_STOP_TIME	The sample has a valid start time, but no stop time.
VFW_E_SAMPLE_TIME_NOT_SET	The sample is not time-stamped.

Remarks

Both time values are relative to the stream time. For more information, see Time and Clocks in DirectShow.

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