IMFPMediaPlayer::SetVideoSourceRect method (mfplay.h)

Article
02/22/2024

Important Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.

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).

To display the entire image, set the source rectangle to {0, 0, 1, 1}. This is the default value.

Return value

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

Return code	Description
S_OK	The method succeeded.
MF_E_INVALIDREQUEST	The current media item does not contain video.
MF_E_SHUTDOWN	The object's Shutdown method was called.

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

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	mfplay.h