IMFPMediaPlayer::FrameStep method

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

Steps forward one video frame.

Syntax


HRESULT FrameStep();

Parameters

This method has no parameters.

Return value

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

Return codeDescription
S_OK

The method succeeded.

MF_E_INVALIDREQUEST

Cannot frame step. Reasons for this error code include:

  • There is no media item queued for playback.
  • The current media item does not contain video.
MF_E_SHUTDOWN

The object's Shutdown method was called.

MF_E_UNSUPPORTED_RATE

The media source does not support frame stepping, or the current playback rate is negative.

 

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_FRAME_STEP.

The player object does not support frame stepping during reverse playback (that is, while the playback rate is negative).

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Mfplay.h

See also

IMFPMediaPlayer
Using MFPlay for Audio/Video Playback

 

 

Show: