IMediaParams::GetParam method (medparam.h)

Article
4/26/2023

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The GetParam method retrieves the current value of the specified parameter. If the parameter is currently within an envelope segment, the returned value is the value on the most recently processed sample.

Syntax

HRESULT GetParam(
  [in]  DWORD   dwParamIndex,
  [out] MP_DATA *pValue
);

Parameters

[in] dwParamIndex

Zero-based index of the parameter.

[out] pValue

Pointer to a variable of type MP_DATA that receives the parameter value.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
E_INVALIDARG	Index out of range.
E_POINTER	NULL pointer argument.
S_OK	Success.

Remarks

To enumerate the parameters supported by this object, along with their index values, use the IMediaParamInfo interface.

Requirements

Requirement	Value
Target Platform	Windows
Header	medparam.h
Library	Dmoguids.lib

Share via