IAMVideoControl::GetMaxAvailableFrameRate (Compact 2013)

3/26/2014

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 Interface to 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_CAPS structures returned by IAMStreamConfig::GetNumberOfCapabilities) minus one.

• Dimensions
  [in] A SIZE structure 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

See Also

Reference

IAMVideoControl Interface
IPin Interface
IAMStreamConfig::GetStreamCaps
VIDEO_STREAM_CONFIG_CAPS
IAMStreamConfig::GetNumberOfCapabilities

Other Resources

SIZE