Freigeben über


IFullScreenVideoEx::GetClipFactor method (amvideo.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 GetClipFactor method retrieves the clip factor, which determines how much of the video the Full Screen Renderer is allowed to clip. For example, if the clip factor is 25, the Full Screen Renderer can clip up to 25% of the video.

Syntax

HRESULT GetClipFactor(
  [out] long *pClipFactor
);

Parameters

[out] pClipFactor

Pointer to a variable the receives the clip factor.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
E_POINTER
NULL pointer argument.
S_OK
Success.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header amvideo.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IFullScreenVideoEx Interface