Edit

Share via

IVMRAspectRatioControl::GetAspectRatioMode method (strmif.h)

  • Article

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

The GetAspectRatioMode method queries whether the VMR will preserve the aspect ratio of the source video.

Syntax

HRESULT GetAspectRatioMode(
  [out] LPDWORD lpdwARMode
);

Parameters

[out] lpdwARMode

Pointer to a variable that receives a VMR_ASPECT_RATIO_MODE value indicating the aspect ratio mode.

Return value

Returns an HRESULT value. Possible values include the following:

Return code Description
E_POINTER
 NULL pointer argument
S_OK
 Success

Requirements

Requirement Value
Minimum supported client Windows XP with SP1 [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header strmif.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IVMRAspectRatioControl Interface

Using the Video Mixing Renderer