IBasicVideo::SetDestinationPosition method (control.h)

Article
02/22/2024

[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 SetDestinationPosition method sets the destination rectangle.

Syntax

HRESULT SetDestinationPosition(
  [in] long Left,
  [in] long Top,
  [in] long Width,
  [in] long Height
);

Parameters

[in] Left

Specifies the x-coordinate, in pixels.

[in] Top

Specifies the y-coordinate, in pixels.

[in] Width

Specifies the width, in pixels.

[in] Height

Specifies the height, in pixels.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
E_INVALIDARG	Invalid argument. Width and Height must be larger than zero.
S_OK	The method succeeded.
VFW_E_NOT_CONNECTED	The video renderer is not connected.

Remarks

This method has the same effect as individually calling the IBasicVideo::put_DestinationLeft, IBasicVideo::put_DestinationTop, IBasicVideo::put_DestinationWidth, and IBasicVideo::put_DestinationHeight methods.

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