KsPinSubmitFrameMdl function (ks.h)

Article
02/22/2024

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

Syntax

KSDDKAPI NTSTATUS KsPinSubmitFrameMdl(
  [in]           PKSPIN           Pin,
  [in, optional] PMDL             Mdl,
  [in, optional] PKSSTREAM_HEADER StreamHeader,
  [in, optional] PVOID            Context
);

Parameters

[in] Pin

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

[in, optional] Mdl

A pointer to a memory descriptor list describing the frame buffer. 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 that is passed to the frame return callback registered through KsPinRegisterFrameReturnCallback. This parameter is optional and is solely for the caller's use.

Return value

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

Remarks

The difference between this function and KsPinSubmitFrame is that this function will submit a frame using an MDL structure rather than a data and size argument.

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