Edit

Share via

CImageDisplay.CheckMediaType 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 CheckMediaType method determines whether a proposed media type is compatible with the display format.

Syntax

HRESULT CheckMediaType(
   const CMediaType *pmtIn
);

Parameters

pmtIn

Pointer to a CMediaType object that contains the media type.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
E_FAIL
 Invalid media type.
E_INVALIDARG
 Invalid media type.
S_OK
 The media type is compatible.

Requirements

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

See also

CImageDisplay Class