IAMVideoControl::GetCurrentActualFrameRate method (strmif.h)

[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 GetCurrentActualFrameRate method retrieves the actual frame rate, expressed as a frame duration in 100-nanosecond units. USB (Universal Serial Bus) and IEEE 1394 cameras may provide lower frame rates than requested because of bandwidth availability. This is only available during video streaming.

Syntax

HRESULT GetCurrentActualFrameRate(
  [in]  IPin     *pPin,
  [out] LONGLONG *ActualFrameRate
);

Parameters

[in] pPin

Pointer to the pin to retrieve the frame rate from.

[out] ActualFrameRate

Pointer to the frame rate in frame duration in 100-nanosecond units.

Return value

Returns an HRESULT value that depends on the implementation of the interface.

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

See also

Error and Success Codes

IAMVideoControl Interface