IAMVideoCompression::put_KeyFrameRate method (strmif.h)

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The put_KeyFrameRate method sets the key-frame rate.

Syntax

HRESULT put_KeyFrameRate(
  [in] long KeyFrameRate
);

Parameters

[in] KeyFrameRate

Desired 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 will be a key frame.

Return value

Returns an HRESULT value.

Remarks

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

See also

Error and Success Codes

IAMVideoCompression Interface

IAMVideoCompression::get_KeyFrameRate