Expand Minimize

KsPinSubmitFrame function

If a pin has been placed into injection mode by a call to KsPinRegisterFrameReturnCallback, the KsPinSubmitFrame function submits a frame directly into the transport circuit.

Syntax


NTSTATUS KsPinSubmitFrame(
  _In_      PKSPIN Pin,
  _In_opt_  PVOID Data,
  _In_opt_  ULONG Size,
  _In_opt_  PKSSTREAM_HEADER StreamHeader,
  _In_opt_  PVOID Context
);

Parameters

Pin [in]

A pointer to the KSPIN structure on which to submit a frame.

Data [in, optional]

A pointer to a frame buffer. This should be NULL if and only if Size is equal to 0. Optional.

Size [in, optional]

The size in bytes of the frame buffer to which the Data field points. If the Data field is NULL, set this parameter to zero. Optional.

StreamHeader [in, optional]

A pointer to a KSSTREAM_HEADER structure. The stream header is copied if this parameter is supplied. Optional.

Context [in, optional]

A pointer to a caller-allocated buffer. AVStream provides this pointer to the frame return callback registered through a call to KsPinRegisterFrameReturnCallback. Optional.

Return value

Returns STATUS_SUCCESS if frame submission is successful. Otherwise returns an appropriate error code.

Requirements

Version

Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.

Header

Ks.h (include Ks.h)

Library

Ks.lib

IRQL

<=DISPATCH_LEVEL

See also

KsPinSubmitFrameMdl
KsPinRegisterFrameReturnCallback

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft