KsStreamPointerAdvance function (ks.h)

Article
02/22/2024

The KsStreamPointerAdvance function advances a stream pointer to the next data frame.

Syntax

KSDDKAPI NTSTATUS KsStreamPointerAdvance(
  [in] PKSSTREAM_POINTER StreamPointer
);

Parameters

[in] StreamPointer

A pointer to a KSSTREAM_POINTER structure representing the stream pointer to advance to reference the next available data frame.

Return value

KsStreamPointerAdvance returns STATUS_SUCCESS to indicate a successful advancement. It returns an error code otherwise. STATUS_DEVICE_NOT_READY is the most often returned error code and often indicates that locking the stream pointer after advancement failed. In other words, StreamPointer references the last frame in the queue.

Remarks

If StreamPointer is locked at call-time, AVStream unlocks it before advancing it. Once advanced, the stream pointer is placed back into its original state (locked or unlocked) on the new frame.

An attempt to advance a stream pointer that is unlocked always succeeds and returns STATUS_SUCCESS. Since the stream pointer is not locked, there is no way to determine if the stream pointer references actual data. The minidriver must attempt a lock to determine if the newly advanced stream pointer references a data frame or not.

Also see Stream Pointers.

Requirements

Requirement	Value
Minimum supported client	Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.
Target Platform	Universal
Header	ks.h (include Ks.h)
Library	Ks.lib
IRQL	<=DISPATCH_LEVEL