IMFPMediaPlayer::GetVideoSourceRect 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.]

Gets the video source rectangle.

Syntax

HRESULT GetVideoSourceRect(
  [out] MFVideoNormalizedRect *pnrcSource
);

Parameters

[out] 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).
If the source rectangle is {0, 0, 1, 1}, the entire image is displayed. 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.

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

See also

IMFPMediaPlayer

Using MFPlay for Audio/Video Playback