Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This 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 IPin Interfaceto retrieve the maximum frame rate from.

iIndex

[in] A long value that specifies the 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_CAPSstructures returned by IAMStreamConfig::GetNumberOfCapabilities) minus one.

Dimensions

[in] A SIZEstructure that specifies the frame image size (width and height) in pixels.

MaxAvailableFrameRate

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

Return Value

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

Requirements

Windows Embedded CE Windows Embedded CE 6.0 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later
Note Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements
For more information, see Setting Up the Build Environment

See Also