IMFPMediaPlayer::GetAspectRatioMode method (mfplay.h)

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

Gets the current aspect-ratio correction mode. This mode controls whether the aspect ratio of the video is preserved during playback.

Syntax

HRESULT GetAspectRatioMode(
  [out] DWORD *pdwAspectRatioMode
);

[out] pdwAspectRatioMode

Receives a bitwise OR of one or more flags from the MFVideoAspectRatioMode enumeration.

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.

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