IPin::ConnectionMediaType method

The ConnectionMediaType method retrieves the media type for the current pin connection, if any.

Syntax


HRESULT ConnectionMediaType(
  [out]  AM_MEDIA_TYPE *pmt
);

Parameters

pmt [out]

Pointer to an AM_MEDIA_TYPE structure that receives the media type.

Return value

Returns an HRESULT value. Possible values include the following.

Return codeDescription
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 Microsoft® Win32®CoTaskMemFree function, or the FreeMediaType helper function.

If the pin is not connected, this method clears the media type specified by pmt and returns an error code.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

Data Flow in the Filter Graph
Error and Success Codes
IPin Interface

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.