IDirectDrawMediaStream::SetFormat method (ddstream.h)

Article
4/26/2023

[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.]

Note This interface is deprecated. New applications should not use it.

Sets the format of the current media stream.

Syntax

HRESULT SetFormat(
  [in] const DDSURFACEDESC *pDDSurfaceDesc,
  [in] IDirectDrawPalette  *pDirectDrawPalette
);

Parameters

[in] pDDSurfaceDesc

Pointer to a DirectDraw surface description that contains the new format.

[in] pDirectDrawPalette

Optional parameter that is a pointer to an IDirectDrawPalette interface.

Return value

Returns one of the following values.

Return code	Description
DDERR_INVALIDSURFACETYPE	The specified format is incompatible with the current stream.
MS_E_SAMPLEALLOC	Can't change the format because one or more stream samples are already allocated for this stream.
S_OK	Success.

Remarks

If the stream already has allocated samples and the sample format doesn't match the specified format, this method fails. This method always succeeds if the specified format matches the current format.

Requirements


Target Platform	Windows
Header	ddstream.h