IMFVideoDisplayControl::GetCurrentImage method (evr.h)

[The component described on this page, Enhanced Video Renderer, is a legacy feature. It has been superseded by the Simple Video Renderer (SVR) exposed through the MediaPlayer and IMFMediaEngine components. To play video content you should send data into one of these components and allow them to instantiate the new video renderer. These components have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer or the lower level IMFMediaEngine APIs to play video media in Windows instead of the EVR, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Gets a copy of the current image being displayed by the video renderer.

Syntax

HRESULT GetCurrentImage(
  [in, out] BITMAPINFOHEADER *pBih,
  [out]     BYTE             **pDib,
  [out]     DWORD            *pcbDib,
  [in, out] LONGLONG         *pTimeStamp
);

Parameters

[in, out] pBih

Pointer to a BITMAPINFOHEADER structure that receives a description of the bitmap. Set the biSize member of the structure to sizeof(BITMAPINFOHEADER) before calling the method.

[out] pDib

Receives a pointer to a buffer that contains a packed Windows device-independent bitmap (DIB). The caller must free the memory for the bitmap by calling CoTaskMemFree.

[out] pcbDib

Receives the size of the buffer returned in pDib, in bytes.

[in, out] pTimeStamp

Receives the time stamp of the captured image.

Return value

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

Remarks

This method can be called at any time. However, calling the method too frequently degrades the video playback performance.

This method retrieves a copy of the final composited image, which includes any substreams, alpha-blended bitmap, aspect ratio correction, background color, and so forth.

In windowed mode, the bitmap is the size of the destination rectangle specified in IMFVideoDisplayControl::SetVideoPosition. In full-screen mode, the bitmap is the size of the display.

Requirements

See also

Enhanced Video Renderer

IMFVideoDisplayControl

Using the Video Display Controls