IWMCodecInfo3::GetCodecEnumerationSetting method (wmsdkidl.h)
[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 GetCodecEnumerationSetting method retrieves the current value for one codec enumeration setting. Codec enumeration settings dictate the codec formats that can be enumerated by the methods of IWMCodecInfo. You can change codec enumeration settings in order to retrieve codec formats supporting specific features by calling IWMCodecInfo3::SetCodecEnumerationSetting.
Syntax
HRESULT GetCodecEnumerationSetting(
[in] REFGUID guidType,
[in] DWORD dwCodecIndex,
[in] LPCWSTR pszName,
[out] WMT_ATTR_DATATYPE *pType,
[out] BYTE *pValue,
[in, out] DWORD *pdwSize
);
Parameters
[in] guidType
GUID identifying the major type of digital media. This must be one of the following constants.
| Constant | Description |
|---|---|
| WMMEDIATYPE_Video | Specifies a video codec. |
| WMMEDIATYPE_Audio | Specifies an audio codec. |
[in] dwCodecIndex
DWORD containing the codec index ranging from zero to one less than the number of supported codecs of the type specified by guidType. To retrieve the number of individual codecs supporting a major type, use the IWMCodecInfo::GetCodecInfoCount method.
[in] pszName
Pointer to a wide-character null-terminated string containing the name of the enumeration setting. Use one of the following constants.
| Constant | Description |
|---|---|
| g_wszVBREnabled | Use to enumerate the supported codec formats that use variable bit rate (VBR) encoding.The value returned in pValue is a BOOL. |
| g_wszNumPasses | Use to enumerate the supported codec formats that use a number of passes equal to the value in pValue.The value returned in pValue is a DWORD specifying the number of passes. |
[out] pType
Pointer to a WMT_ATTR_DATATYPE enumeration value specifying the data type of the value returned in pValue.
[out] pValue
Pointer to a BYTE array containing the codec enumeration data. The data type and meaning of the data returned in this array depends on the setting specified by pszName. You can set this value to NULL to retrieve the required size of the array in pdwSize.
[in, out] pdwSize
Pointer to a DWORD containing the size of the setting value in bytes. If you set pValue to NULL, this value will be set to the size required to hold the setting value.
Return value
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
| Return code | Description |
|---|---|
|
The method succeeded. |
|
The enumeration setting specified is not valid for the codec. |
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) |