Edit

Share via

ICodecAPI::GetParameterValues method (icodecapi.h)

  • Article

The GetParameterValues method gets the list of possible values for a codec property.

This method applies only to properties that support a list of possible values, as opposed to a linear range.

Syntax

HRESULT GetParameterValues(
  [in]  const GUID *Api,
  [out] VARIANT    **Values,
  [out] ULONG      *ValuesCount
);

Parameters

[in] Api

Pointer to a GUID that specifies the property to query. For a list of standard codec properties, see Codec API Properties.

[out] Values

Receives a pointer to an array of VARIANT types. The array contains the list of values that the encoder supports for this property. The caller must free each VARIANT by calling VariantClear. The caller must also free the array by calling CoTaskMemFree.

[out] ValuesCount

Receives the number of elements in the Values array.

Return value

This method can return one of these values.

Return code Description
S_OK
 The method succeeded.
E_INVALIDARG
 Invalid argument.
VFW_E_CODECAPI_LINEAR_RANGE
 The property supports a range of values, not a list.

Remarks

If the property supports a range of values, instead of a list, the method returns VFW_E_CODECAPI_LINEAR_RANGE. In that case, call ICodecAPI::GetParameterRange to get the range of values.

Requirements

Requirement Value
Minimum supported client Windows 10 Build 20348
Minimum supported server Windows 10 Build 20348
Header icodecapi.h

See also

Codec API Reference

Encoder API

ICodecAPI