IMFPMediaPlayer::GetMediaItem method (mfplay.h)

Article
02/22/2024

Important Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.

Gets a pointer to the current media item.

Syntax

HRESULT GetMediaItem(
  [out] IMFPMediaItem **ppIMFPMediaItem
);

Parameters

[out] ppIMFPMediaItem

Receives a pointer to the media item's IMFPMediaItem interface. The caller must release the interface.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
E_FAIL	There is no current media item.
MF_E_NOT_FOUND	There is no current media item.
MF_E_SHUTDOWN	The object's Shutdown method was called.

Remarks

The IMFPMediaPlayer::SetMediaItem method is asynchronous. Therefore, while SetMediaItem is pending, GetMediaItem will not return the media item that was just set. Instead, the application should implement IMFPMediaPlayerCallback interface and handle the MFP_EVENT_TYPE_MEDIAITEM_SET event. For more information, see Receiving Events From the Player.

The previous remark also applies to setting the media item in the MFPCreateMediaPlayer function.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	mfplay.h