CBaseControlVideo.GetDestinationPosition method

[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 GetDestinationPosition method retrieves the destination rectangle in one atomic operation.

Syntax

HRESULT GetDestinationPosition(
   long *pLeft,
   long *pTop,
   long *pWidth,
   long *pHeight
);

Parameters

pLeft

Pointer to the left coordinate of the destination rectangle.

pTop

Pointer to the top coordinate of the destination rectangle.

pWidth

Pointer to the width of the destination rectangle.

pHeight

Pointer to the height of the destination rectangle.

Return value

Returns an HRESULT value that depends on the implementation; can be one of the following values, or other values not listed.

Remarks

This member function can be used in place of separate calls to the CBaseControlVideo::get_DestinationLeft, CBaseControlVideo::get_DestinationTop, CBaseControlVideo::get_DestinationWidth, and CBaseControlVideo::get_DestinationHeight member functions. An application can change the source and destination rectangles for the video through the IBasicVideo interface. The source rectangle affects which section of the native video source will appear on the display; the destination rectangle affects where the video will appear when played. The destination rectangle is relative to the client area of the window in which it is playing. The upper-left corner of the window is coordinate (0,0).

Requirements

See also

CBaseControlVideo Class