IMFPMediaPlayer::GetState 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 the current playback state of the MFPlay player object.

Syntax

HRESULT GetState(
  [out] MFP_MEDIAPLAYER_STATE *peState
);

Parameters

[out] peState

Receives the playback state, as a member of the MFP_MEDIAPLAYER_STATE enumeration.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method can be called after the player object has been shut down.

Many of the IMFPMediaPlayer methods complete asynchronously. While an asynchronous operation is pending, the current state is not updated until the operation completes. When the operation completes, the application receives an event callback, and the new state is given in the MFP_EVENT_HEADER structure that is passed to the callback.

Requirements

See also

IMFPMediaPlayer

Using MFPlay for Audio/Video Playback