Skip to content

Latest commit

 

History

History
118 lines (99 loc) · 4.83 KB

nn-strmif-icodecapi.md

File metadata and controls

118 lines (99 loc) · 4.83 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NN:strmif.ICodecAPI
ICodecAPI (strmif.h)
The ICodecAPI interface (strmif.h) sets and retrieves settings on an encoder or decoder filter.
ICodecAPI
ICodecAPI interface [DirectShow]
ICodecAPI interface [DirectShow]
described
ICodecAPIInterface
dshow.icodecapi
strmif/ICodecAPI
dshow\icodecapi.htm
dshow
cc3f1bd9-1d36-45e6-94e2-07f2800fd073
4/26/2023
ICodecAPI, ICodecAPI interface [DirectShow], ICodecAPI interface [DirectShow],described, ICodecAPIInterface, dshow.icodecapi, strmif/ICodecAPI
strmif.h
Dshow.h
Windows
Windows XP with SP2 [desktop apps \| UWP apps]
Windows Server 2003 R2 [desktop apps \| UWP apps]
Strmiids.lib
Windows
19H1
ICodecAPI
strmif/ICodecAPI
c++
APIRef
kbSyntax
COM
Strmiids.lib
Strmiids.dll
ICodecAPI

ICodecAPI interface

-description

[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 ICodecAPI interface sets and retrieves settings on an encoder or decoder filter.

Note

APIs declared in strmif.h are not supported for Universal Windows Platform (UWP) apps. To use ICodecAPI in a UWP app, use the version declared in icodecapi.h.

-inheritance

The ICodecAPI interface inherits from the IUnknown interface. ICodecAPI also has these types of members:

-remarks

This interface defines a generic mechanism for setting properties on a codec (encoder or decoder). A codec property is a key/value pair, where the key is a GUID and the value is a VARIANT. The interpretation of the VARIANT data depends on the property GUID. For a list of codec property GUIDs, see Codec API Properties.

Codec Profiles

Codecs can optionally store profile and capability information in the system registry. This information enables applications to query the device during device enumeration. Default profiles are stored in the following registry key:
HKEY_LOCAL_MACHINE
   Software
      Classes
         CLSID
            Category
               Profiles
Each profile is a registry key whose default string is a text description of the profile. Each value has a GUID name, followed by a string value containing the numeric GUID value. For example:
C++ 
  HLKM\Software\Classes\CLSID\<category>\Profiles\DVD
    default "HQ DVD"
    REG_SZ {...} = "0"
    REG_SZ {...} = "1234"
where {...} is a property GUID that the application can map into its user interface. Microsoft is currently considering the definition of a set of standard profiles.

Default codec capabilities are stored under HLKM\Software\Classes\CLSID&lt;category>\Instance&lt;Filter CLSID>\Capabilities. Each value has a GUID name, followed by a string value containing the numeric GUID value. For example:

C++ 
HLKM\Software\Classes\CLSID\<category>\Instance\<My DVD encoder>\Capabilities
     default "My DVD encoder"
     REG_SZ_MULTI {...}
where {...} is a property GUID that the application can map into its user interface.

-see-also

Decoder Settings for Windows Media Center Edition

Encoder API