Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

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

Windows Embedded CE Windows Embedded CE 6.0 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later
Note Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements
For more information, see Setting Up the Build Environment

See Also