IWMResizerProps::SetClipRegion Method

Sets the source rectangle.

Syntax

HRESULT SetClipRegion(
  [in]  LONG lClipOriXSrc,
  [in]  LONG lClipOriYSrc,
  [in]  LONG lClipWidthSrc,
  [in]  LONG lClipHeightSrc
);

Parameters

  • lClipOriXSrc [in]
    Specifies the left edge of the source rectangle, in pixels.

  • lClipOriYSrc [in]
    Specifies the top edge of the source rectangle, in pixels.

  • lClipWidthSrc [in]
    Specifies the width of the source rectangle, in pixels.

  • lClipHeightSrc [in]
    Specifies the height of the source rectangle, in pixels.

Return Value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK

The method succeeded.

 

Remarks

By default, the video resizer copies the entire video frame. When you call this method, the video resizer crops the video to the source rectangle and copies that portion to the output buffer.

This method is equivalent to setting the following properties:

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

Wmcodecdsp.h

See Also

IWMResizerProps Interface

 

 

Send comments about this topic to Microsoft

Build date: 4/7/2010