Share via

IAMMediaTypeStream::SetFormat method (amstream.h)

  • Article

[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.
 
The SetFormat method sets the format of the stream.

Syntax

HRESULT SetFormat(
  [in] AM_MEDIA_TYPE *pMediaType,
  [in] DWORD         dwFlags
);

Parameters

[in] pMediaType

Pointer to an AM_MEDIA_TYPE structure that contains the stream format.

[in] dwFlags

Reserved.

Return value

Returns one of the following values.

Return code Description
MS_E_SAMPLEALLOC
 The stream has already allocated a sample with another media type.
S_OK
 Success.

Requirements

Requirement Value
Target Platform Windows
Header amstream.h

See also

IAMMediaTypeStream Interface