CImageDisplay.CheckVideoType method

  • 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 CheckVideoType method checks whether a specified VIDEOINFO format is compatible with the display format.

Syntax

HRESULT CheckVideoType(
   const VIDEOINFO *pInput
);

Parameters

pInput

Pointer to a VIDEOINFO structure.

Return value

Returns S_OK if the format is compatible, or E_INVALIDARG otherwise.

Remarks

This method returns S_OK if the proposed type can be displayed easily under the current display settings.

Requirements

Requirement Value
Header
Winutil.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CImageDisplay Class