IVMRSurfaceAllocatorNotify::AdviseSurfaceAllocator method (strmif.h)

Article
02/22/2024

[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 AdviseSurfaceAllocator method is called by an application to instruct the VMR to use a custom allocator-presenter.

Syntax

HRESULT AdviseSurfaceAllocator(
  [in] DWORD_PTR            dwUserID,
  [in] IVMRSurfaceAllocator *lpIVRMSurfaceAllocator
);

Parameters

[in] dwUserID

An application-defined DWORD_PTR that uniquely identifies this instance of the VMR in scenarios when multiple instances of the VMR are being used with a single instance of an allocator-presenter.

[in] lpIVRMSurfaceAllocator

Specifies the IVMRSurfaceAllocator interface on the new allocator-presenter. If this value is NULL, then the VMR will release the client allocator-presenter and restore its default allocator-presenter.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The method will cause the default allocator-presenter to be uninstalled and destroyed, and replaced with the specified new component. The new component must also support the IVMRImagePresenter interface.

This method can be called only once in the lifetime of the VMR. The VMR continues to use the allocator-presenter until the VMR is itself deleted. When the VMR is finally released, it releases its reference count on the custom allocator-presenter object, which allows that object to be freed.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP1 [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib