Share via


IAMVideoCompression::OverrideKeyFrame (Compact 2013)

3/26/2014

This method instructs the filter to compress a particular frame as a key frame.

Syntax

HRESULT OverrideKeyFrame(
  long FrameNumber
);

Parameters

  • FrameNumber
    [in] A long value that specifies the frame number. The first frame that the filter delivers is numbered zero.

Return Value

Returns an HRESULT value. The following table shows some of the possible return values.

Value

Description

S_OK

Success.

E_NOTIMPL

Not implemented.

Remarks

If the filter supports this method, you can use it to override the normal key-frame distribution for a particular frame. After the filter creates a key frame, it might reset its count to determine when the next key frame should occur. For example, if the key-frame rate is 10, and an application uses this method to force frame 5 as a key frame, the filter might wait another 10 frames (until frame 15) before it creates the next key frame.

Requirements

Header

dshow.h

Library

Strmiids.lib

See Also

Reference

IAMVideoCompression Interface