Share via

IAMVideoCompression::get_KeyFrameRate

  • Article
 
Microsoft DirectShow 9.0

IAMVideoCompression::get_KeyFrameRate

The get_KeyFrameRate method retrieves the current key-frame rate.

Syntax

  get_KeyFrameRate(
  long *pKeyFrameRate
);

Parameters

pKeyFrameRate

[out] Pointer to a variable that receives the current key-frame rate. If the value is negative, the filter will use the default key-frame rate. If the value is zero, only the first frame is a key frame.

Return Values

Returns an HRESULT value.

Remarks

The key-frame rate is the number of frames per key frame. For example, if the rate is 15, then a key frame occurs every 15 frames.

To determine if the filter supports this method, call the IAMVideoCompression::GetInfo method and check for the CompressionCaps_CanKeyFrame flag in the pCapabilities parameter. The GetInfo method also returns the default key-frame rate.

Requirements

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

Library: Use Strmiids.lib.

See Also