KsStreamPointerScheduleTimeout function (ks.h)

Article
02/22/2024

The KsStreamPointerScheduleTimeout function registers a timeout callback with AVStream for the given stream pointer.

Syntax

void KsStreamPointerScheduleTimeout(
  [in] PKSSTREAM_POINTER  StreamPointer,
  [in] PFNKSSTREAMPOINTER Callback,
  [in] ULONGLONG          Interval
);

Parameters

[in] StreamPointer

A pointer to a KSSTREAM_POINTER structure representing the stream pointer for which to register a timeout.

[in] Callback

A pointer to a minidriver-supplied AVStrMiniTimeoutCallback routine. If the stream pointer has not been deleted or the timeout canceled before the interval expires, AVStream calls this routine immediately following expiration of the interval.

[in] Interval

Specifies the interval in 100-nanosecond units from the current time to the time that the timeout occurs.

Return value

None

Remarks

It is safe to call KsStreamPointerScheduleTimeout on a stream pointer that already has a timeout scheduled. In this case, AVStream cancels the previous timeout and replaces it with the new timeout.

If you call KsStreamPointerScheduleTimeout while the pin associated with the KSSTREAM_POINTER is still in the pause state, the scheduled timeout may not fire unless another timeout is scheduled later in the run state. At that point, it is possible for all the timeouts that were scheduled during pause to become active and fire immediately in a chain. Also see Stream Pointers.

Requirements

Requirement	Value
Target Platform	Universal
Header	ks.h (include Ks.h)
Library	Ks.lib
IRQL	IRQL <= DISPATCH_LEVEL