Edit

CMediaSample.SetMediaType method

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

The SetMediaType method sets the media type for the sample. This method implements the IMediaSample::SetMediaType method.

Syntax

HRESULT SetMediaType(
   AM_MEDIA_TYPE *pMediaType
);

Parameters

pMediaType

Pointer to an AM_MEDIA_TYPE structure.

Return value

Returns one of the HRESULT values shown in the following table.

Return code Description
S_OK
 Success
E_OUTOFMEMORY
 Insufficient memory

Remarks

This method sets the CMediaSample::m_pMediaType member variable, which specifies the media type, and the CMediaSample::m_dwFlags member variable, which specifies whether the media type has changed.

This method makes a copy of the AM_MEDIA_TYPE structure.

Requirements

Requirement Value
Header
Amfilter.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CMediaSample Class