KsPinRegisterHandshakeCallback function

The KsPinRegisterHandshakeCallback function registers a minidriver-provided callback routine for a given pin. AVStream calls the callback routine when it receives a handshake request for the pin that specifies a protocol that AVStream does not handle by default.

Syntax


void KsPinRegisterHandshakeCallback(
  _In_ PKSPIN            Pin,
  _In_ PFNKSPINHANDSHAKE Handshake
);

Parameters

Pin [in]

A pointer to the KSPIN structure for which to register a handshake callback.

Handshake [in]

A pointer to a minidriver-supplied AVStrMiniPinHandshake routine to be called when AVStream receives a protocol handshake request on Pin that it does not handle.

Return value

None

Remarks

Pins that support private protocol connections with other AVStream pins should register a handshake callback.

Minidrivers that support private protocols between a given pin and another AVStream pin should call this routine as soon as possible to register a callback. Then if another pin requests a handshake, the minidriver can return the request.

Requirements

Target platform

Universal

Version

Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.

Header

Ks.h (include Ks.h)

Library

Ks.lib

IRQL

PASSIVE_LEVEL

See also

KsPinHandshake
KSHANDSHAKE
KsFilterRegisterPowerCallbacks
KsPinRegisterPowerCallbacks
KsRegisterAggregatedClientUnknown
AVStrMiniPinHandshake

 

 

Send comments about this topic to Microsoft

Show: