IMFTransform::GetInputStatus method (mftransform.h)

Article
02/22/2024

Queries whether an input stream on this Media Foundation transform (MFT) can accept more data.

Syntax

HRESULT GetInputStatus(
  [in]  DWORD dwInputStreamID,
  [out] DWORD *pdwFlags
);

Parameters

[in] dwInputStreamID

Input stream identifier. To get the list of stream identifiers, call IMFTransform::GetStreamIDs.

[out] pdwFlags

Receives a member of the _MFT_INPUT_STATUS_FLAGS enumeration, or zero. If the value is MFT_INPUT_STATUS_ACCEPT_DATA, the stream specified in dwInputStreamID can accept more input data.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
MF_E_INVALIDSTREAMNUMBER	Invalid stream identifier.
MF_E_TRANSFORM_TYPE_NOT_SET	The media type is not set on one or more streams.

Remarks

If the method returns the MFT_INPUT_STATUS_ACCEPT_DATA flag, you can deliver an input sample to the specified stream by calling IMFTransform::ProcessInput. If the method succeeds but does not return any flags in the pdwFlags parameter, it means the input stream already has as much data as it can accept.

Use this method to test whether the input stream is ready to accept more data, without incurring the overhead of allocating a new sample and calling ProcessInput.

After the client has set valid media types on all of the streams, the MFT should always be in one of two states: Able to accept more input, or able to produce more output (or both).

If MFT_UNIQUE_METHOD_NAMES is defined before including mftransform.h, this method is renamed MFTGetInputStatus. See Creating Hybrid DMO/MFT Objects.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	mftransform.h
Library	Mfuuid.lib