Partager via


IMFPMediaPlayer::GetAspectRatioMode 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 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
);

Parameters

[out] pdwAspectRatioMode

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

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