IAMCrossbar::Route 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 Route method routes an input pin to an output pin.

Syntax

HRESULT Route(
  [in] long OutputPinIndex,
  [in] long InputPinIndex
);

Parameters

[in] OutputPinIndex

Specifies the index of the output pin.

[in] InputPinIndex

Specifies the index of the input pin.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
S_FALSE	Cannot route these two pins.
S_OK	Success.

Remarks

Routing two pins causes the output pin to deliver data from that input pin. Only one input pin at a time can be routed to a given output pin.

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