Skip to content

Latest commit

 

History

History
124 lines (100 loc) · 4.59 KB

nf-strmif-ivideoframestep-step.md

File metadata and controls

124 lines (100 loc) · 4.59 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:strmif.IVideoFrameStep.Step
IVideoFrameStep::Step (strmif.h)
The Step method causes the filter graph to step forward by the specified number of frames.
IVideoFrameStep interface [DirectShow]
Step method
IVideoFrameStep.Step
IVideoFrameStep::Step
IVideoFrameStepStep
Step
Step method [DirectShow]
Step method [DirectShow]
IVideoFrameStep interface
dshow.ivideoframestep_step
strmif/IVideoFrameStep::Step
dshow\ivideoframestep_step.htm
dshow
1366b8b4-ea7a-4528-8a5a-03a3de265d89
4/26/2023
IVideoFrameStep interface [DirectShow],Step method, IVideoFrameStep.Step, IVideoFrameStep::Step, IVideoFrameStepStep, Step, Step method [DirectShow], Step method [DirectShow],IVideoFrameStep interface, dshow.ivideoframestep_step, strmif/IVideoFrameStep::Step
strmif.h
Dshow.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Strmiids.lib
Windows
19H1
IVideoFrameStep::Step
strmif/IVideoFrameStep::Step
c++
APIRef
kbSyntax
COM
Strmiids.lib
Strmiids.dll
IVideoFrameStep.Step

IVideoFrameStep::Step

-description

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The Step method causes the filter graph to step forward by the specified number of frames.

-parameters

-param dwFrames

Specifies the number of frames to skip. If dwFrames is 1, the graph steps forward one frame. If dwFrames is a number n greater than 1, the graph skips n - 1 frames and shows the nth frame.

-param pStepObject

Pointer to an interface on the filter that will control the stepping operation, or NULL. Specify NULL to perform the frame stepping using the renderer filter in the graph. If non-NULL, the object must implement the IKsPropertySet interface and support the AM_KSPROPSETID_FrameStep property. (For more information, see Frame Stepping Property Set.) If the graph includes a custom filter that implements the frame stepping, pStepObject can specify a pointer to that filter.

-returns

Returns an HRESULT. Possible values include the following.

Return code Description
S_OK
Success.
VFW_E_FRAME_STEP_UNSUPPORTED
Frame stepping is not supported.
E_INVALIDARG
The pStepObject parameter is invalid.

-remarks

When the step operation is complete, this method sends an EC_STEP_COMPLETE event notification to the filter graph manager, which will pass it to the application's event loop and set the filter graph to a paused state.

The frames step in real time, which means that if the movie is playing at 30 frames per second, calling IVideoFrameStep::Step with dwFrames set to 60 would take 2 seconds to execute. All methods in this interface are asynchronous, so control returns to the application immediately.

-see-also

Error and Success Codes

IVideoFrameStep Interface