ILMScrCapEncoder

This is the interface for the LEAD Screen Capture Encoder.

Properties

Type Name Description
long KeyFrameSpace Gets or sets the number of frames between key frames (key frame spacing). For example, if the rate is 5, then a key frame is taken every 5 frames. If the value is 0, then the first frame is the only key frame in the video.
BYTE QFactor Gets or sets the quality factor for compression. The value range is between 1 and 9. Use 1 for fast compression and 9 for high compression.
VARIANT_BOOL IsLEADInputPinConnected Read only; returns TRUE if the filters input pin is connected.
VARIANT_BOOL IsLEADOutputPinConnected Read only; returns TRUE if the filters output pin is connected.
long InWidth Read only; the input stream width.
long InHeight Read only; the input stream height.
long OutWidth Read only; the output stream width.
long OutHeight Read only; the output stream height.
long InBits Read only; the input stream bits per pixel.
long OutBits Read only; the output stream bits per pixel.

Methods

HRESULT ResetToDefaults();

Description

Resets the filter properties to their default values.

Comments

Calling this method can cause the filter to reconnect its output pin.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.
VFW_E_WRONG_STATE The filter is in the wrong state.

HRESULT ForceKeyFrame(long FrameNumber)

Description

Forces the frame at the specified position to be a key frame.

Parameters

FrameNumber

The zero based number (position) of the frame to compress as a key frame. Use -1 to make the next passing frame a key frame. Valid values range between -1 and the total number of frames in the stream less one. Note that the filter do not know the total number of frames in the stream; so a number greater than the total number of frames in the stream will be accepted but will have no effect since it will not be reached.

Comments

The method will return S_FALSE if the frame at the specified position has already been compressed.

Returns

Return Description
S_OK Successful.
Error code Otherwise.
Help Version 22.0.2023.2.15
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Filters C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.