IKsReferenceClock::GetResolution method (ks.h)

The IKsReferenceClock::GetResolution method queries the associated reference clock for its resolution.

Syntax

NTSTATUS GetResolution(
  [out] PKSRESOLUTION Resolution
);

Parameters

[out] Resolution

Specifies granularity and notification error of the clock in a KSRESOLUTION structure.

Return value

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

Remarks

This method retrieves the underlying clock's resolution property, which specifies the clock's increment granularity and notification error in 100-nanosecond units. The finest granularity is one unit; less granular increments contain larger numbers.

The least amount of notification error greater than the clock granularity is zero units; less accurate clocks use larger numbers to indicate error. The proxy can use this resolution property to determine maximum error and resolution in event notification and synchronization.

For more information, see AVStream Clocks.

AVStream uses the KSPROPERTY_CLOCK_RESOLUTION property to retrieve the clock resolution.

Requirements

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

See also

KsPinGetReferenceClockInterface