Edit

ICodecAPI::GetAllSettings method (icodecapi.h)

  • Article

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 10 Build 20348
Minimum supported server Windows 10 Build 20348
Header icodecapi.h

See also

Codec API Reference