The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ICodecAPI::GetAllSettings method

The GetAllSettings method gets the codec's current properties and writes them to a stream.

Syntax

C++


HRESULT GetAllSettings(
  [in] IStream *pStream
);

Parameters

pStream [in]: 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

Minimum supported client	Windows XP with SP2 [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2003 R2 [desktop apps \| Windows Store apps]
Header	Strmif.h (include Dshow.h)
Library	Strmiids.lib