IWMHeaderInfo3::AddCodecInfo 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 AddCodecInfo method adds codec information to a file. When you copy a compressed stream from one file to another, use this method to include the information about the encoding codec in the file header.

Syntax

HRESULT AddCodecInfo(
  [in] LPCWSTR_WMSDK_TYPE_SAFE pwszName,
  [in] LPCWSTR_WMSDK_TYPE_SAFE pwszDescription,
  [in] WMT_CODEC_INFO_TYPE     codecType,
  [in] WORD                    cbCodecInfo,
  [in] BYTE                    *pbCodecInfo
);

Parameters

[in] pwszName

Pointer to a wide-character null-terminated string containing the name.

[in] pwszDescription

Pointer to a wide-character null-terminated string containing the description.

[in] codecType

A value from the WMT_CODEC_INFO_TYPE enumeration specifying the codec type.

[in] cbCodecInfo

The size of the codec information, in bytes.

[in] pbCodecInfo

Pointer to an array of bytes that contains the codec information.

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.

Remarks

The parameters passed to this method should be obtained from the original file with a call to IWMHeaderInfo2::GetCodecInfo.

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)

Share via