Share via


IWMPPlayer2::get_stretchToFit method (wmp.h)

[The feature associated with this page, Windows Media Player SDK, is a legacy feature. It has been superseded by MediaPlayer. MediaPlayer has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer instead of Windows Media Player SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The get_stretchToFit method retrieves a value indicating whether video displayed by the Windows Media Player control automatically sizes to fit the video window when the video window is larger than the dimensions of the video image.

Syntax

HRESULT get_stretchToFit(
  [out] VARIANT_BOOL *pbEnabled
);

Parameters

[out] pbEnabled

Pointer to a VARIANT_BOOL indicating whether video displayed by the Windows Media Player control automatically resizes.

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.

Remarks

When the VARIANT_BOOL retrieved by get_stretchToFit equals TRUE, the Windows Media Player control maintains the original aspect ratio of the video. If the aspect ratio of the video does not match the aspect ratio of the video window, black mask areas may appear on either the top and bottom or left and right of the video image.

This method applies to the Windows Media Player control only when embedded in a webpage.

Windows Media Player 10 Mobile: This method always retrieves a VARIANT_BOOL set to FALSE.

Requirements

Requirement Value
Minimum supported client Windows Media Player 9 Series or later.
Target Platform Windows
Header wmp.h
DLL Wmp.dll

See also

IWMPPlayer2 Interface

IWMPPlayer2::put_stretchToFit