IVideoWindow::GetMaxIdealImageSize method (control.h)

Article
07/27/2023

[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 GetMaxIdealImageSize method retrieves the maximum ideal image size for the video image.

Syntax

HRESULT GetMaxIdealImageSize(
  [out] long *pWidth,
  [out] long *pHeight
);

Parameters

[out] pWidth

Receives the maximum ideal width, in pixels.

[out] pHeight

Receives the maximum ideal height, in pixels.

Return value

Possible return values include the following:

Return code	Description
E_POINTER	NULL pointer.
S_FALSE	Could not retrieve a maximum image size.
S_OK	Success.
VFW_E_WRONG_STATE	Filter is stopped.

Remarks

The maximum ideal size may differ from the native video size, because the video hardware might have specific stretching requirements.

This method returns S_FALSE under various circumstances:

The filter is using an IOverlay transport.
UseWhenFullScreen mode is on. (See IDirectDrawVideo::UseWhenFullScreen.)
The video surface has no maximum overlay stretch. (The dwMaxOverlayStretch member of the DDCAPS structure is zero. See IDirectDrawVideo::GetCaps.)

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	control.h (include Dshow.h)
Library	Strmiids.lib