IAMVideoAccelerator::BeginFrame method (videoacc.h)

Article
4/26/2023

[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 BeginFrame method begins the processing to create a decoded picture.

Syntax

HRESULT BeginFrame(
  [in] const AMVABeginFrameInfo *amvaBeginFrameInfo
);

Parameters

[in] amvaBeginFrameInfo

Pointer to an AMVABeginFrameInfo structure that contains information needed to begin processing the frame.

Return value

Returns an HRESULT value that depends on the implementation of the interface. HRESULT can include one of the following standard constants, or other values not listed.

Return code	Description
E_FAIL	Failure.
E_INVALIDARG	Argument is invalid.
E_PENDING	The uncompressed surface is not yet available for use. For example, it is being read for display.
E_POINTER	NULL pointer argument.
S_OK	Success.
VFW_E_INVALIDSUBTYPE	The decoder did not use a DXVA decoding type when it connected to the video renderer.
VFW_E_NOT_CONNECTED	The pins on the decoder and video renderer filters are not connected.

Remarks

If the filter's pins are not connected, the method returns VFW_E_NOT_CONNECTED.

This method might block if no frame buffer is available.

For each call to BeginFrame, the decoder must make a corresponding call to IAMVideoAccelerator::EndFrame.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	videoacc.h
Library	Strmiids.lib

Share via