CBasePin.ConnectionMediaType 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 ConnectionMediaType method retrieves the media type for the current pin connection, if any. This method implements the IPin::ConnectionMediaType method.

Syntax

HRESULT ConnectionMediaType(
   AM_MEDIA_TYPE *pmt
);

Parameters

pmt

Pointer to an AM_MEDIA_TYPE structure 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.
E_POINTER
 NULL pointer argument.
VFW_E_NOT_CONNECTED
 Pin is not connected.

Remarks

If the pin is connected, this method copies the media type into the AM_MEDIA_TYPE structure specified by pmt. The caller must free the media type's format block. You can use the CoTaskMemFree function, or the FreeMediaType helper function.

If the pin is not connected, this method zeroes the memory block specified by pmt and returns an error code.

Requirements

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

See also

CBasePin Class