IMFPMediaPlayer::SetVideoSourceRect method (mfplay.h)

[The feature associated with this page, MFPlay, is a legacy feature. It has been superseded by MediaPlayer and IMFMediaEngine. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Sets the video source rectangle.

MFPlay clips the video to this rectangle and stretches the rectangle to fill the video window.

Syntax

HRESULT SetVideoSourceRect(
  [in] const MFVideoNormalizedRect *pnrcSource
);

Parameters

[in] pnrcSource

Pointer to an MFVideoNormalizedRect structure that specifies the source rectangle. This rectangle defines which portion of the video is displayed. It is specified in normalized coordinates, which are defined as follows:

• The upper-left corner of the video image is (0, 0).
• The lower-right corner of the video image is (1, 1).

Return value

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

Remarks

MFPlay stretches the source rectangle to fill the entire video window. By default, MFPlay maintains the source's correct aspect ratio, letterboxing if needed. The letterbox color is controlled by the IMFPMediaPlayer::SetBorderColor method.

This method fails if no media item is currently set, or if the current media item does not contain video.

To set the video position before playback starts, call this method inside your event handler for the MFP_EVENT_TYPE_MEDIAITEM_SET event. For more information, see IMFPMediaPlayerCallback::OnMediaPlayerEvent.

Requirements

See also

IMFPMediaPlayer

Using MFPlay for Audio/Video Playback