IVMRAspectRatioControl9::SetAspectRatioMode method (vmr9.h)

[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 SetAspectRatioMode method specifies whether the VMR preserves the aspect ratio of the source video.

Syntax

HRESULT SetAspectRatioMode(
  [in] DWORD dwARMode
);

Parameters

[in] dwARMode

Specifies a member of the VMR_ASPECT_RATIO_MODE enumeration type.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
E_INVALIDARG
Invalid argument
S_OK
Success

Requirements

   
Minimum supported client Windows XP with SP2 [desktop apps only]
Minimum supported server Windows Server 2003 R2 [desktop apps only]
Target Platform Windows
Header vmr9.h
Library Strmiids.lib

See also

Error and Success Codes

IVMRAspectRatioControl9 Interface

Using the Video Mixing Renderer