KsPinGetReferenceClockInterface - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// ks.h

KSDDKAPI NTSTATUS KsPinGetReferenceClockInterface(
  [in]  PKSPIN             Pin,
  [out] PIKSREFERENCECLOCK *Interface
);

View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Windows Driver Kit DDI reference (nf-ks-kspingetreferenceclockinterface)

KsPinGetReferenceClockInterface function

Description

The KsPinGetReferenceClockInterface function returns a COM style interface to the reference clock associated with Pin. This interface pointer will be an IKsReferenceClock 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.

See also

IKsControl

IKsReferenceClock

KsFilterGetOuterUnknown

KsGetOuterUnknown

KsPinGetConnectedFilterInterface

KsPinGetConnectedPinInterface

KsPinSetPinClockTime

KsRegisterAggregatedClientUnknown