IMFPMediaPlayer::SetMediaItem 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.]

Queues a media item for playback.

Syntax

HRESULT SetMediaItem(
  [in] IMFPMediaItem *pIMFPMediaItem
);

Parameters

[in] pIMFPMediaItem

Pointer to the IMFPMediaItem interface of the media item.

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_INVALIDARG
Invalid argument.
MF_E_DRM_UNSUPPORTED
The media item contains protected content. MFPlay currently does not support protected content.
MF_E_NO_AUDIO_PLAYBACK_DEVICE
No audio playback device was found. This error can occur if the media source contains audio, but no audio playback devices are available on the system.
MF_E_SHUTDOWN
The object's Shutdown method was called.

Remarks

This method completes asynchronously. When the operation completes, the application's IMFPMediaPlayerCallback::OnMediaPlayerEvent callback method is invoked. The event type is MFP_EVENT_TYPE_MEDIAITEM_SET.

To create a media item, call IMFPMediaPlayer::CreateMediaItemFromObject or IMFPMediaPlayer::CreateMediaItemFromURL. A media item must be used with the same MFPlay player object that created that item. If the media item was created by a different instance of the player object, SetMediaItem returns E_INVALIDARG.

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

See also

IMFPMediaPlayer

Using MFPlay for Audio/Video Playback