IBasicVideo::put_SourceTop method (control.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 put_SourceTop method sets the y-coordinate of the source rectangle.
Syntax
HRESULT put_SourceTop(
[in] long SourceTop
);
Parameters
[in] SourceTop
Specifies the y-coordinate, in pixels.
Return value
Returns an HRESULT value. Possible values include the following.
| Return code | Description |
|---|---|
|
Invalid argument. |
|
Success. |
|
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.)
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 | control.h (include Dshow.h) |
| Library | Strmiids.lib |