KsPinSubmitFrame function (ks.h)

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

KSDDKAPI NTSTATUS KsPinSubmitFrame(
  [in]           PKSPIN           Pin,
  [in, optional] PVOID            Data,
  [in, optional] ULONG            Size,
  [in, optional] PKSSTREAM_HEADER StreamHeader,
  [in, optional] PVOID            Context
);

Parameters

[in] Pin

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

[in, optional] Data

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

[in, optional] Size

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.

[in, optional] StreamHeader

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

[in, optional] Context

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

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

See also

KsPinRegisterFrameReturnCallback

KsPinSubmitFrameMdl