PFNKSPINFRAMERETURN callback function (ks.h)

Article
08/19/2022

An AVStream minidriver's AVStrMiniFrameReturn routine is called when an injected frame has completed its trip around the circuit and is ready to be recycled or freed.

Syntax

PFNKSPINFRAMERETURN Pfnkspinframereturn;

void Pfnkspinframereturn(
  [in]           PKSPIN Pin,
  [in, optional] PVOID Data,
  [in, optional] ULONG Size,
  [in, optional] PMDL Mdl,
  [in, optional] PVOID Context,
  [in]           NTSTATUS Status
)
{...}

Parameters

[in] Pin

Pointer to a KSPIN structure representing the pin on which the frame was injected.

[in, optional] Data

Pointer to the buffer originally specified in the call to KsPinSubmitFrame.

[in, optional] Size

Specifies the size in bytes ofData as originally specified in KsPinSubmitFrame.

[in, optional] Mdl

Pointer to a memory descriptor list describing the injected frame as in the call to KsPinSubmitFrameMdl.

[in, optional] Context

Pointer to the minidriver-supplied context buffer attached to the frame when the frame was injected into the circuit.

[in] Status

Contains a copy ofIrp->IoStatus.Status for the IRP to which the requested frame was attached.

Return value

None

Remarks

The minidriver specifies this routine's address in theFrameReturn parameter of a call to KsPinRegisterFrameReturnCallback.

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	Desktop
Header	ks.h (include Ks.h)