IAMNetShowExProps::GetCodecDescription method (qnetwork.h)
[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 GetCodecDescription method retrieves a user-friendly description of a specified codec.
Syntax
HRESULT GetCodecDescription(
long CodecNum,
BSTR *pbstrCodecDescription
);
Parameters
CodecNum
Specifies the codec to query, indexed from zero. Call get_CodecCount to obtain the number of codecs.
pbstrCodecDescription
Pointer to a variable that receives the description.
Return value
If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.
Remarks
The caller must release the returned BSTR, by calling SysFreeString.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | qnetwork.h |