Edit

CTransformFilter.GetMediaType 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 GetMediaType method retrieves a preferred media type for the output pin.

Syntax

virtual HRESULT GetMediaType(
   int        iPosition,
   CMediaType *pMediaType
) = 0;

Parameters

iPosition

Zero-based index value.

pMediaType

Pointer to a CMediaType object that receives the media type.

Return value

Returns an HRESULT value. Possible values include those shown in the following table.

Return code Description
S_OK
 Success.
VFW_S_NO_MORE_ITEMS
 Index out of range.
E_INVALIDARG
 Index less than zero.

Remarks

The output pin's CTransformOutputPin::GetMediaType method calls this method. The derived class must implement this method. For more information, see CBasePin::GetMediaType.

Requirements

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

See also

CTransformFilter Class