CBasePin.SetMediaType 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 SetMediaType method sets the media type for the connection.

Syntax

virtual HRESULT SetMediaType(
   const CMediaType *pmt
);

Parameters

pmt

Pointer to a CMediaType object that specifies the media type.

Return value

Returns S_OK.

Remarks

This method establishes the format for a pin connection. Before calling this method, the pin calls the CBasePin::CheckMediaType method to determine whether the media type is acceptable. Therefore, the pmt parameter is assumed to be an acceptable media type.

In the base class, this method sets the CBasePin::m_mt member variable and returns S_OK. A derived class can override this method if it requires notification when the media type is set.

Requirements

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

See also

CBasePin Class