IWMWriter::GetInputProps 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 GetInputProps method retrieves the current media properties of a specified input stream.

Syntax

HRESULT GetInputProps(
  [in]  DWORD              dwInputNum,
  [out] IWMInputMediaProps **ppInput
);

Parameters

[in] dwInputNum

DWORD containing the input index number.

[out] ppInput

Pointer to a pointer to an IWMInputMediaProps object.

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_INVALIDARG	The dwInputNum value is greater than the highest index number.

Remarks

The range of indexes to use for the dwInputNum parameter can be found by calling GetInputCount.

Manipulating the IWMInputMediaProps object has no effect on the writer, unless the application calls the SetInputProps method to configure the input.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only],Windows Media Format 7 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