Edit

KSSTREAM_POINTER structure (ks.h)

  • Article

The KSSTREAM_POINTER structure is the basic AVStream pointer into a stream.

Syntax

typedef struct _KSSTREAM_POINTER {
  PVOID                    Context;
  PKSPIN                   Pin;
  PKSSTREAM_HEADER         StreamHeader;
  PKSSTREAM_POINTER_OFFSET Offset;
  KSSTREAM_POINTER_OFFSET  OffsetIn;
  KSSTREAM_POINTER_OFFSET  OffsetOut;
} KSSTREAM_POINTER, *PKSSTREAM_POINTER;

Members

Context

A pointer to client-requested context information. The leading edge and trailing edge stream pointers have this member set to NULL. Cloned stream pointers can specify that they wish to have context information via the mechanism described in KsStreamPointerClone.

Pin

A pointer to the KSPIN structure to which this stream pointer belongs.

StreamHeader

A pointer to the stream header object for the data frame that this stream pointer currently points to. See KSSTREAM_HEADER for more information.

Offset

A pointer to a structure of type KSSTREAM_POINTER_OFFSET. Points to either OffsetIn or OffsetOut depending on whether the pin to which this stream pointer belongs is an input pin or output pin.

OffsetIn

This member specifies a structure of type KSSTREAM_POINTER_OFFSET describing the data currently pointed to by the stream pointer.

OffsetOut

This member specifies a structure of type KSSTREAM_POINTER_OFFSET. Use this member to output data on an output pin.

Remarks

A queue object for a stream has at minimum one hard-defined stream pointer: the leading-edge stream pointer. For more information, see Leading and Trailing Edge Stream Pointers.

For general information about stream pointers, see Stream Pointers.

Requirements

Requirement Value
Minimum supported client Available in Microsoft Windows XP and later operating systems and in Microsoft DirectX 8.0 and later versions.
Header ks.h (include Ks.h)

See also

KSSTREAM_HEADER

KSSTREAM_POINTER_OFFSET

KsStreamPointerAdvance

KsStreamPointerAdvanceOffsets

KsStreamPointerAdvanceOffsetsAndUnlock

KsStreamPointerClone

KsStreamPointerDelete

KsStreamPointerLock

KsStreamPointerUnlock