IltmmWMProfileManager::GetCodecFormatDesc
#include "ltmm.h"
|
C Syntax |
HRESULT IltmmWMProfileManager__getCodecFormatDesc(pProfMan, Type, CodecIndex, FormatIndex, pVal) |
|
C++ Syntax |
HRESULT GetCodecFormatDesc(Type, CodecIndex, FormatIndex, pVal) |
|
IltmmWMProfileManager *pProfMan; |
/* pointer to an interface */ |
|
BSTR Type; |
/* string */ |
|
long CodecIndex; |
/* index */ |
|
long FormatIndex; |
/* index */ |
|
BSTR *pVal; |
/* pointer to a string */ |
Gets the description of the specified codec A COmpressor Also known as an encoder, this is a module or algorithm to compress data. Playing that data back requires a decompressor, or decoder. combined with a DECompressor, or encoder Also known as compressor, this is a module or algorithm to compress data. Playing that data back requires a decompressor, or decoder. and a decoder Also known as a decompressor, this is a module or algorithm to decompress data., which allows you to both compress and decompress that same data. format.
|
Parameter |
Description |
|
pProfMan |
Pointer to an IltmmWMProfileManager interface. |
|
Type |
A string identifying the major media type the codec supports. Possible values are: |
|
|
Value |
|
|
ltmmMEDIATYPE_Video |
|
|
ltmmMEDIATYPE_Audio |
|
CodecIndex |
The zero based index of the codec for which to get the specified format description. |
|
FormatIndex |
The zero based index of the format for which to get the description. |
|
pVal |
Pointer to a string to be updated with the format description. |
Returns
|
S_OK |
The function was successful. |
|
<> S_OK |
An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation. |
Comments
Call SysFreeString to free the memory allocated for the string when it is no longer needed.
For more information, refer to the Microsoft documentation for IWMCodecInfo2::GetCodecFormatDesc at http://msdn.microsoft.com/library/default.asp?url=/library/en-us/wmform11/htm/iwmcodecinfo2getcodecformatdesc.asp.
Required DLLs and Libraries
|
LTMM For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
See Also
|
Elements: |
IltmmWMProfileManager::GetCodecInfoCount, IltmmWMProfileManager::GetCodecFormatCount, IltmmWMProfileManager::GetCodecFormat |
|
Topics: |
|
|
|
Example
For a C example, refer to IltmmWMProfile::AddStream Example for C.
For a C++ example, refer to IltmmWMProfile::AddStream Example for C++.