IMFPMediaPlayer::GetMediaItem method (mfplay.h)
[The feature associated with this page, MFPlay, is a legacy feature. It has been superseded by MediaPlayer and IMFMediaEngine. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer and IMFMediaEngine instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
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 |
|---|---|
|
The method succeeded. |
|
There is no current media item. |
|
There is no current media item. |
|
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 |