IKsReferenceClock::GetState method (ks.h)

  • Article

The IKsReferenceClock::GetState method queries the associated reference clock for its current streaming state.

Syntax

NTSTATUS GetState(
  [out] PKSSTATE State
);

Parameters

[out] State

Points to a KSSTATE structure that indicates the streaming state of the underlying clock.

Return value

The IKsReferenceClock::GetState method returns STATUS_SUCCESS or the error code that the relevant clock returned from its GetState property. See KSPROPERTY_CLOCK_STATE. May return STATUS_DEVICE_NOT_READY if no clock is assigned.

Remarks

For more information, see AVStream Clocks.

AVStream uses the KSPROPERTY_CLOCK_STATE property to retrieve the correlated time.

Requirements

Requirement Value
Target Platform Universal
Header ks.h (include Ks.h)

See also

KSSTATE

KsPinGetReferenceClockInterface