IWMWriterPreprocess::GetMaxPreprocessingPasses method (wmsdkidl.h)

Article
4/26/2023

[The feature associated with this page, Windows Media Format 11 SDK, is a legacy feature. It has been superseded by Source Reader and Sink Writer. Source Reader and Sink Writer have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Source Reader and Sink Writer instead of Windows Media Format 11 SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The GetMaxPreprocessingPasses method retrieves the maximum number of preprocessing passes for a specified input stream.

Syntax

HRESULT GetMaxPreprocessingPasses(
  [in]  DWORD dwInputNum,
  [in]  DWORD dwFlags,
  [out] DWORD *pdwMaxNumPasses
);

Parameters

[in] dwInputNum

DWORD containing the input number for which you want to get the maximum number of preprocessing passes.

[in] dwFlags

Reserved. Set to zero.

[out] pdwMaxNumPasses

Pointer to a DWORD that will receive the maximum number of preprocessing passes. If the codec supports two-pass encoding, this value is 1, as the final pass is not counted.

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.
E_POINTER	pdwMaxNumPasses is NULL.
E_INVALIDARG	dwInputNum specifies an invalid input stream number.
NS_E_INVALID_REQUEST	The writer is not running.

Remarks

If no preprocessing is supported for the specified input, pdwMaxNumPasses contains zero upon return.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only],Windows Media Format 9 Series SDK, or later versions of the SDK
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wmsdkidl.h (include Wmsdk.h)
Library	Wmvcore.lib; WMStubDRM.lib (if you use DRM)

Share via