IAMVideoControl::GetMaxAvailableFrameRate

 
Microsoft DirectShow 9.0

IAMVideoControl::GetMaxAvailableFrameRate

The GetMaxAvailableFrameRate method retrieves the maximum frame rate currently available, based on bus bandwidth usage for connections, such as USB and IEEE 1394, where the maximum frame rate may be limited by bandwidth availability.

Syntax

  HRESULT GetMaxAvailableFrameRate(
  IPin *pPin,
  long iIndex,
  SIZE Dimensions,
  LONGLONG *MaxAvailableFrameRate
);

Parameters

pPin

[in] Pointer to the pin to retrieve the maximum frame rate from.

iIndex

[in] Index of the format to query for maximum frame rate. This index corresponds to the order in which formats are enumerated by IAMStreamConfig::GetStreamCaps. The value must range between zero and the number of supported VIDEO_STREAM_CONFIG_CAPS structures returned by IAMStreamConfig::GetNumberOfCapabilities) minus one.

Dimensions

[in] Frame image size (width and height) in pixels.

MaxAvailableFrameRate

[out] Pointer to the maximum available frame rate. The frame rate is expressed as frame duration in 100-nanosecond units.

Return Values

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

Requirements

Header: Declared in Strmif.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also