CBasePin.GetMediaType method

The GetMediaType method retrieves a preferred media type, by index value.

Syntax

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

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 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.
E_UNEXPECTED
Unexpected error.

Remarks

From the pin's list of preferred media types, this method returns the type with an index value of iPosition. The CEnumMediaTypes class calls this method to enumerate preferred media types.

The base class returns E_UNEXPECTED. Override this method in your derived class.

Requirements

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

See also

CBasePin Class