IEncoderAPI::GetParameterRange method (strmif.h)
[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]
[IEncoderAPI is no longer available for use. Instead, use ICodecAPI.]
The GetParameterRange method retrieves the valid range of values that the parameter supports, in cases where the parameter supports a stepped range as opposed to a list of specific values.
Syntax
HRESULT GetParameterRange(
[in] const GUID *Api,
[out] VARIANT *ValueMin,
[out] VARIANT *ValueMax,
[out] VARIANT *SteppingDelta
);
Parameters
[in] Api
Pointer to a GUID that specifies the parameter.
[out] ValueMin
Pointer to a VARIANT type that receives the minimum value of the parameter.
[out] ValueMax
Pointer to a VARIANT type that receives the maximum value of the parameter.
[out] SteppingDelta
Pointer to a VARIANT type that receives the stepping delta, which defines the valid increments from ValueMin to ValueMax.
Return value
This method can return one of these values.
| Return code | Description |
|---|---|
|
The method succeeded. |
|
The property supports a list of possible values, not a linear range. |
Remarks
The valid range for the parameter is [ValueMax...ValueMax], with increments of SteppingDelta. If a parameter supports a stepped range of values, it must use one of the following variant types:
- Unsigned types : VT_UI8, VT_UI4, VT_UI2, VT_UI1
- Signed types : VT_I8, VT_I4, VT_I2
- Float types : VT_R8, VT_R4
Any stepping value is valid. If the range has no stepping delta (that is, you can increment by any value), the encoder should return an empty value (VT_EMPTY) for SteppingDelta.
If Api equals ENCAPIPARAM_BITRATE_MODE, the method returns E_NOTIMPL, because the bitrate mode constants are a list of specific values.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | strmif.h (include Dshow.h) |
| Library | Strmiids.lib |