Microsoft DirectX 9.0

IAMVideoCompression::OverrideKeyFrame

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

Syntax

HRESULT OverrideKeyFrame(
  long FrameNumber
);

Parameters

FrameNumber

[in] Specifies the frame number. The first frame that the filter delivers is numbered zero.

Return Values

Returns an HRESULT value. Possible values include the following.

Return code 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.

See Also