Microsoft DirectX 9.0

IBasicVideo::put_SourceTop

The put_SourceTop method sets the y-coordinate of the source rectangle.

Syntax

HRESULT put_SourceTop(
  long SourceTop
);

Parameters

SourceTop

[in] Specifies the y-coordinate, in pixels.

Return Values

Returns an HRESULT value. Possible values include the following.

Return code Description
E_INVALIDARG Invalid argument.
S_OK Success.
VFW_E_NOT_CONNECTED The video renderer's input pin is not connected.

Remarks

This method moves the entire source rectangle up or down. It does not change the height of the source rectangle. If the value of SourceTop would place the bottom edge of the rectangle beyond the edge of the video frame, the method returns E_INVALIDARG. To crop the video, call put_SourceHeight to adjust the width, before calling put_SourceTop. (Or call SetSourcePosition to set the entire source rectangle at once.)

See Also