IAMVideoControl::GetFrameRateList 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 GetFrameRateList method retrieves a list of available frame rates.

Syntax

HRESULT GetFrameRateList(
  [in]  IPin     *pPin,
  [in]  long     iIndex,
  [in]  SIZE     Dimensions,
  [out] long     *ListSize,
  [out] LONGLONG **FrameRates
);

Parameters

[in] pPin

Pointer to the pin to query for the list of frame rates.

[in] iIndex

Index of the format to query for frame rates. This index corresponds to the order in which formats are enumerated by VIDEO_STREAM_CONFIG_CAPS structures returned by IAMStreamConfig::GetNumberOfCapabilities) minus one.

[in] Dimensions

Frame image size (width and height) in pixels.

[out] ListSize

Pointer to the number of elements in the list of frame rates.

[out] FrameRates

Address of a pointer to an array of frame rates in 100-nanosecond units. Can be NULL if you only need ListSize.

Return value

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

Remarks

The caller is responsible for freeing the memory through a call to CoTaskMemFree.

Requirements

See also

Error and Success Codes

IAMVideoControl Interface

VIDEO_STREAM_CONFIG_CAPS Structure