IMediaSample::GetMediaType method

The GetMediaType method retrieves the media type, if the media type differs from the previous sample.

Syntax


HRESULT GetMediaType(
   AM_MEDIA_TYPE **ppMediaType
);

Parameters

ppMediaType

Address of a variable that receives a pointer to an AM_MEDIA_TYPE structure. If the media type has not changed from the previous sample, *ppMediaType is set to NULL.

Return value

Returns an HRESULT value. Possible values include those shown in the following table.

Return codeDescription
S_FALSE

The media type has not changed from the previous sample.

S_OK

Success.

E_OUTOFMEMORY

Insufficient memory.

 

Remarks

This method enables a filter to make limited changes to the media type, such as changing the palette. To make a significant change to the media type, the pins might need to reconnect and renegotiate the media type.

If the method returns S_OK, the caller must free the memory for the media type, including the format block. You can use the DeleteMediaType function in the DirectShow base class library.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

Error and Success Codes
IMediaSample Interface

 

 

Show: