IBasicVideo::get_AvgTimePerFrame method (control.h)

Article
07/27/2023

[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 get_AvgTimePerFrame method retrieves the average time between successive frames.

Syntax

HRESULT get_AvgTimePerFrame(
  [out] REFTIME *pAvgTimePerFrame
);

Parameters

[out] pAvgTimePerFrame

Pointer to a variable of type REFTIME that receives the average frame time, in seconds.

Return value

Returns an HRESULT value.

Remarks

This method returns the authored time per frame. This value is typically set by the source filter, which obtains it from information in the video stream itself. This value is not necessarily equal to the actual time per frame at which the video is rendered.

To retrieve the actual frame rate during playback, use the IQualProp::get_AvgFrameRate. For more information on actual versus authored frame rates, see the Remarks section for the VIDEOINFOHEADER structure.

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	control.h (include Dshow.h)
Library	Strmiids.lib