IAMCrossbar::get_CrossbarPinInfo method (strmif.h)

Article
02/22/2024

[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 get_CrossbarPinInfo method retrieves information about a specified pin.

Syntax

HRESULT get_CrossbarPinInfo(
  [in]  BOOL IsInputPin,
  [in]  long PinIndex,
  [out] long *PinIndexRelated,
  [out] long *PhysicalType
);

Parameters

[in] IsInputPin

Specifies the direction of the pin. Use one of the following values.

Value	Meaning
TRUE	Input pin
FALSE	Output pin

[in] PinIndex

Specifies the index of the pin.

[out] PinIndexRelated

Pointer to a variable that receives the index of the related pin, or –1 if no pin is related to this pin. The related pin is a pin on the same filter, with the same direction; it typically represents the same physical jack or connector. For example, a video tuner and an audio tuner might be related pins. Typically, if two pins are related, you should route them together.

[out] PhysicalType

Pointer to a variable that receives a member of the PhysicalConnectorType enumeration, indicating the pin's physical type.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
S_FALSE	Unknown physical type.
S_OK	Success.
E_POINTER	NULL pointer argument.

Remarks

Output pins and input pins are both indexed from zero. To determine the number of output and input pins, call the IAMCrossbar::get_PinCounts method.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib