IMixerPinConfig::SetAspectRatioMode method (mpconfig.h)

Article
02/22/2024

[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 sets the aspect ratio correction mode for window resizing.

Syntax

HRESULT SetAspectRatioMode(
  [in] AM_ASPECT_RATIO_MODE amAspectRatioMode
);

Parameters

[in] amAspectRatioMode

Value specifying one of the AM_ASPECT_RATIO_MODE enumerated type members.

Return value

Returns an HRESULT value. Possible values include the following:

Return code	Description
E_NOTIMPL	Method called on secondary stream.
E_INVALIDARG	Invalid argument.
S_OK	Success.

Remarks

Currently this function is implemented only on the primary pin of the Overlay Mixer filter. Calling it on a secondary pin will result in an error.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	mpconfig.h
Library	Strmiids.lib