IAMDroppedFrames::GetAverageFrameSize 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 GetAverageFrameSize method retrieves the average size of the frames that the filter has captured.

Syntax

HRESULT GetAverageFrameSize(
  [out] long *plAverageSize
);

Parameters

[out] plAverageSize

Pointer to a variable that receives the average frame size, in bytes, since the filter began streaming.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
S_OK	Success.
E_NOTIMPL	Not implemented.
E_POINTER	NULL pointer argument.

Remarks

If the device does not report a value, the method might succeed but return zero in the plAverageSize parameter.

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