CSourceStream.CheckMediaType method

[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 if the pin accepts a specific media type. This method implements the pure virtual CBasePin::CheckMediaType method.

Syntax

virtual HRESULT CheckMediaType(
   const CMediaType *pMediaType
);

Parameters

pMediaType

Pointer to a CMediaType object that contains the proposed media type.

Return value

Returns one of the HRESULT values shown in the following table.

Return code Description
S_OK
This pin supports this media type.
E_FAIL
The pin does not support this media type.

Remarks

By default, the pin supports a single media type. This method retrieves the supported type by calling the single-parameter version of the CSourceStream::GetMediaType method, and compares it to the proposed type. If your pin supports more than one media type, override this method.

Requirements

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

See also

CSourceStream Class