ICodecAPI::GetAllSettings method (strmif.h)

Article
02/22/2024

[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 GetAllSettings method gets the codec's current properties and writes them to a stream.

Syntax

HRESULT GetAllSettings(
  [in] IStream *__MIDL__ICodecAPI0000
);

Parameters

[in] __MIDL__ICodecAPI0000

Pointer to the IStream interface of the stream.

Return value

This method can return one of these values.

Return code	Description
S_OK	The method succeeded.
E_NOTIMPL	Not implemented.

Remarks

Codecs that implement ICodecAPI are not required to support this method.

To load the properties from the stream back onto the codec, call ICodecAPI::SetAllSettings or ICodecAPI::SetAllSettingsWithNotify.

The format of the data that is written to the stream depends on the implementation of the codec. There is no standard serialization format. An application should not attempt to save the properties from one codec and load them on a different codec.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2003 R2 [desktop apps \| UWP apps]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib