IAMVideoCompression::get_KeyFrameRate (Compact 2013)

3/26/2014

This method retrieves the current key-frame rate.

Syntax

get_KeyFrameRate(
  long* pKeyFrameRate
);

Parameters

  • pKeyFrameRate
    [out] Pointer to a long 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 Value

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 (see CompressionCaps) flag in the pCapabilities parameter. The GetInfo method also returns the default key-frame rate.

Requirements

Header

dshow.h

Library

Strmiids.lib

See Also

Reference

IAMVideoCompression Interface
IAMVideoCompression::put_KeyFrameRate
IAMVideoCompression::GetInfo
CompressionCaps