Hardware Dev Center

Collapse the table of content
Expand the table of content
Expand Minimize

KsPinGetReferenceClockInterface function

The KsPinGetReferenceClockInterface function returns a COM style interface to the reference clock associated with Pin. This interface pointer will be an IKsReferenceClock interface.

Syntax


NTSTATUS KsPinGetReferenceClockInterface(
  _In_  PKSPIN             Pin,
  _Out_ PIKSREFERENCECLOCK *Interface
);

Parameters

Pin [in]

A pointer to the KSPIN structure for which to return the reference clock interface.

Interface [out]

A pointer to a memory location that receives the address of an IKsReferenceClock interface. This is a COM style interface with an associated reference count. Minidrivers must release the interface when finished with it.

Return value

KsPinGetReferenceClockInterface returns STATUS_SUCCESS and deposits the address of the IKsReferenceClock interface into Interface if the pin implements the clock or has received notification of the master clock through the KSPROPERTY_STREAM_MASTERCLOCK property. Returns STATUS_DEVICE_NOT_READY if the pin has not yet received notification of the master clock.

Remarks

The most common time to call KsPinGetReferenceClockInterface is in a state transition to KSSTATE_ACQUIRE.

See AVStream Clocks for more information about using the IKsReferenceClock interface that this routine returns.

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

KsPinGetConnectedPinInterface
KsPinGetConnectedFilterInterface
KsPinSetPinClockTime
KsGetOuterUnknown
IKsControl
IKsReferenceClock
KsFilterGetOuterUnknown
KsRegisterAggregatedClientUnknown

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft